Skip to content

get_job_details

get_job_details(
    job_id: JobId, *, config_overrides: Optional[CodePipelineClientConfig] = None
) -> GetJobDetailsOutput

Returns information about a job. Used for custom 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 (JobId) –

    The unique system-generated ID for the job.

Raises:

Source code in docs_src/capo_codepipeline/_services/code_pipeline.py
def get_job_details(
    self,
    job_id: "capo_codepipeline.types.job_id.JobId",
    *,
    config_overrides: Optional[CodePipelineClientConfig] = None,
) -> "capo_codepipeline.types.get_job_details_output.GetJobDetailsOutput":
    """<p>Returns information about a job. Used for custom 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 for the job.</p>

    Raises:
        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.
    """

    def _handler(
        req: "OperationRequest[capo_codepipeline.types.get_job_details_input.GetJobDetailsInput]",
    ) -> OperationResponse[
        "capo_codepipeline.types.get_job_details_output.GetJobDetailsOutput"
    ]:
        import capo_codepipeline._operations.code_pipeline_20150709.get_job_details

        output, http_response = (
            capo_codepipeline._operations.code_pipeline_20150709.get_job_details.get_job_details(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

        return capo_codepipeline.types.get_job_details_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetJobDetails", redact_output=_redact_output),
    )
    input_: capo_codepipeline.types.get_job_details_input.GetJobDetailsInput = {
        "job_id": job_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output