vector_enrichment_jobs

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

Overview

Name	vector_enrichment_jobs
Type	Resource
Id	aws.sagemaker_geospatial.vector_enrichment_jobs

Fields

The following fields are returned by SELECT queries:

get_vector_enrichment_job

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the Vector Enrichment job.
creation_time	string (date-time)	The creation time.
duration_in_seconds	integer	The duration of the Vector Enrichment job, in seconds.
error_details	object	Details about the errors generated during the Vector Enrichment 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 the ExportVectorEnrichmentJob.
export_status	string	The export status of the Vector Enrichment job being initiated. (IN_PROGRESS, SUCCEEDED, FAILED)
input_config	object	Input configuration information for the Vector Enrichment 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 Vector Enrichment job.
status	string	The status of the initiated Vector Enrichment job. (INITIALIZING, IN_PROGRESS, STOPPING, STOPPED, COMPLETED, FAILED, DELETING, DELETED)
tags	object	Each tag consists of a key and a value.
type	string	The type of the Vector Enrichment job being initiated. (REVERSE_GEOCODING, MAP_MATCHING)

list_vector_enrichment_jobs

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the list of the Vector Enrichment jobs. (pattern: <code>^arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:vector-enrichment-job/[a-z0-9]{12,}$</code>)
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 Vector Enrichment jobs in the list.
status	string	The status of the Vector Enrichment jobs list. (INITIALIZING, IN_PROGRESS, STOPPING, STOPPED, COMPLETED, FAILED, DELETING, DELETED)
tags	object	Each tag consists of a key and a value.
type	string	The type of the list of Vector Enrichment jobs. (REVERSE_GEOCODING, MAP_MATCHING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_vector_enrichment_job	select	arn, region		Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
list_vector_enrichment_jobs	select	region		Retrieves a list of vector enrichment jobs.
delete_vector_enrichment_job	delete	arn, region		Use this operation to delete a Vector Enrichment 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 Vector Enrichment job being deleted.
region	string	AWS region (default: us-east-1)

SELECT examples

get_vector_enrichment_job

Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).

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,
status,
tags,
type
FROM aws.sagemaker_geospatial.vector_enrichment_jobs
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
;

list_vector_enrichment_jobs

Retrieves a list of vector enrichment jobs.

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

DELETE examples

delete_vector_enrichment_job

Use this operation to delete a Vector Enrichment job.

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