mgn / Paginator / ListExports

ListExports#

class mgn.Paginator.ListExports#

paginator = client.get_paginator('list_exports')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from mgn.Client.list_exports().

Request Syntax

response_iterator = paginator.paginate(
    filters={
        'exportIDs': [
            'string',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

filters (dict) –
List exports request filters.
- exportIDs (list) –
  
  List exports request filters export ids.
  - (string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

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) –
  
  A token to resume pagination.