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',
    s3BucketOwner='string',
    s3Key='string'
)
Parameters:

  • s3Bucket (string) –

    [REQUIRED]

    Start export request s3 bucket.

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

  • s3Key (string) –

    [REQUIRED]

    Start export request s3key.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    Start export response.

    • exportTask (dict) –

      Start export response export task.

      • creationDateTime (string) –

        Export task creation datetime.

      • endDateTime (string) –

        Export task end datetime.

      • exportID (string) –

        Export task id.

      • progressPercentage (float) –

        Export task progress percentage.

      • s3Bucket (string) –

        Export task s3 bucket.

      • s3BucketOwner (string) –

        Export task s3 bucket owner.

      • s3Key (string) –

        Export task s3 key.

      • status (string) –

        Export task status.

      • summary (dict) –

        Export task summary.

        • applicationsCount (integer) –

          Export task summary applications count.

        • serversCount (integer) –

          Export task summary servers count.

        • wavesCount (integer) –

          Export task summary waves count.

Exceptions