StartVectorEnrichmentJob
Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.
Request Syntax
POST /vector-enrichment-jobs HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"ExecutionRoleArn": "string",
"InputConfig": {
"DataSourceConfig": { ... },
"DocumentType": "string"
},
"JobConfig": { ... },
"KmsKeyId": "string",
"Name": "string",
"Tags": {
"string" : "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- ClientToken
-
A unique token that guarantees that the call to this API is idempotent.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Required: No
- 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+=,.@_/-]+$Required: Yes
- InputConfig
-
Input configuration information for the Vector Enrichment job.
Type: VectorEnrichmentJobInputConfig object
Required: Yes
- 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.
Required: Yes
- KmsKeyId
-
The Key Management Service key ID for server-side encryption.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
- Name
-
The name of the Vector Enrichment job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
Required: Yes
- Tags
-
Each tag consists of a key and a value.
Type: String to string map
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"CreationTime": "string",
"DurationInSeconds": number,
"ExecutionRoleArn": "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
Pattern:
^arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:vector-enrichment-job/[a-z0-9]{12,}$ - CreationTime
-
The creation time.
Type: Timestamp
- DurationInSeconds
-
The duration of the Vector Enrichment job, in seconds.
Type: Integer
- 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+=,.@_/-]+$ - InputConfig
-
Input configuration information for starting 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 Vector Enrichment job being started.
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.
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
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- 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
- ServiceQuotaExceededException
-
You have exceeded the service quota.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
