Skip to content

acknowledge_third_party_job async

acknowledge_third_party_job(
    job_id: ThirdPartyJobId,
    nonce: Nonce,
    client_token: ClientToken,
    *,
    config_overrides: Optional[AsyncCodePipelineClientConfig] = None,
) -> AcknowledgeThirdPartyJobOutput

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

Parameters:

  • job_id (ThirdPartyJobId) –

    The unique system-generated ID of the job.

  • nonce (Nonce) –

    A system-generated random number that 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.

  • client_token (ClientToken) –

    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.

Raises:

Source code in docs_src/capo_codepipeline/_services/async_code_pipeline.py
async def acknowledge_third_party_job(
    self,
    job_id: "capo_codepipeline.types.third_party_job_id.ThirdPartyJobId",
    nonce: "capo_codepipeline.types.nonce.Nonce",
    client_token: "capo_codepipeline.types.client_token.ClientToken",
    *,
    config_overrides: Optional[AsyncCodePipelineClientConfig] = None,
) -> "capo_codepipeline.types.acknowledge_third_party_job_output.AcknowledgeThirdPartyJobOutput":
    """<p>Confirms a job worker has received the specified job. Used for partner actions only.</p>

    Args:
        job_id: <p>The unique system-generated ID of the job.</p>
        nonce: <p>A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a <a>GetThirdPartyJobDetails</a> request.</p>
        client_token: <p>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.</p>

    Raises:
        capo_codepipeline.errors.invalid_client_token_exception.InvalidClientTokenException: <p>The client token was specified in an invalid format</p>
        capo_codepipeline.errors.invalid_nonce_exception.InvalidNonceException: <p>The nonce 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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codepipeline.types.acknowledge_third_party_job_input.AcknowledgeThirdPartyJobInput]",
    ) -> AsyncOperationResponse[
        "capo_codepipeline.types.acknowledge_third_party_job_output.AcknowledgeThirdPartyJobOutput"
    ]:
        import capo_codepipeline._operations.code_pipeline_20150709.acknowledge_third_party_job

        (
            output,
            http_response,
        ) = await capo_codepipeline._operations.code_pipeline_20150709.acknowledge_third_party_job.async_acknowledge_third_party_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AcknowledgeThirdPartyJob")
    )
    input_: capo_codepipeline.types.acknowledge_third_party_job_input.AcknowledgeThirdPartyJobInput = {
        "job_id": job_id,
        "nonce": nonce,
        "client_token": client_token,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output