Skip to content

put_third_party_job_failure_result 

put_third_party_job_failure_result(
    job_id: ThirdPartyJobId,
    client_token: ClientToken,
    failure_details: FailureDetails,
    *,
    config_overrides: Optional[CodePipelineClientConfig] = None,
) -> None

Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.

Parameters:

  • job_id (ThirdPartyJobId) –

    The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.

  • 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.

  • failure_details (FailureDetails) –

    Represents information about failure details.

Raises:

Source code in docs_src/capo_codepipeline/_services/code_pipeline.py 
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
def put_third_party_job_failure_result(
    self,
    job_id: "capo_codepipeline.types.third_party_job_id.ThirdPartyJobId",
    client_token: "capo_codepipeline.types.client_token.ClientToken",
    failure_details: "capo_codepipeline.types.failure_details.FailureDetails",
    *,
    config_overrides: Optional[CodePipelineClientConfig] = None,
) -> None:
    """<p>Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.</p>

    Args:
        job_id: <p>The ID of the job that failed. This is the same ID returned from <code>PollForThirdPartyJobs</code>.</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>
        failure_details: <p>Represents information about failure 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_state_exception.InvalidJobStateException: <p>The job state 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.
    """

    def _handler(
        req: "OperationRequest[capo_codepipeline.types.put_third_party_job_failure_result_input.PutThirdPartyJobFailureResultInput]",
    ) -> OperationResponse[None]:
        import capo_codepipeline._operations.code_pipeline_20150709.put_third_party_job_failure_result

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutThirdPartyJobFailureResult")
    )
    input_: capo_codepipeline.types.put_third_party_job_failure_result_input.PutThirdPartyJobFailureResultInput = {
        "job_id": job_id,
        "client_token": client_token,
        "failure_details": failure_details,
    }

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