jobs

Creates, updates, deletes, gets or lists a jobs resource.

Overview

Name	jobs
Type	Resource
Id	aws.location.jobs

Fields

The following fields are returned by SELECT queries:

get_job

Name	Datatype	Description
action	string	Action performed by the job. (ValidateAddress)
action_options	object	Additional options for configuring job action parameters.
created_at	string (date-time)	Job creation time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.
ended_at	string (date-time)	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	object	Error information if the job failed.
execution_role_arn	string	IAM role used for permissions when running the job.
input_options	object	Input configuration.
job_arn	string	Amazon Resource Name (ARN) of the specified job. (pattern: <code>arn(:[a-z0-9]+([.-][a-z0-9]+)):geo(:([a-z0-9]+([.-][a-z0-9]+)))(:[0-9]+):((*)|([-a-z]+[/][*-._\w]+))</code>)
job_id	string	Unique job identifier. (pattern: <code>[-._\w]+</code>)
name	string	Job name (if provided during creation). (pattern: <code>[-._\w]+</code>)
output_options	object	Output configuration.
status	string	Current job status. (Pending, Running, Completed, Failed, Cancelling, Cancelled)
tags	object	Tags and corresponding values associated with the specified job.
updated_at	string (date-time)	Last update time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.

list_jobs

Name	Datatype	Description
action	string	Action performed by the job. (ValidateAddress)
action_options	object	Additional options for configuring job action parameters.
created_at	string (date-time)	Job creation time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.
ended_at	string (date-time)	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	object	Error information if the job failed.
execution_role_arn	string	IAM role used for job execution.
input_options	object	Input configuration.
job_arn	string	Amazon Resource Name (ARN) of the job. (pattern: <code>arn(:[a-z0-9]+([.-][a-z0-9]+)):geo(:([a-z0-9]+([.-][a-z0-9]+)))(:[0-9]+):((*)|([-a-z]+[/][*-._\w]+))</code>)
job_id	string	Unique job identifier. (pattern: <code>[-._\w]+</code>)
name	string	Job name (if provided during creation). (pattern: <code>[-._\w]+</code>)
output_options	object	Output configuration.
status	string	Current job status. (Pending, Running, Completed, Failed, Cancelling, Cancelled)
updated_at	string (date-time)	Last update time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_job	select	job_id, region		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.
list_jobs	select	region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
job_id	string	The unique identifier of the job to retrieve.
region	string	AWS region (default: us-east-1)

SELECT examples

get_job

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.

SELECT
action,
action_options,
created_at,
ended_at,
error,
execution_role_arn,
input_options,
job_arn,
job_id,
name,
output_options,
status,
tags,
updated_at
FROM aws.location.jobs
WHERE job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
;

list_jobs

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.

SELECT
action,
action_options,
created_at,
ended_at,
error,
execution_role_arn,
input_options,
job_arn,
job_id,
name,
output_options,
status,
updated_at
FROM aws.location.jobs
WHERE region = '{{ region }}' -- required
;