mgn / Client / list_exports

list_exports#

mgn.Client.list_exports(**kwargs)#

List exports.

See also: AWS API Documentation

Request Syntax

response = client.list_exports(
    filters={
        'exportIDs': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string'
)
Parameters:

  • filters (dict) –

    List exports request filters.

    • exportIDs (list) –

      List exports request filters export ids.

      • (string) –

  • maxResults (integer) – List export request max results.

  • nextToken (string) – List export request next token.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            '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
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    List export response.

    • items (list) –

      List export response items.

      • (dict) –

        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.

    • nextToken (string) –

      List export response next token.

Exceptions