GetImportJob
Provides information about an import job.
Request Syntax
GET /v2/email/import-jobs/JobId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- JobId
-
The ID of the import job.
Length Constraints: Minimum length of 1.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"CompletedTimestamp": number,
"CreatedTimestamp": number,
"FailedRecordsCount": number,
"FailureInfo": {
"ErrorMessage": "string",
"FailedRecordsS3Url": "string"
},
"ImportDataSource": {
"DataFormat": "string",
"S3Url": "string"
},
"ImportDestination": {
"ContactListDestination": {
"ContactListImportAction": "string",
"ContactListName": "string"
},
"SuppressionListDestination": {
"SuppressionListImportAction": "string"
}
},
"JobId": "string",
"JobStatus": "string",
"ProcessedRecordsCount": number
}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.
- CompletedTimestamp
-
The time stamp of when the import job was completed.
Type: Timestamp
- CreatedTimestamp
-
The time stamp of when the import job was created.
Type: Timestamp
- FailedRecordsCount
-
The number of records that failed processing because of invalid input or other reasons.
Type: Integer
- FailureInfo
-
The failure details about an import job.
Type: FailureInfo object
- ImportDataSource
-
The data source of the import job.
Type: ImportDataSource object
- ImportDestination
-
The destination of the import job.
Type: ImportDestination object
- JobId
-
A string that represents the import job ID.
Type: String
Length Constraints: Minimum length of 1.
- JobStatus
-
The status of the import job.
Type: String
Valid Values:
CREATED | PROCESSING | COMPLETED | FAILED | CANCELLED - ProcessedRecordsCount
-
The current number of records processed.
Type: Integer
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The input you provided is invalid.
HTTP Status Code: 400
- NotFoundException
-
The resource you attempted to access doesn't exist.
HTTP Status Code: 404
- TooManyRequestsException
-
Too many requests have been made to the operation.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
