mgn / Client / start_import

start_import#

mgn.Client.start_import(**kwargs)#

Start import.

See also: AWS API Documentation

Request Syntax

response = client.start_import(
    clientToken='string',
    s3BucketSource={
        's3Bucket': 'string',
        's3BucketOwner': 'string',
        's3Key': 'string'
    }
)
Parameters:

  • clientToken (string) –

    Start import request client token.

    This field is autopopulated if not provided.

  • s3BucketSource (dict) –

    [REQUIRED]

    Start import request s3 bucket source.

    • s3Bucket (string) – [REQUIRED]

      S3 bucket source s3 bucket.

    • s3BucketOwner (string) –

      S3 bucket source s3 bucket owner.

    • s3Key (string) – [REQUIRED]

      S3 bucket source s3 key.

Return type:

dict

Returns:

Response Syntax

{
    'importTask': {
        'creationDateTime': 'string',
        'endDateTime': 'string',
        'importID': 'string',
        'progressPercentage': ...,
        's3BucketSource': {
            's3Bucket': 'string',
            's3BucketOwner': 'string',
            's3Key': 'string'
        },
        'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED',
        'summary': {
            'applications': {
                'createdCount': 123,
                'modifiedCount': 123
            },
            'servers': {
                'createdCount': 123,
                'modifiedCount': 123
            },
            'waves': {
                'createdCount': 123,
                'modifiedCount': 123
            }
        }
    }
}

Response Structure

  • (dict) –

    Start import response.

    • importTask (dict) –

      Start import response import task.

      • creationDateTime (string) –

        Import task creation datetime.

      • endDateTime (string) –

        Import task end datetime.

      • importID (string) –

        Import task id.

      • progressPercentage (float) –

        Import task progress percentage.

      • s3BucketSource (dict) –

        Import task s3 bucket source.

        • s3Bucket (string) –

          S3 bucket source s3 bucket.

        • s3BucketOwner (string) –

          S3 bucket source s3 bucket owner.

        • s3Key (string) –

          S3 bucket source s3 key.

      • status (string) –

        Import task status.

      • summary (dict) –

        Import task summary.

        • applications (dict) –

          Import task summary applications.

          • createdCount (integer) –

            Import task summary applications created count.

          • modifiedCount (integer) –

            Import task summary applications modified count.

        • servers (dict) –

          Import task summary servers.

          • createdCount (integer) –

            Import task summary servers created count.

          • modifiedCount (integer) –

            Import task summary servers modified count.

        • waves (dict) –

          Import task summary waves.

          • createdCount (integer) –

            Import task summery waves created count.

          • modifiedCount (integer) –

            Import task summery waves modified count.

Exceptions