CodeCommit / Client / get_pull_request_override_state

get_pull_request_override_state#

CodeCommit.Client.get_pull_request_override_state(**kwargs)#

Returns information about whether approval rules have been set aside (overridden) for a pull request, and if so, the Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request.

See also: AWS API Documentation

Request Syntax

response = client.get_pull_request_override_state(
    pullRequestId='string',
    revisionId='string'
)
Parameters:
  • pullRequestId (string) –

    [REQUIRED]

    The ID of the pull request for which you want to get information about whether approval rules have been set aside (overridden).

  • revisionId (string) –

    [REQUIRED]

    The system-generated ID of the revision for the pull request. To retrieve the most recent revision ID, use GetPullRequest.

Return type:

dict

Returns:

Response Syntax

{
    'overridden': True|False,
    'overrider': 'string'
}

Response Structure

  • (dict) –

    • overridden (boolean) –

      A Boolean value that indicates whether a pull request has had its rules set aside (TRUE) or whether all approval rules still apply (FALSE).

    • overrider (string) –

      The Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request.

Exceptions

  • CodeCommit.Client.exceptions.PullRequestDoesNotExistException

  • CodeCommit.Client.exceptions.InvalidPullRequestIdException

  • CodeCommit.Client.exceptions.PullRequestIdRequiredException

  • CodeCommit.Client.exceptions.InvalidRevisionIdException

  • CodeCommit.Client.exceptions.RevisionIdRequiredException

  • CodeCommit.Client.exceptions.EncryptionIntegrityChecksFailedException

  • CodeCommit.Client.exceptions.EncryptionKeyAccessDeniedException

  • CodeCommit.Client.exceptions.EncryptionKeyDisabledException

  • CodeCommit.Client.exceptions.EncryptionKeyNotFoundException

  • CodeCommit.Client.exceptions.EncryptionKeyUnavailableException