CodePipeline / Client / acknowledge_third_party_job

acknowledge_third_party_job#

CodePipeline.Client.acknowledge_third_party_job(**kwargs)#

Confirms a job worker has received the specified job. Used for partner actions only.

See also: AWS API Documentation

Request Syntax

response = client.acknowledge_third_party_job(
    jobId='string',
    nonce='string',
    clientToken='string'
)
Parameters:
  • jobId (string) –

    [REQUIRED]

    The unique system-generated ID of the job.

  • 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 to a GetThirdPartyJobDetails request.

  • clientToken (string) –

    [REQUIRED]

    The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    Represents the output of an AcknowledgeThirdPartyJob action.

    • status (string) –

      The status information for the third party job, if any.

Exceptions

  • CodePipeline.Client.exceptions.ValidationException

  • CodePipeline.Client.exceptions.InvalidNonceException

  • CodePipeline.Client.exceptions.JobNotFoundException

  • CodePipeline.Client.exceptions.InvalidClientTokenException