2026/04/20 - Amazon Location Service - 4 new api methods
Changes This release adds support for new Job APIs for bulk workloads. The initial job type supported is Address Validation. The new APIs added are StartJob, CancelJob, ListJobs, and GetJob.
CancelJob cancels a job that is currently running or pending. If the job is already in a terminal state ( Completed, Failed, or Cancelled), the operation returns successfully with the current status.
For more information, see Job concepts in the Amazon Location Service Developer Guide.
See also: AWS API Documentation
Request Syntax
client.cancel_job(
JobId='string'
)
string
[REQUIRED]
The unique identifier of the job to cancel.
dict
Response Syntax
{
'JobArn': 'string',
'JobId': 'string',
'Status': 'Pending'|'Running'|'Completed'|'Failed'|'Cancelling'|'Cancelled'
}
Response Structure
(dict) --
JobArn (string) --
Amazon Resource Name (ARN) of the cancelled job.
JobId (string) --
Unique job identifier.
Status (string) --
Job status after cancellation request.
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.
See also: AWS API Documentation
Request Syntax
client.get_job(
JobId='string'
)
string
[REQUIRED]
The unique identifier of the job to retrieve.
dict
Response Syntax
{
'Action': 'ValidateAddress',
'ActionOptions': {
'ValidateAddress': {
'AdditionalFeatures': [
'Position'|'CountrySpecificAttributes',
]
}
},
'CreatedAt': datetime(2015, 1, 1),
'EndedAt': datetime(2015, 1, 1),
'Error': {
'Code': 'ValidationError'|'InternalServerError',
'Messages': [
'string',
]
},
'ExecutionRoleArn': 'string',
'InputOptions': {
'Location': 'string',
'Format': 'Parquet'
},
'JobArn': 'string',
'JobId': 'string',
'Name': 'string',
'OutputOptions': {
'Format': 'Parquet',
'Location': 'string'
},
'Status': 'Pending'|'Running'|'Completed'|'Failed'|'Cancelling'|'Cancelled',
'UpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Action (string) --
Action performed by the job.
ActionOptions (dict) --
Additional options for configuring job action parameters.
ValidateAddress (dict) --
Options specific to address validation jobs.
AdditionalFeatures (list) --
A list of optional additional parameters that can be requested for each result.
Values:
Position - Return the position coordinates of the address if available.
CountrySpecificAttributes - Return additional information about the address specific to the country of origin.
(string) --
CreatedAt (datetime) --
Job creation time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.
EndedAt (datetime) --
Job completion time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss. Only returned for jobs in a terminal status: Completed | Failed | Cancelled.
Error (dict) --
Error information if the job failed.
Code (string) --
Error code indicating the type of error that occurred.
Messages (list) --
Error messages providing details about the failure.
(string) --
ExecutionRoleArn (string) --
IAM role used for permissions when running the job.
InputOptions (dict) --
Input configuration.
Location (string) --
S3 ARN or URI where input files are stored.
Format (string) --
Input data format. Currently only Parquet is supported.
JobArn (string) --
Amazon Resource Name (ARN) of the specified job.
JobId (string) --
Unique job identifier.
Name (string) --
Job name (if provided during creation).
OutputOptions (dict) --
Output configuration.
Format (string) --
Output data format. Currently only "Parquet" is supported.
Location (string) --
S3 ARN or URI where output files will be written.
Status (string) --
Current job status.
UpdatedAt (datetime) --
Last update time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.
Tags (dict) --
Tags and corresponding values associated with the specified job.
(string) --
(string) --
ListJobs retrieves a list of jobs with optional filtering and pagination support.
For more information, see Job concepts in the Amazon Location Service Developer Guide.
See also: AWS API Documentation
Request Syntax
client.list_jobs(
Filter={
'JobStatus': 'Pending'|'Running'|'Completed'|'Failed'|'Cancelling'|'Cancelled'
},
MaxResults=123,
NextToken='string'
)
dict
An optional structure containing criteria by which to filter job results.
JobStatus (string) --
Filter by job status.
integer
Maximum number of jobs to return.
string
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
dict
Response Syntax
{
'Entries': [
{
'Action': 'ValidateAddress',
'ActionOptions': {
'ValidateAddress': {
'AdditionalFeatures': [
'Position'|'CountrySpecificAttributes',
]
}
},
'CreatedAt': datetime(2015, 1, 1),
'ExecutionRoleArn': 'string',
'EndedAt': datetime(2015, 1, 1),
'Error': {
'Code': 'ValidationError'|'InternalServerError',
'Messages': [
'string',
]
},
'InputOptions': {
'Location': 'string',
'Format': 'Parquet'
},
'JobId': 'string',
'JobArn': 'string',
'Name': 'string',
'OutputOptions': {
'Format': 'Parquet',
'Location': 'string'
},
'Status': 'Pending'|'Running'|'Completed'|'Failed'|'Cancelling'|'Cancelled',
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entries (list) --
List of jobs in your Amazon Web Services account.
(dict) --
Job summary information returned in list operations.
Action (string) --
Action performed by the job.
ActionOptions (dict) --
Additional options for configuring job action parameters.
ValidateAddress (dict) --
Options specific to address validation jobs.
AdditionalFeatures (list) --
A list of optional additional parameters that can be requested for each result.
Values:
Position - Return the position coordinates of the address if available.
CountrySpecificAttributes - Return additional information about the address specific to the country of origin.
(string) --
CreatedAt (datetime) --
Job creation time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.
ExecutionRoleArn (string) --
IAM role used for job execution.
EndedAt (datetime) --
Job completion time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss. Only returned for jobs in a terminal status: Completed | Failed | Cancelled.
Error (dict) --
Error information if the job failed.
Code (string) --
Error code indicating the type of error that occurred.
Messages (list) --
Error messages providing details about the failure.
(string) --
InputOptions (dict) --
Input configuration.
Location (string) --
S3 ARN or URI where input files are stored.
Format (string) --
Input data format. Currently only Parquet is supported.
JobId (string) --
Unique job identifier.
JobArn (string) --
Amazon Resource Name (ARN) of the job.
Name (string) --
Job name (if provided during creation).
OutputOptions (dict) --
Output configuration.
Format (string) --
Output data format. Currently only "Parquet" is supported.
Location (string) --
S3 ARN or URI where output files will be written.
Status (string) --
Current job status.
UpdatedAt (datetime) --
Last update time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.
NextToken (string) --
Token for retrieving the next page (present if more results available).
StartJob starts a new asynchronous bulk processing job. You specify the input data location in Amazon S3, the action to perform, and the output location where results are written.
For more information, see Job concepts in the Amazon Location Service Developer Guide.
See also: AWS API Documentation
Request Syntax
client.start_job(
ClientToken='string',
Action='ValidateAddress',
ActionOptions={
'ValidateAddress': {
'AdditionalFeatures': [
'Position'|'CountrySpecificAttributes',
]
}
},
ExecutionRoleArn='string',
InputOptions={
'Location': 'string',
'Format': 'Parquet'
},
Name='string',
OutputOptions={
'Format': 'Parquet',
'Location': 'string'
},
Tags={
'string': 'string'
}
)
string
A unique identifier for this request to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The action to perform on the input data.
dict
Additional parameters that can be requested for each result.
ValidateAddress (dict) --
Options specific to address validation jobs.
AdditionalFeatures (list) --
A list of optional additional parameters that can be requested for each result.
Values:
Position - Return the position coordinates of the address if available.
CountrySpecificAttributes - Return additional information about the address specific to the country of origin.
(string) --
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.
For more information about configuring IAM roles for Amazon Location jobs, see Configure IAM permissions in the Amazon Location Service Developer Guide.
dict
[REQUIRED]
Configuration for input data location and format.
Location (string) -- [REQUIRED]
S3 ARN or URI where input files are stored.
Format (string) -- [REQUIRED]
Input data format. Currently only Parquet is supported.
string
An optional name for the job resource.
dict
[REQUIRED]
Configuration for output data location and format.
Format (string) -- [REQUIRED]
Output data format. Currently only "Parquet" is supported.
Location (string) -- [REQUIRED]
S3 ARN or URI where output files will be written.
dict
Tags and corresponding values to be associated with the job.
(string) --
(string) --
dict
Response Syntax
{
'CreatedAt': datetime(2015, 1, 1),
'JobArn': 'string',
'JobId': 'string',
'Status': 'Pending'|'Running'|'Completed'|'Failed'|'Cancelling'|'Cancelled'
}
Response Structure
(dict) --
CreatedAt (datetime) --
Job creation time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.
JobArn (string) --
The Amazon Resource Name (ARN) for the job resource. Used when you need to specify a resource across all Amazon Web Services.
Format example: arn:aws:geo:region:account-id:job/ExampleJob
JobId (string) --
Unique job identifier.
Status (string) --
Initial job status (always "Pending" for new jobs).