ApplicationDiscoveryService / Client / describe_import_tasks

describe_import_tasks#

ApplicationDiscoveryService.Client.describe_import_tasks(**kwargs)#

Returns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.

Request Syntax

response = client.describe_import_tasks(
    filters=[
        {
            'name': 'IMPORT_TASK_ID'|'STATUS'|'NAME',
            'values': [
                'string',
            ]
        },
    ],
    maxResults=123,
    nextToken='string'
)

Parameters:

filters (list) –
An array of name-value pairs that you provide to filter the results for the DescribeImportTask request to a specific subset of results. Currently, wildcard values aren’t supported for filters.
- (dict) –
  
  A name-values pair of elements you can use to filter the results when querying your import tasks. Currently, wildcards are not supported for filters.
  
  Note
  When filtering by import status, all other filter values are ignored.
  - name (string) –
    
    The name, status, or import task ID for a specific import task.
  - values (list) –
    
    An array of strings that you can provide to match against a specific name, status, or import task ID to filter the results for your import task queries.
    - (string) –
maxResults (integer) – The maximum number of results that you want this request to return, up to 100.
nextToken (string) – The token to request a specific page of results.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'tasks': [
        {
            'importTaskId': 'string',
            'clientRequestToken': 'string',
            'name': 'string',
            'importUrl': 'string',
            'status': 'IMPORT_IN_PROGRESS'|'IMPORT_COMPLETE'|'IMPORT_COMPLETE_WITH_ERRORS'|'IMPORT_FAILED'|'IMPORT_FAILED_SERVER_LIMIT_EXCEEDED'|'IMPORT_FAILED_RECORD_LIMIT_EXCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED'|'DELETE_FAILED_LIMIT_EXCEEDED'|'INTERNAL_ERROR',
            'importRequestTime': datetime(2015, 1, 1),
            'importCompletionTime': datetime(2015, 1, 1),
            'importDeletedTime': datetime(2015, 1, 1),
            'serverImportSuccess': 123,
            'serverImportFailure': 123,
            'applicationImportSuccess': 123,
            'applicationImportFailure': 123,
            'errorsAndFailedEntriesZip': 'string'
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  The token to request the next page of results.
- tasks (list) –
  
  A returned array of import tasks that match any applied filters, up to the specified number of maximum results.
  - (dict) –
    
    An array of information related to the import task request that includes status information, times, IDs, the Amazon S3 Object URL for the import file, and more.
    - importTaskId (string) –
      
      The unique ID for a specific import task. These IDs aren’t globally unique, but they are unique within an Amazon Web Services account.
    - clientRequestToken (string) –
      
      A unique token used to prevent the same import request from occurring more than once. If you didn’t provide a token, a token was automatically generated when the import task request was sent.
    - name (string) –
      
      A descriptive name for an import task. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.
    - importUrl (string) –
      
      The URL for your import file that you’ve uploaded to Amazon S3.
    - status (string) –
      
      The status of the import task. An import can have the status of IMPORT_COMPLETE and still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in the errorsAndFailedEntriesZip field, or in the Migration Hub management console.
    - importRequestTime (datetime) –
      
      The time that the import task request was made, presented in the Unix time stamp format.
    - importCompletionTime (datetime) –
      
      The time that the import task request finished, presented in the Unix time stamp format.
    - importDeletedTime (datetime) –
      
      The time that the import task request was deleted, presented in the Unix time stamp format.
    - serverImportSuccess (integer) –
      
      The total number of server records in the import file that were successfully imported.
    - serverImportFailure (integer) –
      
      The total number of server records in the import file that failed to be imported.
    - applicationImportSuccess (integer) –
      
      The total number of application records in the import file that were successfully imported.
    - applicationImportFailure (integer) –
      
      The total number of application records in the import file that failed to be imported.
    - errorsAndFailedEntriesZip (string) –
      
      A link to a compressed archive folder (in the ZIP format) that contains an error log and a file of failed records. You can use these two files to quickly identify records that failed, why they failed, and correct those records. Afterward, you can upload the corrected file to your Amazon S3 bucket and create another import task request.
      
      This field also includes authorization information so you can confirm the authenticity of the compressed archive before you download it.
      
      If some records failed to be imported we recommend that you correct the records in the failed entries file and then imports that failed entries file. This prevents you from having to correct and update the larger original file and attempt importing it again.

Exceptions

ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorException
ApplicationDiscoveryService.Client.exceptions.InvalidParameterException
ApplicationDiscoveryService.Client.exceptions.InvalidParameterValueException
ApplicationDiscoveryService.Client.exceptions.ServerInternalErrorException
ApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetException