CodePipeline / Client / put_third_party_job_success_result

put_third_party_job_success_result#

CodePipeline.Client.put_third_party_job_success_result(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.put_third_party_job_success_result(
    jobId='string',
    clientToken='string',
    currentRevision={
        'revision': 'string',
        'changeIdentifier': 'string',
        'created': datetime(2015, 1, 1),
        'revisionSummary': 'string'
    },
    continuationToken='string',
    executionDetails={
        'summary': 'string',
        'externalExecutionId': 'string',
        'percentComplete': 123
    }
)
Parameters:

  • jobId (string) –

    [REQUIRED]

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

  • clientToken (string) –

    [REQUIRED]

    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.

  • currentRevision (dict) –

    Represents information about a current revision.

    • revision (string) – [REQUIRED]

      The revision ID of the current version of an artifact.

    • changeIdentifier (string) – [REQUIRED]

      The change identifier for the current revision.

    • created (datetime) –

      The date and time when the most recent revision of the artifact was created, in timestamp format.

    • revisionSummary (string) –

      The summary of the most recent revision of the artifact.

  • continuationToken (string) – A token generated by a job worker, such as an AWS 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.

  • executionDetails (dict) –

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

    • summary (string) –

      The summary of the current status of the actions.

    • externalExecutionId (string) –

      The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.

    • percentComplete (integer) –

      The percentage of work completed on the action, represented on a scale of 0 to 100 percent.

Returns:

None

Exceptions

  • CodePipeline.Client.exceptions.ValidationException

  • CodePipeline.Client.exceptions.JobNotFoundException

  • CodePipeline.Client.exceptions.InvalidJobStateException

  • CodePipeline.Client.exceptions.InvalidClientTokenException