GetJob
GetJob retrieves detailed information about a specific job, including
its current status, configuration, and error information if the job failed.
For more information, see Job concepts in the Amazon Location Service Developer Guide.
Request Syntax
GET /metadata/v0/jobs/JobId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- JobId
-
The unique identifier of the job to retrieve.
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
[-._\w]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Action": "string",
"ActionOptions": {
"ValidateAddress": {
"AdditionalFeatures": [ "string" ]
}
},
"CreatedAt": "string",
"EndedAt": "string",
"Error": {
"Code": "string",
"Messages": [ "string" ]
},
"ExecutionRoleArn": "string",
"InputOptions": {
"Format": "string",
"Location": "string"
},
"JobArn": "string",
"JobId": "string",
"Name": "string",
"OutputOptions": {
"Format": "string",
"Location": "string"
},
"Status": "string",
"Tags": {
"string" : "string"
},
"UpdatedAt": "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.
- Action
-
Action performed by the job.
Type: String
Valid Values:
ValidateAddress - ActionOptions
-
Additional options for configuring job action parameters.
Type: JobActionOptions object
- CreatedAt
-
Job creation time in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sss.Type: Timestamp
- EndedAt
-
Job completion time in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sss. Only returned for jobs in a terminal status:Completed|Failed|Cancelled.Type: Timestamp
- Error
-
Error information if the job failed.
Type: JobError object
- ExecutionRoleArn
-
IAM role used for permissions when running the job.
Type: String
- InputOptions
-
Input configuration.
Type: JobInputOptions object
- JobArn
-
Amazon Resource Name (ARN) of the specified job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1600.
Pattern:
arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+)) - JobId
-
Unique job identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
[-._\w]+ - Name
-
Job name (if provided during creation).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[-._\w]+ - OutputOptions
-
Output configuration.
Type: JobOutputOptions object
- Status
-
Current job status.
Type: String
Valid Values:
Pending | Running | Completed | Failed | Cancelling | Cancelled - Tags
-
Tags and corresponding values associated with the specified job.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
([\p{L}\p{Z}\p{N}_.,:/=+\-@]*) - UpdatedAt
-
Last update time in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sss.Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
You don't have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
Request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
A resource associated with the request could not be found.
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.
Note
Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
