SageMakergeospatialcapabilities / Client / list_vector_enrichment_jobs

list_vector_enrichment_jobs#

SageMakergeospatialcapabilities.Client.list_vector_enrichment_jobs(**kwargs)#

Retrieves a list of vector enrichment jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_vector_enrichment_jobs(
    MaxResults=123,
    NextToken='string',
    SortBy='string',
    SortOrder='ASCENDING'|'DESCENDING',
    StatusEquals='string'
)
Parameters:

  • MaxResults (integer) – The maximum number of items to return.

  • NextToken (string) – If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

  • SortBy (string) – The parameter by which to sort the results.

  • SortOrder (string) – An optional value that specifies whether you want the results sorted in Ascending or Descending order.

  • StatusEquals (string) – A filter that retrieves only jobs with a specific status.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'VectorEnrichmentJobSummaries': [
        {
            'Arn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'DurationInSeconds': 123,
            'Name': 'string',
            'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'STOPPED'|'COMPLETED'|'FAILED'|'DELETING'|'DELETED',
            'Tags': {
                'string': 'string'
            },
            'Type': 'REVERSE_GEOCODING'|'MAP_MATCHING'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

    • VectorEnrichmentJobSummaries (list) –

      Contains summary information about the Vector Enrichment jobs.

      • (dict) –

        An object containing information about the output file.

        • Arn (string) –

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

        • CreationTime (datetime) –

          The creation time.

        • DurationInSeconds (integer) –

          The duration of the session, in seconds.

        • Name (string) –

          The names of the Vector Enrichment jobs in the list.

        • Status (string) –

          The status of the Vector Enrichment jobs list.

        • Tags (dict) –

          Each tag consists of a key and a value.

          • (string) –

            • (string) –

        • Type (string) –

          The type of the list of Vector Enrichment jobs.

Exceptions