Skip to content

get_third_party_job_details async

get_third_party_job_details(
    job_id: ThirdPartyJobId,
    client_token: ClientToken,
    *,
    config_overrides: Optional[AsyncCodePipelineClientConfig] = None,
) -> GetThirdPartyJobDetailsOutput

Requests the details of a job for a third party action. Used for partner actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

Parameters:

  • job_id (ThirdPartyJobId) –

    The unique system-generated ID used for identifying the job.

  • 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 get_third_party_job_details(
    self,
    job_id: "capo_codepipeline.types.third_party_job_id.ThirdPartyJobId",
    client_token: "capo_codepipeline.types.client_token.ClientToken",
    *,
    config_overrides: Optional[AsyncCodePipelineClientConfig] = None,
) -> "capo_codepipeline.types.get_third_party_job_details_output.GetThirdPartyJobDetailsOutput":
    """<p>Requests the details of a job for a third party action. Used for partner actions only.</p> <important> <p>When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.</p> </important>

    Args:
        job_id: <p>The unique system-generated ID used for identifying the job.</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_job_exception.InvalidJobException: <p>The job was specified in an invalid format or cannot be found.</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.get_third_party_job_details_input.GetThirdPartyJobDetailsInput]",
    ) -> AsyncOperationResponse[
        "capo_codepipeline.types.get_third_party_job_details_output.GetThirdPartyJobDetailsOutput"
    ]:
        import capo_codepipeline._operations.code_pipeline_20150709.get_third_party_job_details

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

    def _redact_output(
        output: "capo_codepipeline.types.get_third_party_job_details_output.GetThirdPartyJobDetailsOutput",
    ) -> dict[str, Any]:
        import capo_codepipeline.types.get_third_party_job_details_output

        return capo_codepipeline.types.get_third_party_job_details_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetThirdPartyJobDetails", redact_output=_redact_output),
    )
    input_: capo_codepipeline.types.get_third_party_job_details_input.GetThirdPartyJobDetailsInput = {
        "job_id": job_id,
        "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