Start Vector Enrichment Job

sagemakergeospatialcapabilities_start_vector_enrichment_job

R Documentation

Creates a Vector Enrichment job for the supplied job type¶

Description¶

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

Usage¶

sagemakergeospatialcapabilities_start_vector_enrichment_job(ClientToken,
  ExecutionRoleArn, InputConfig, JobConfig, KmsKeyId, Name, Tags)

Arguments¶

ClientToken

A unique token that guarantees that the call to this API is idempotent.

ExecutionRoleArn

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

InputConfig

[required] Input configuration information for the Vector Enrichment job.

JobConfig

[required] An object containing information about the job configuration.

KmsKeyId

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

Name

[required] The name of the Vector Enrichment job.

Tags

Each tag consists of a key and a value.

Value¶

A list with the following syntax:

list(
  Arn = "string",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  DurationInSeconds = 123,
  ExecutionRoleArn = "string",
  InputConfig = list(
    DataSourceConfig = list(
      S3Data = list(
        KmsKeyId = "string",
        S3Uri = "string"
      )
    ),
    DocumentType = "CSV"
  ),
  JobConfig = list(
    MapMatchingConfig = list(
      IdAttributeName = "string",
      TimestampAttributeName = "string",
      XAttributeName = "string",
      YAttributeName = "string"
    ),
    ReverseGeocodingConfig = list(
      XAttributeName = "string",
      YAttributeName = "string"
    )
  ),
  KmsKeyId = "string",
  Name = "string",
  Status = "INITIALIZING"|"IN_PROGRESS"|"STOPPING"|"STOPPED"|"COMPLETED"|"FAILED"|"DELETING"|"DELETED",
  Tags = list(
    "string"
  ),
  Type = "REVERSE_GEOCODING"|"MAP_MATCHING"
)

Request syntax¶

svc$start_vector_enrichment_job(
  ClientToken = "string",
  ExecutionRoleArn = "string",
  InputConfig = list(
    DataSourceConfig = list(
      S3Data = list(
        KmsKeyId = "string",
        S3Uri = "string"
      )
    ),
    DocumentType = "CSV"
  ),
  JobConfig = list(
    MapMatchingConfig = list(
      IdAttributeName = "string",
      TimestampAttributeName = "string",
      XAttributeName = "string",
      YAttributeName = "string"
    ),
    ReverseGeocodingConfig = list(
      XAttributeName = "string",
      YAttributeName = "string"
    )
  ),
  KmsKeyId = "string",
  Name = "string",
  Tags = list(
    "string"
  )
)