export_earth_observation_job `async` ¶

export_earth_observation_job(
    arn: EarthObservationJobArn,
    execution_role_arn: ExecutionRoleArn,
    output_config: OutputConfigInput,
    *,
    config_overrides: Optional[AsyncSageMakerGeospatialClientConfig] = None,
    client_token: Optional[str] = None,
    export_source_images: Optional[bool] = None,
) -> ExportEarthObservationJobOutput

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

Parameters:

arn (EarthObservationJobArn) –

The input Amazon Resource Name (ARN) of the Earth Observation job being exported.
client_token (Optional[str], default: None ) –

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

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

An object containing information about the output file.
export_source_images (Optional[bool], default: None ) –

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

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

Updating or deleting a resource can cause an inconsistent state.
InternalServerException –

The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException –

The request references a resource which does not exist.
ServiceQuotaExceededException –

You have exceeded the service quota.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy the constraints specified by an Amazon Web Services service.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_sagemaker_geospatial/_services/async_sage_maker_geospatial.py

async def export_earth_observation_job(
    self,
    arn: "capo_sagemaker_geospatial.types.earth_observation_job_arn.EarthObservationJobArn",
    execution_role_arn: "capo_sagemaker_geospatial.types.execution_role_arn.ExecutionRoleArn",
    output_config: "capo_sagemaker_geospatial.types.output_config_input.OutputConfigInput",
    *,
    config_overrides: Optional[AsyncSageMakerGeospatialClientConfig] = None,
    client_token: Optional[str] = None,
    export_source_images: Optional[bool] = None,
) -> "capo_sagemaker_geospatial.types.export_earth_observation_job_output.ExportEarthObservationJobOutput":
    """<p>Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an Amazon S3 location.</p>

    Args:
        arn: <p>The input Amazon Resource Name (ARN) of the Earth Observation job being exported.</p>
        client_token: <p>A unique token that guarantees that the call to this API is idempotent.</p>
        execution_role_arn: <p>The Amazon Resource Name (ARN) of the IAM role that you specified for the job.</p>
        output_config: <p>An object containing information about the output file.</p>
        export_source_images: <p>The source images provided to the Earth Observation job being exported.</p>

    Raises:
        capo_sagemaker_geospatial.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_sagemaker_geospatial.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_sagemaker_geospatial.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception, or failure.</p>
        capo_sagemaker_geospatial.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource which does not exist.</p>
        capo_sagemaker_geospatial.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You have exceeded the service quota.</p>
        capo_sagemaker_geospatial.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_sagemaker_geospatial.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_sagemaker_geospatial.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker_geospatial.types.export_earth_observation_job_input.ExportEarthObservationJobInput]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker_geospatial.types.export_earth_observation_job_output.ExportEarthObservationJobOutput"
    ]:
        import capo_sagemaker_geospatial._operations.sage_maker_geospatial.export_earth_observation_job

        (
            output,
            http_response,
        ) = await capo_sagemaker_geospatial._operations.sage_maker_geospatial.export_earth_observation_job.async_export_earth_observation_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ExportEarthObservationJob")
    )
    input_: capo_sagemaker_geospatial.types.export_earth_observation_job_input.ExportEarthObservationJobInput = {
        "arn": arn,
        "execution_role_arn": execution_role_arn,
        "output_config": output_config,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if export_source_images is not None:
        input_["export_source_images"] = export_source_images

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

export_earth_observation_job async ¶

export_earth_observation_job `async` ¶