GetImportFileTask - Migration Hub Strategy Recommendations

GetImportFileTask

Retrieves the details about a specific import task.

Request Syntax

GET /get-import-file-task/id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

id

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

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*\S.*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "completionTime": number, "id": "string", "importName": "string", "inputS3Bucket": "string", "inputS3Key": "string", "numberOfRecordsFailed": number, "numberOfRecordsSuccess": number, "startTime": number, "status": "string", "statusReportS3Bucket": "string", "statusReportS3Key": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

completionTime

The time that the import task completed.

Type: Timestamp

id

The import file task id returned in the response of StartImportFileTask.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*\S.*

importName

The name of the import task given in StartImportFileTask.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*\S.*

inputS3Bucket

The S3 bucket where import file is located.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 63.

Pattern: [0-9a-z]+[0-9a-z\.\-]*[0-9a-z]+

inputS3Key

The Amazon S3 key name of the import file.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*\S.*

numberOfRecordsFailed

The number of records that failed to be imported.

Type: Integer

numberOfRecordsSuccess

The number of records successfully imported.

Type: Integer

startTime

Start time of the import task.

Type: Timestamp

status

Status of import file task.

Type: String

Valid Values: ImportInProgress | ImportFailed | ImportPartialSuccess | ImportSuccess | DeleteInProgress | DeleteFailed | DeletePartialSuccess | DeleteSuccess

statusReportS3Bucket

The S3 bucket name for status report of import task.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 63.

Pattern: [0-9a-z]+[0-9a-z\.\-]*[0-9a-z]+

statusReportS3Key

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*\S.*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The AWS user account does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this account.

HTTP Status Code: 403

InternalServerException

The server experienced an internal error. Try again.

HTTP Status Code: 500

ResourceNotFoundException

The specified ID in the request is not found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request body isn't valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: