mgn / Paginator / ListImports

ListImports¶

class mgn.Paginator.ListImports¶

paginator = client.get_paginator('list_imports')

paginate(**kwargs)¶

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

Request Syntax

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

Parameters:

filters (dict) –
List imports request filters.
- importIDs (list) –
  
  List imports request filters import 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',
            '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
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

List import response.
- items (list) –
  
  List import response items.
  - (dict) –
    
    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.
- NextToken (string) –
  
  A token to resume pagination.