Skip to content

put_job_failure_result

put_job_failure_result(
    job_id: JobId,
    failure_details: FailureDetails,
    *,
    config_overrides: Optional[CodePipelineClientConfig] = None,
) -> None

Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.

Parameters:

  • job_id (JobId) –

    The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.

  • failure_details (FailureDetails) –

    The details about the failure of a job.

Raises:

Source code in docs_src/capo_codepipeline/_services/code_pipeline.py
def put_job_failure_result(
    self,
    job_id: "capo_codepipeline.types.job_id.JobId",
    failure_details: "capo_codepipeline.types.failure_details.FailureDetails",
    *,
    config_overrides: Optional[CodePipelineClientConfig] = None,
) -> None:
    """<p>Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.</p>

    Args:
        job_id: <p>The unique system-generated ID of the job that failed. This is the same ID returned from <code>PollForJobs</code>.</p>
        failure_details: <p>The details about the failure of a job.</p>

    Raises:
        capo_codepipeline.errors.invalid_job_state_exception.InvalidJobStateException: <p>The job state was specified in an invalid format.</p>
        capo_codepipeline.errors.job_not_found_exception.JobNotFoundException: <p>The job was specified in an invalid format or cannot be found.</p>
        capo_codepipeline.errors.validation_exception.ValidationException: <p>The validation was specified in an invalid format.</p>
        capo_codepipeline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codepipeline.types.put_job_failure_result_input.PutJobFailureResultInput]",
    ) -> OperationResponse[None]:
        import capo_codepipeline._operations.code_pipeline_20150709.put_job_failure_result

        output, http_response = (
            capo_codepipeline._operations.code_pipeline_20150709.put_job_failure_result.put_job_failure_result(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutJobFailureResult")
    )
    input_: capo_codepipeline.types.put_job_failure_result_input.PutJobFailureResultInput = {
        "job_id": job_id,
        "failure_details": failure_details,
    }

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