start_earth_observation_job ¶

def start_earth_observation_job(
    self,
    name: str,
    input_config: "capo_sagemaker_geospatial.types.input_config_input.InputConfigInput",
    job_config: "capo_sagemaker_geospatial.types.job_config_input.JobConfigInput",
    execution_role_arn: "capo_sagemaker_geospatial.types.execution_role_arn.ExecutionRoleArn",
    *,
    config_overrides: Optional[SageMakerGeospatialClientConfig] = None,
    client_token: Optional[str] = None,
    kms_key_id: Optional["capo_sagemaker_geospatial.types.kms_key.KmsKey"] = None,
    tags: Optional["capo_sagemaker_geospatial.types.tags.Tags"] = None,
) -> "capo_sagemaker_geospatial.types.start_earth_observation_job_output.StartEarthObservationJobOutput":
    """<p>Use this operation to create an Earth observation job.</p>

    Args:
        name: <p>The name of the Earth Observation job.</p>
        client_token: <p>A unique token that guarantees that the call to this API is idempotent.</p>
        kms_key_id: <p>The Key Management Service key ID for server-side encryption.</p>
        input_config: <p>Input configuration information for the Earth Observation job.</p>
        job_config: <p>An object containing information about the job configuration.</p>
        execution_role_arn: <p>The Amazon Resource Name (ARN) of the IAM role that you specified for the job.</p>
        tags: <p>Each tag consists of a key and a value.</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.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker_geospatial.types.start_earth_observation_job_input.StartEarthObservationJobInput]",
    ) -> OperationResponse[
        "capo_sagemaker_geospatial.types.start_earth_observation_job_output.StartEarthObservationJobOutput"
    ]:
        import capo_sagemaker_geospatial._operations.sage_maker_geospatial.start_earth_observation_job

        output, http_response = (
            capo_sagemaker_geospatial._operations.sage_maker_geospatial.start_earth_observation_job.start_earth_observation_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_sagemaker_geospatial.types.start_earth_observation_job_input.StartEarthObservationJobInput",
    ) -> dict[str, Any]:
        import capo_sagemaker_geospatial.types.start_earth_observation_job_input

        return capo_sagemaker_geospatial.types.start_earth_observation_job_input.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_sagemaker_geospatial.types.start_earth_observation_job_output.StartEarthObservationJobOutput",
    ) -> dict[str, Any]:
        import capo_sagemaker_geospatial.types.start_earth_observation_job_output

        return capo_sagemaker_geospatial.types.start_earth_observation_job_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "StartEarthObservationJob",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_sagemaker_geospatial.types.start_earth_observation_job_input.StartEarthObservationJobInput = {
        "name": name,
        "input_config": input_config,
        "job_config": job_config,
        "execution_role_arn": execution_role_arn,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if kms_key_id is not None:
        input_["kms_key_id"] = kms_key_id
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output