Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_vector_enrichment_job

get_vector_enrichment_job(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_vector_enrichment_job(
    Arn='string'
)
Parameters
Arn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'Arn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'DurationInSeconds': 123,
    'ErrorDetails': {
        'ErrorMessage': 'string',
        'ErrorType': 'CLIENT_ERROR'|'SERVER_ERROR'
    },
    'ExecutionRoleArn': 'string',
    'ExportErrorDetails': {
        'Message': 'string',
        'Type': 'CLIENT_ERROR'|'SERVER_ERROR'
    },
    'ExportStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
    '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.

    • ErrorDetails (dict) --

      Details about the errors generated during the Vector Enrichment job.

      • ErrorMessage (string) --

        A message that you define and then is processed and rendered by the Vector Enrichment job when the error occurs.

      • ErrorType (string) --

        The type of error generated during the Vector Enrichment job.

    • ExecutionRoleArn (string) --

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

    • ExportErrorDetails (dict) --

      Details about the errors generated during the ExportVectorEnrichmentJob.

      • Message (string) --

        The message providing details about the errors generated during the Vector Enrichment job.

      • Type (string) --
    • ExportStatus (string) --

      The export status of the Vector Enrichment job being initiated.

    • InputConfig (dict) --

      Input configuration information for the Vector Enrichment job.

      • DataSourceConfig (dict) --

        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) --
          • KmsKeyId (string) --

            The Amazon Key Management Service (KMS) key ID for server-side encryption.

          • S3Uri (string) --

            The URL to the Amazon S3 data for the Vector Enrichment job.

      • DocumentType (string) --
    • 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) --
        • IdAttributeName (string) --
        • 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) --
        • XAttributeName (string) --
        • YAttributeName (string) --
    • KmsKeyId (string) --

      The Amazon Key Management Service (KMS) key ID for server-side encryption.

    • Name (string) --

      The name of the Vector Enrichment job.

    • Status (string) --

      The status of the initiated Vector Enrichment job.

    • Tags (dict) --

      Each tag consists of a key and a value.

      • (string) --
        • (string) --
    • Type (string) --

      The type of the Vector Enrichment job being initiated.

Exceptions

  • SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedException
  • SageMakergeospatialcapabilities.Client.exceptions.ValidationException
  • SageMakergeospatialcapabilities.Client.exceptions.ThrottlingException
  • SageMakergeospatialcapabilities.Client.exceptions.InternalServerException
  • SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundException