CodePipeline / Client / put_job_success_result

put_job_success_result#

CodePipeline.Client.put_job_success_result(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • jobId (string) –

    [REQUIRED]

    The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

  • currentRevision (dict) –

    The ID of the current revision of the artifact successfully worked on by the job.

    • 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 custom 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 custom action. When the action is complete, no continuation token should be supplied.

  • executionDetails (dict) –

    The execution details of the successful job, such as the actions taken by the job worker.

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

  • outputVariables (dict) –

    Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration. outputVariables can be included only when there is no continuation token on the request.

    • (string) –

      • (string) –

Returns:

None

Exceptions

  • CodePipeline.Client.exceptions.ValidationException

  • CodePipeline.Client.exceptions.JobNotFoundException

  • CodePipeline.Client.exceptions.InvalidJobStateException

  • CodePipeline.Client.exceptions.OutputVariablesSizeExceededException