SageMakergeospatialcapabilities / Client / start_vector_enrichment_job

start_vector_enrichment_job#

SageMakergeospatialcapabilities.Client.start_vector_enrichment_job(**kwargs)#

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

Request Syntax

response = client.start_vector_enrichment_job(
    ClientToken='string',
    ExecutionRoleArn='string',
    InputConfig={
        'DataSourceConfig': {
            'S3Data': {
                'KmsKeyId': 'string',
                'S3Uri': 'string'
            }
        },
        'DocumentType': 'CSV'
    },
    JobConfig={
        'MapMatchingConfig': {
            'IdAttributeName': 'string',
            'TimestampAttributeName': 'string',
            'XAttributeName': 'string',
            'YAttributeName': 'string'
        },
        'ReverseGeocodingConfig': {
            'XAttributeName': 'string',
            'YAttributeName': 'string'
        }
    },
    KmsKeyId='string',
    Name='string',
    Tags={
        'string': 'string'
    }
)

Parameters:

ClientToken (string) –
A unique token that guarantees that the call to this API is idempotent.

This field is autopopulated if not provided.
ExecutionRoleArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
InputConfig (dict) –
[REQUIRED]

Input configuration information for the Vector Enrichment job.
- DataSourceConfig (dict) – [REQUIRED]
  
  The input structure for the data source that represents the storage type of the input data objects.
  
  Note
  This is a Tagged Union structure. Only one of the following top level keys can be set: S3Data.
  - S3Data (dict) –
    
    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 (string) – [REQUIRED]
  
  The input structure that defines the data source file type.
JobConfig (dict) –
[REQUIRED]

An object containing information about the job configuration.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: MapMatchingConfig, ReverseGeocodingConfig.
- MapMatchingConfig (dict) –
  
  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 (dict) –
  
  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 (dict) –
Each tag consists of a key and a value.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'DurationInSeconds': 123,
    'ExecutionRoleArn': 'string',
    'InputConfig': {
        'DataSourceConfig': {
            'S3Data': {
                'KmsKeyId': 'string',
                'S3Uri': 'string'
            }
        },
        'DocumentType': 'CSV'
    },
    'JobConfig': {
        'MapMatchingConfig': {
            'IdAttributeName': 'string',
            'TimestampAttributeName': 'string',
            'XAttributeName': 'string',
            'YAttributeName': 'string'
        },
        'ReverseGeocodingConfig': {
            'XAttributeName': 'string',
            'YAttributeName': 'string'
        }
    },
    'KmsKeyId': 'string',
    'Name': 'string',
    'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'STOPPED'|'COMPLETED'|'FAILED'|'DELETING'|'DELETED',
    'Tags': {
        'string': 'string'
    },
    'Type': 'REVERSE_GEOCODING'|'MAP_MATCHING'
}

Response Structure

(dict) –
- Arn (string) –
  
  The Amazon Resource Name (ARN) of the Vector Enrichment job.
- CreationTime (datetime) –
  
  The creation time.
- DurationInSeconds (integer) –
  
  The duration of the Vector Enrichment job, in seconds.
- ExecutionRoleArn (string) –
  
  The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
- InputConfig (dict) –
  
  Input configuration information for starting the Vector Enrichment job.
  - DataSourceConfig (dict) –
    
    The input structure for the data source that represents the storage type of the input data objects.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: S3Data. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    - S3Data (dict) –
      
      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) –
        
        The URL to the Amazon S3 data for the Vector Enrichment job.
  - DocumentType (string) –
    
    The input structure that defines the data source file type.
- JobConfig (dict) –
  
  An object containing information about the job configuration.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: MapMatchingConfig, ReverseGeocodingConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
  - MapMatchingConfig (dict) –
    
    The input structure for Map Matching operation type.
    - IdAttributeName (string) –
      
      The field name for the data that describes the identifier representing a collection of GPS points belonging to an individual trace.
    - TimestampAttributeName (string) –
      
      The name of the timestamp attribute.
    - XAttributeName (string) –
      
      The name of the X-attribute
    - YAttributeName (string) –
      
      The name of the Y-attribute
  - ReverseGeocodingConfig (dict) –
    
    The input structure for Reverse Geocoding operation type.
    - XAttributeName (string) –
      
      The field name for the data that describes x-axis coordinate, eg. longitude of a point.
    - YAttributeName (string) –
      
      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) –
  
  The name of the Vector Enrichment job.
- Status (string) –
  
  The status of the Vector Enrichment job being started.
- Tags (dict) –
  
  Each tag consists of a key and a value.
  - (string) –
    - (string) –
- Type (string) –
  
  The type of the Vector Enrichment job.

Exceptions

SageMakergeospatialcapabilities.Client.exceptions.ServiceQuotaExceededException
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedException
SageMakergeospatialcapabilities.Client.exceptions.ValidationException
SageMakergeospatialcapabilities.Client.exceptions.ThrottlingException
SageMakergeospatialcapabilities.Client.exceptions.InternalServerException
SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundException
SageMakergeospatialcapabilities.Client.exceptions.ConflictException