mgn / Client / list_imports

list_imports#

mgn.Client.list_imports(**kwargs)#

List imports.

Request Syntax

response = client.list_imports(
    filters={
        'importIDs': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string'
)

Parameters:

filters (dict) –
List imports request filters.
- importIDs (list) –
  
  List imports request filters import IDs.
  - (string) –
maxResults (integer) – List imports request max results.
nextToken (string) – List imports request next token.

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) –
  
  List import response next token.

Exceptions

mgn.Client.exceptions.UninitializedAccountException
mgn.Client.exceptions.ValidationException