GetAddressListImportJob
Fetch attributes of an import job.
Request Syntax
{
"JobId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- JobId
-
The identifier of the import job that needs to be retrieved.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9-]+$Required: Yes
Response Syntax
{
"AddressListId": "string",
"CompletedTimestamp": number,
"CreatedTimestamp": number,
"Error": "string",
"FailedItemsCount": number,
"ImportDataFormat": {
"ImportDataType": "string"
},
"ImportedItemsCount": number,
"JobId": "string",
"Name": "string",
"PreSignedUrl": "string",
"StartTimestamp": number,
"Status": "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.
- AddressListId
-
The unique identifier of the address list the import job was created for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9-]+$ - CompletedTimestamp
-
The timestamp of when the import job was completed.
Type: Timestamp
- CreatedTimestamp
-
The timestamp of when the import job was created.
Type: Timestamp
- Error
-
The reason for failure of an import job.
Type: String
- FailedItemsCount
-
The number of input addresses that failed to be imported into the address list.
Type: Integer
- ImportDataFormat
-
The format of the input for an import job.
Type: ImportDataFormat object
- ImportedItemsCount
-
The number of input addresses successfully imported into the address list.
Type: Integer
- JobId
-
The identifier of the import job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9-]+$ - Name
-
A user-friendly name for the import job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9_.-]+$ - PreSignedUrl
-
The pre-signed URL target for uploading the input file.
Type: String
- StartTimestamp
-
The timestamp of when the import job was started.
Type: Timestamp
- Status
-
The status of the import job.
Type: String
Valid Values:
CREATED | PROCESSING | COMPLETED | FAILED | STOPPED
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Occurs when a user is denied access to a specific resource or action.
HTTP Status Code: 400
- ResourceNotFoundException
-
Occurs when a requested resource is not found.
HTTP Status Code: 400
- ThrottlingException
-
Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
HTTP Status Code: 400
- ValidationException
-
The request validation has failed. For details, see the accompanying error message.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
