Skip to content

put_third_party_job_success_result

put_third_party_job_success_result(
    job_id: ThirdPartyJobId,
    client_token: ClientToken,
    *,
    config_overrides: Optional[CodePipelineClientConfig] = None,
    current_revision: Optional[CurrentRevision] = None,
    continuation_token: Optional[ContinuationToken] = None,
    execution_details: Optional[ExecutionDetails] = None,
) -> None

Represents the success 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 successfully completed. 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.

  • current_revision (Optional[CurrentRevision], default: None ) –

    Represents information about a current revision.

  • continuation_token (Optional[ContinuationToken], default: None ) –

    A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the partner action. When the action is complete, no continuation token should be supplied.

  • execution_details (Optional[ExecutionDetails], default: None ) –

    The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.

Raises:

Source code in docs_src/capo_codepipeline/_services/code_pipeline.py
def put_third_party_job_success_result(
    self,
    job_id: "capo_codepipeline.types.third_party_job_id.ThirdPartyJobId",
    client_token: "capo_codepipeline.types.client_token.ClientToken",
    *,
    config_overrides: Optional[CodePipelineClientConfig] = None,
    current_revision: Optional[
        "capo_codepipeline.types.current_revision.CurrentRevision"
    ] = None,
    continuation_token: Optional[
        "capo_codepipeline.types.continuation_token.ContinuationToken"
    ] = None,
    execution_details: Optional[
        "capo_codepipeline.types.execution_details.ExecutionDetails"
    ] = None,
) -> None:
    """<p>Represents the success 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 successfully completed. 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>
        current_revision: <p>Represents information about a current revision.</p>
        continuation_token: <p>A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the partner action. When the action is complete, no continuation token should be supplied.</p>
        execution_details: <p>The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline. </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_success_result_input.PutThirdPartyJobSuccessResultInput]",
    ) -> OperationResponse[None]:
        import capo_codepipeline._operations.code_pipeline_20150709.put_third_party_job_success_result

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutThirdPartyJobSuccessResult")
    )
    input_: capo_codepipeline.types.put_third_party_job_success_result_input.PutThirdPartyJobSuccessResultInput = {
        "job_id": job_id,
        "client_token": client_token,
    }
    if current_revision is not None:
        input_["current_revision"] = current_revision
    if continuation_token is not None:
        input_["continuation_token"] = continuation_token
    if execution_details is not None:
        input_["execution_details"] = execution_details

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