---
title: "POST /vector-enrichment-jobs"
method: POST
path: "/vector-enrichment-jobs"
---

# POST /vector-enrichment-jobs

`POST /vector-enrichment-jobs`

Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.

## Request body

- object
  - `ClientToken` string — A unique token that guarantees that the call to this API is idempotent.
  - `ExecutionRoleArn` string, required — The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
  - `InputConfig` object, required — The input structure for the InputConfig in a VectorEnrichmentJob.
    - `DataSourceConfig` object — The input structure for the data source that represents the storage type of the input data objects.
      - `S3Data` object — The input structure for the Amazon S3 data that represents the Amazon S3 location of the input data objects.
        - `KmsKeyId` string — The Key Management Service key ID for server-side encryption.
        - `S3Uri` string, required — The URL to the Amazon S3 data for the Vector Enrichment job.
    - `DocumentType` 'CSV' — The input structure that defines the data source file type.
  - `JobConfig` object, required — It contains configs such as ReverseGeocodingConfig and MapMatchingConfig.
    - `MapMatchingConfig` object — The input structure for Map Matching operation type.
      - `IdAttributeName` string, required — The field name for the data that describes the identifier representing a collection of GPS points belonging to an individual trace.
      - `TimestampAttributeName` string, required — The name of the timestamp attribute.
      - `XAttributeName` string, required — The name of the X-attribute
      - `YAttributeName` string, required — The name of the Y-attribute
    - `ReverseGeocodingConfig` object — The input structure for Reverse Geocoding operation type.
      - `XAttributeName` string, required — The field name for the data that describes x-axis coordinate, eg. longitude of a point.
      - `YAttributeName` string, required — The field name for the data that describes y-axis coordinate, eg. latitude of a point.
  - `KmsKeyId` string — The Key Management Service key ID for server-side encryption.
  - `Name` string, required — The name of the Vector Enrichment job.
  - `Tags` object — Each tag consists of a key and a value.

## Response `200`

Success

- StartVectorEnrichmentJobOutput
  - `Arn` string, required — The Amazon Resource Name (ARN) of the Vector Enrichment job.
  - `CreationTime` string, date-time, required — The creation time.
  - `DurationInSeconds` integer, required — The duration of the Vector Enrichment job, in seconds.
  - `ExecutionRoleArn` string, required — The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
  - `InputConfig` object, required — Input configuration information for starting the Vector Enrichment job.
    - `DataSourceConfig` object, required — The input structure for the data source that represents the storage type of the input data objects.
      - `S3Data` object — The input structure for the Amazon S3 data that represents the Amazon S3 location of the input data objects.
        - `KmsKeyId` string — The Key Management Service key ID for server-side encryption.
        - `S3Uri` string, required — The URL to the Amazon S3 data for the Vector Enrichment job.
    - `DocumentType` 'CSV', required — The input structure that defines the data source file type.
  - `JobConfig` object, required — An object containing information about the job configuration.
    - `MapMatchingConfig` object — The input structure for Map Matching operation type.
      - `IdAttributeName` string, required — The field name for the data that describes the identifier representing a collection of GPS points belonging to an individual trace.
      - `TimestampAttributeName` string, required — The name of the timestamp attribute.
      - `XAttributeName` string, required — The name of the X-attribute
      - `YAttributeName` string, required — The name of the Y-attribute
    - `ReverseGeocodingConfig` object — The input structure for Reverse Geocoding operation type.
      - `XAttributeName` string, required — The field name for the data that describes x-axis coordinate, eg. longitude of a point.
      - `YAttributeName` string, required — The field name for the data that describes y-axis coordinate, eg. latitude of a point.
  - `KmsKeyId` string — The Key Management Service key ID for server-side encryption.
  - `Name` string, required — The name of the Vector Enrichment job.
  - `Status` 'INITIALIZING' | 'IN_PROGRESS' | 'STOPPING' | 'STOPPED' | 'COMPLETED' | 'FAILED' | 'DELETING' | 'DELETED', required — The status of the Vector Enrichment job being started.
  - `Tags` object — Each tag consists of a key and a value.
  - `Type` 'REVERSE_GEOCODING' | 'MAP_MATCHING', required — The type of the Vector Enrichment job.

## Other responses

- `480` — ServiceQuotaExceededException
- `481` — AccessDeniedException
- `482` — ValidationException
- `483` — ThrottlingException
- `484` — InternalServerException
- `485` — ResourceNotFoundException
- `486` — ConflictException

---

[API](https://skmtc.net/aws/apis/sagemaker-geospatial.md) · [All operations](https://skmtc.net/aws/apis/sagemaker-geospatial/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/sagemaker-geospatial/versions/cfc9ba4ca4d8/schema)