GetReferenceImportJob
Gets information about a reference import job.
Request Syntax
GET /referencestore/referenceStoreId
/importjob/id
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- id
-
The job's ID.
Length Constraints: Minimum length of 10. Maximum length of 36.
Pattern:
[0-9]+
Required: Yes
- referenceStoreId
-
The job's reference store ID.
Length Constraints: Minimum length of 10. Maximum length of 36.
Pattern:
[0-9]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"completionTime": "string",
"creationTime": "string",
"id": "string",
"referenceStoreId": "string",
"roleArn": "string",
"sources": [
{
"description": "string",
"name": "string",
"referenceId": "string",
"sourceFile": "string",
"status": "string",
"statusMessage": "string",
"tags": {
"string" : "string"
}
}
],
"status": "string",
"statusMessage": "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
-
When the job completed.
Type: Timestamp
- creationTime
-
When the job was created.
Type: Timestamp
- id
-
The job's ID.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 36.
Pattern:
[0-9]+
- referenceStoreId
-
The job's reference store ID.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 36.
Pattern:
[0-9]+
- roleArn
-
The job's service role ARN.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:.*
- sources
-
The job's source files.
Type: Array of ImportReferenceSourceItem objects
- status
-
The job's status.
Type: String
Valid Values:
SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES
- statusMessage
-
The job's status message.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern:
[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error occurred. Try the request again.
HTTP Status Code: 500
- RequestTimeoutException
-
The request timed out.
HTTP Status Code: 408
- ResourceNotFoundException
-
The target resource was not found in the current Region.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: