earth_observation_jobs

Creates, updates, deletes, gets or lists an earth_observation_jobs resource.

Overview

Name	earth_observation_jobs
Type	Resource
Id	aws.sagemaker_geospatial.earth_observation_jobs

Fields

The following fields are returned by SELECT queries:

get_earth_observation_job

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the Earth Observation job.
creation_time	string (date-time)	The creation time of the initiated Earth Observation job.
duration_in_seconds	integer	The duration of Earth Observation job, in seconds.
error_details	object	Details about the errors generated during the Earth Observation job.
execution_role_arn	string	The Amazon Resource Name (ARN) of the IAM role that you specified for the job. (pattern: <code>^arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+$</code>)
export_error_details	object	Details about the errors generated during ExportEarthObservationJob.
export_status	string	The status of the Earth Observation job. (IN_PROGRESS, SUCCEEDED, FAILED)
input_config	object	Input data for the Earth Observation job.
job_config	object	An object containing information about the job configuration.
kms_key_id	string	The Key Management Service key ID for server-side encryption.
name	string	The name of the Earth Observation job.
output_bands	array	Bands available in the output of an operation.
status	string	The status of a previously initiated Earth Observation job. (INITIALIZING, IN_PROGRESS, STOPPING, COMPLETED, STOPPED, FAILED, DELETING, DELETED)
tags	object	Each tag consists of a key and a value.

list_earth_observation_jobs

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the list of the Earth Observation jobs.
creation_time	string (date-time)	The creation time.
duration_in_seconds	integer	The duration of the session, in seconds.
name	string	The names of the Earth Observation jobs in the list.
operation_type	string	The operation type for an Earth Observation job.
status	string	The status of the list of the Earth Observation jobs. (INITIALIZING, IN_PROGRESS, STOPPING, COMPLETED, STOPPED, FAILED, DELETING, DELETED)
tags	object	Each tag consists of a key and a value.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_earth_observation_job	select	arn, region		Get the details for a previously initiated Earth Observation job.
list_earth_observation_jobs	select	region		Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
delete_earth_observation_job	delete	arn, region		Use this operation to delete an Earth Observation job.

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
arn	string	The Amazon Resource Name (ARN) of the Earth Observation job being deleted.
region	string	AWS region (default: us-east-1)

SELECT examples

get_earth_observation_job

Get the details for a previously initiated Earth Observation job.

SELECT
arn,
creation_time,
duration_in_seconds,
error_details,
execution_role_arn,
export_error_details,
export_status,
input_config,
job_config,
kms_key_id,
name,
output_bands,
status,
tags
FROM aws.sagemaker_geospatial.earth_observation_jobs
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
;

list_earth_observation_jobs

Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.

SELECT
arn,
creation_time,
duration_in_seconds,
name,
operation_type,
status,
tags
FROM aws.sagemaker_geospatial.earth_observation_jobs
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_earth_observation_job

Use this operation to delete an Earth Observation job.

DELETE FROM aws.sagemaker_geospatial.earth_observation_jobs
WHERE arn = '{{ arn }}' --required
AND region = '{{ region }}' --required
;