mgn / Client / start_export

start_export

mgn.Client.start_export(**kwargs)

Start export.

See also: AWS API Documentation

Request Syntax

response = client.start_export(
    s3Bucket='string',
    s3Key='string',
    s3BucketOwner='string',
    tags={
        'string': 'string'
    }
)

Parameters:

• s3Bucket (string) –

  [REQUIRED]

  Start export request s3 bucket.

• s3Key (string) –

  [REQUIRED]

  Start export request s3key.

• s3BucketOwner (string) – Start export request s3 bucket owner.

• tags (dict) –

  Start import request tags.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'exportTask': {
        'exportID': 'string',
        'arn': 'string',
        's3Bucket': 'string',
        's3Key': 'string',
        's3BucketOwner': 'string',
        'creationDateTime': 'string',
        'endDateTime': 'string',
        'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED',
        'progressPercentage': ...,
        'summary': {
            'serversCount': 123,
            'applicationsCount': 123,
            'wavesCount': 123
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) –

  Start export response.

  • exportTask (dict) –

    Start export response export task.

    • exportID (string) –

      Export task id.

    • arn (string) –

      ExportTask arn.

    • s3Bucket (string) –

      Export task s3 bucket.

    • s3Key (string) –

      Export task s3 key.

    • s3BucketOwner (string) –

      Export task s3 bucket owner.

    • creationDateTime (string) –

      Export task creation datetime.

    • endDateTime (string) –

      Export task end datetime.

    • status (string) –

      Export task status.

    • progressPercentage (float) –

      Export task progress percentage.

    • summary (dict) –

      Export task summary.

      • serversCount (integer) –

        Export task summary servers count.

      • applicationsCount (integer) –

        Export task summary applications count.

      • wavesCount (integer) –

        Export task summary waves count.

    • tags (dict) –

      Export task tags.

      • (string) –

        • (string) –

Exceptions

• mgn.Client.exceptions.UninitializedAccountException

• mgn.Client.exceptions.ValidationException

• mgn.Client.exceptions.ServiceQuotaExceededException