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.

export_earth_observation_job

SageMakergeospatialcapabilities.Client.export_earth_observation_job(**kwargs)

Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an S3 location.

See also: AWS API Documentation

Request Syntax

response = client.export_earth_observation_job(
    Arn='string',
    ExecutionRoleArn='string',
    ExportSourceImages=True|False,
    OutputConfig={
        'S3Data': {
            'KmsKeyId': 'string',
            'S3Uri': 'string'
        }
    }
)
Parameters
  • Arn (string) --

    [REQUIRED]

    The input Amazon Resource Name (ARN) of the Earth Observation job being exported.

  • ExecutionRoleArn (string) --

    [REQUIRED]

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

  • ExportSourceImages (boolean) -- The source images provided to the Earth Observation job being exported.
  • OutputConfig (dict) --

    [REQUIRED]

    An object containing information about the output file.

    • S3Data (dict) -- [REQUIRED]

      Path to Amazon S3 storage location for the output configuration file.

      • KmsKeyId (string) --

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

      • S3Uri (string) -- [REQUIRED]

        The URL to the Amazon S3 data input.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • Arn (string) --

      The output Amazon Resource Name (ARN) of the Earth Observation job being exported.

    • CreationTime (datetime) --

      The creation time.

    • ExecutionRoleArn (string) --

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

    • ExportSourceImages (boolean) --

      The source images provided to the Earth Observation job being exported.

    • ExportStatus (string) --

      The status of the results of the Earth Observation job being exported.

    • OutputConfig (dict) --

      An object containing information about the output file.

      • S3Data (dict) --

        Path to Amazon S3 storage location for the output configuration file.

        • KmsKeyId (string) --

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

        • S3Uri (string) --

          The URL to the Amazon S3 data input.

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