CodePipeline / Client / put_job_failure_result

put_job_failure_result#

CodePipeline.Client.put_job_failure_result(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.put_job_failure_result(
    jobId='string',
    failureDetails={
        'type': 'JobFailed'|'ConfigurationError'|'PermissionError'|'RevisionOutOfSync'|'RevisionUnavailable'|'SystemUnavailable',
        'message': 'string',
        'externalExecutionId': 'string'
    }
)
Parameters:

  • jobId (string) –

    [REQUIRED]

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

  • failureDetails (dict) –

    [REQUIRED]

    The details about the failure of a job.

    • type (string) – [REQUIRED]

      The type of the failure.

    • message (string) – [REQUIRED]

      The message about the failure.

    • externalExecutionId (string) –

      The external ID of the run of the action that failed.

Returns:

None

Exceptions