CodePipeline / Client / put_approval_result

put_approval_result#

CodePipeline.Client.put_approval_result(**kwargs)#

Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.

See also: AWS API Documentation

Request Syntax

response = client.put_approval_result(
    pipelineName='string',
    stageName='string',
    actionName='string',
    result={
        'summary': 'string',
        'status': 'Approved'|'Rejected'
    },
    token='string'
)
Parameters:

  • pipelineName (string) –

    [REQUIRED]

    The name of the pipeline that contains the action.

  • stageName (string) –

    [REQUIRED]

    The name of the stage that contains the action.

  • actionName (string) –

    [REQUIRED]

    The name of the action for which approval is requested.

  • result (dict) –

    [REQUIRED]

    Represents information about the result of the approval request.

    • summary (string) – [REQUIRED]

      The summary of the current status of the approval request.

    • status (string) – [REQUIRED]

      The response submitted by a reviewer assigned to an approval action request.

  • token (string) –

    [REQUIRED]

    The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval request corresponding to this token is still valid.

    Warning

    For a pipeline where the execution mode is set to PARALLEL, the token required to approve/reject approval request as detailed above is not available. Instead, use the externalExecutionId from the GetPipelineState action as the token in the approval request.

Return type:

dict

Returns:

Response Syntax

{
    'approvedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    Represents the output of a PutApprovalResult action.

    • approvedAt (datetime) –

      The timestamp showing when the approval or rejection was submitted.

Exceptions

  • CodePipeline.Client.exceptions.InvalidApprovalTokenException

  • CodePipeline.Client.exceptions.ApprovalAlreadyCompletedException

  • CodePipeline.Client.exceptions.PipelineNotFoundException

  • CodePipeline.Client.exceptions.StageNotFoundException

  • CodePipeline.Client.exceptions.ActionNotFoundException

  • CodePipeline.Client.exceptions.ValidationException