MigrationHubStrategyRecommendations / Client / get_import_file_task

get_import_file_task#

MigrationHubStrategyRecommendations.Client.get_import_file_task(**kwargs)#

Retrieves the details about a specific import task.

Request Syntax

response = client.get_import_file_task(
    id='string'
)

Parameters:

id (string) –

[REQUIRED]

The ID of the import file task. This ID is returned in the response of StartImportFileTask.

Return type:

dict

Returns:

Response Syntax

{
    'completionTime': datetime(2015, 1, 1),
    'id': 'string',
    'importName': 'string',
    'inputS3Bucket': 'string',
    'inputS3Key': 'string',
    'numberOfRecordsFailed': 123,
    'numberOfRecordsSuccess': 123,
    'startTime': datetime(2015, 1, 1),
    'status': 'ImportInProgress'|'ImportFailed'|'ImportPartialSuccess'|'ImportSuccess'|'DeleteInProgress'|'DeleteFailed'|'DeletePartialSuccess'|'DeleteSuccess',
    'statusReportS3Bucket': 'string',
    'statusReportS3Key': 'string'
}

Response Structure

(dict) –
- completionTime (datetime) –
  
  The time that the import task completed.
- id (string) –
  
  The import file task id returned in the response of StartImportFileTask.
- importName (string) –
  
  The name of the import task given in StartImportFileTask.
- inputS3Bucket (string) –
  
  The S3 bucket where import file is located.
- inputS3Key (string) –
  
  The Amazon S3 key name of the import file.
- numberOfRecordsFailed (integer) –
  
  The number of records that failed to be imported.
- numberOfRecordsSuccess (integer) –
  
  The number of records successfully imported.
- startTime (datetime) –
  
  Start time of the import task.
- status (string) –
  
  Status of import file task.
- statusReportS3Bucket (string) –
  
  The S3 bucket name for status report of import task.
- statusReportS3Key (string) –
  
  The Amazon S3 key name for status report of import task. The report contains details about whether each record imported successfully or why it did not.

Exceptions

MigrationHubStrategyRecommendations.Client.exceptions.ResourceNotFoundException
MigrationHubStrategyRecommendations.Client.exceptions.AccessDeniedException
MigrationHubStrategyRecommendations.Client.exceptions.ThrottlingException
MigrationHubStrategyRecommendations.Client.exceptions.ValidationException
MigrationHubStrategyRecommendations.Client.exceptions.InternalServerException