CodePipeline / Client / acknowledge_job

acknowledge_job#

CodePipeline.Client.acknowledge_job(**kwargs)#

Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.

See also: AWS API Documentation

Request Syntax

response = client.acknowledge_job(
    jobId='string',
    nonce='string'
)
Parameters:

  • jobId (string) –

    [REQUIRED]

    The unique system-generated ID of the job for which you want to confirm receipt.

  • nonce (string) –

    [REQUIRED]

    A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'Created'|'Queued'|'Dispatched'|'InProgress'|'TimedOut'|'Succeeded'|'Failed'
}

Response Structure

  • (dict) –

    Represents the output of an AcknowledgeJob action.

    • status (string) –

      Whether the job worker has received the specified job.

Exceptions

  • CodePipeline.Client.exceptions.ValidationException

  • CodePipeline.Client.exceptions.InvalidNonceException

  • CodePipeline.Client.exceptions.JobNotFoundException