GetVectorEnrichmentJob - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

GetVectorEnrichmentJob

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

Request Syntax

GET /vector-enrichment-jobs/Arn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Arn

The Amazon Resource Name (ARN) of the Vector Enrichment job.

Pattern: ^arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:vector-enrichment-job/[a-z0-9]{12,}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Arn": "string", "CreationTime": "string", "DurationInSeconds": number, "ErrorDetails": { "ErrorMessage": "string", "ErrorType": "string" }, "ExecutionRoleArn": "string", "ExportErrorDetails": { "Message": "string", "Type": "string" }, "ExportStatus": "string", "InputConfig": { "DataSourceConfig": { ... }, "DocumentType": "string" }, "JobConfig": { ... }, "KmsKeyId": "string", "Name": "string", "Status": "string", "Tags": { "string" : "string" }, "Type": "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.

Arn

The Amazon Resource Name (ARN) of the Vector Enrichment job.

Type: String

CreationTime

The creation time.

Type: Timestamp

DurationInSeconds

The duration of the Vector Enrichment job, in seconds.

Type: Integer

ErrorDetails

Details about the errors generated during the Vector Enrichment job.

Type: VectorEnrichmentJobErrorDetails object

ExecutionRoleArn

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+$

ExportErrorDetails

Details about the errors generated during the ExportVectorEnrichmentJob.

Type: VectorEnrichmentJobExportErrorDetails object

ExportStatus

The export status of the Vector Enrichment job being initiated.

Type: String

Valid Values: IN_PROGRESS | SUCCEEDED | FAILED

InputConfig

Input configuration information for the Vector Enrichment job.

Type: VectorEnrichmentJobInputConfig object

JobConfig

An object containing information about the job configuration.

Type: VectorEnrichmentJobConfig object

Note: This object is a Union. Only one member of this object can be specified or returned.

KmsKeyId

The Key Management Service key ID for server-side encryption.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Name

The name of the Vector Enrichment job.

Type: String

Status

The status of the initiated Vector Enrichment job.

Type: String

Valid Values: INITIALIZING | IN_PROGRESS | STOPPING | STOPPED | COMPLETED | FAILED | DELETING | DELETED

Tags

Each tag consists of a key and a value.

Type: String to string map

Type

The type of the Vector Enrichment job being initiated.

Type: String

Valid Values: REVERSE_GEOCODING | MAP_MATCHING

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource which does not exist.

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 Amazon service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: