SageMakergeospatialcapabilities / Client / export_vector_enrichment_job

export_vector_enrichment_job#

SageMakergeospatialcapabilities.Client.export_vector_enrichment_job(**kwargs)#

Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.

See also: AWS API Documentation

Request Syntax

response = client.export_vector_enrichment_job(
    Arn='string',
    ClientToken='string',
    ExecutionRoleArn='string',
    OutputConfig={
        'S3Data': {
            'KmsKeyId': 'string',
            'S3Uri': 'string'
        }
    }
)
Parameters:

  • Arn (string) –

    [REQUIRED]

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

  • 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 rolewith permission to upload to the location in OutputConfig.

  • OutputConfig (dict) –

    [REQUIRED]

    Output location information for exporting Vector Enrichment Job results.

    • S3Data (dict) – [REQUIRED]

      The input structure for Amazon S3 data; representing 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.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'ExecutionRoleArn': 'string',
    'ExportStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
    'OutputConfig': {
        'S3Data': {
            'KmsKeyId': 'string',
            'S3Uri': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • Arn (string) –

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

    • CreationTime (datetime) –

      The creation time.

    • ExecutionRoleArn (string) –

      The Amazon Resource Name (ARN) of the IAM role with permission to upload to the location in OutputConfig.

    • ExportStatus (string) –

      The status of the results the Vector Enrichment job being exported.

    • OutputConfig (dict) –

      Output location information for exporting Vector Enrichment Job results.

      • S3Data (dict) –

        The input structure for Amazon S3 data; representing 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.

Exceptions