AWS CodeCommit

2018/09/06 - AWS CodeCommit - 7 updated api methods

Changes  This release adds additional optional fields to the pull request APIs.

CreatePullRequest (updated) Link ¶
Changes (response) 
{'pullRequest': {'pullRequestTargets': {'mergeBase': 'string'}}}

Creates a pull request in the specified repository.

See also: AWS API Documentation

Request Syntax

client.create_pull_request(
    title='string',
    description='string',
    targets=[
        {
            'repositoryName': 'string',
            'sourceReference': 'string',
            'destinationReference': 'string'
        },
    ],
    clientRequestToken='string'
)
type title

string

param title

[REQUIRED]

The title of the pull request. This title will be used to identify the pull request to other users in the repository.

type description

string

param description

A description of the pull request.

type targets

list

param targets

[REQUIRED]

The targets for the pull request, including the source of the code to be reviewed (the source branch), and the destination where the creator of the pull request intends the code to be merged after the pull request is closed (the destination branch).

  • (dict) --

    Returns information about a target for a pull request.

    • repositoryName (string) -- [REQUIRED]

      The name of the repository that contains the pull request.

    • sourceReference (string) -- [REQUIRED]

      The branch of the repository that contains the changes for the pull request. Also known as the source branch.

    • destinationReference (string) --

      The branch of the repository where the pull request changes will be merged into. Also known as the destination branch.

type clientRequestToken

string

param clientRequestToken

A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.

Note

The AWS SDKs prepopulate client request tokens. If using an AWS SDK, you do not have to generate an idempotency token, as this will be done for you.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'pullRequest': {
        'pullRequestId': 'string',
        'title': 'string',
        'description': 'string',
        'lastActivityDate': datetime(2015, 1, 1),
        'creationDate': datetime(2015, 1, 1),
        'pullRequestStatus': 'OPEN'|'CLOSED',
        'authorArn': 'string',
        'pullRequestTargets': [
            {
                'repositoryName': 'string',
                'sourceReference': 'string',
                'destinationReference': 'string',
                'destinationCommit': 'string',
                'mergeBase': 'string',
                'sourceCommit': 'string',
                'mergeMetadata': {
                    'isMerged': True|False,
                    'mergedBy': 'string'
                }
            },
        ],
        'clientRequestToken': 'string'
    }
}

Response Structure

  • (dict) --

    • pullRequest (dict) --

      Information about the newly created pull request.

      • pullRequestId (string) --

        The system-generated ID of the pull request.

      • title (string) --

        The user-defined title of the pull request. This title is displayed in the list of pull requests to other users of the repository.

      • description (string) --

        The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.

      • lastActivityDate (datetime) --

        The day and time of the last user or system activity on the pull request, in timestamp format.

      • creationDate (datetime) --

        The date and time the pull request was originally created, in timestamp format.

      • pullRequestStatus (string) --

        The status of the pull request. Pull request status can only change from OPEN to CLOSED .

      • authorArn (string) --

        The Amazon Resource Name (ARN) of the user who created the pull request.

      • pullRequestTargets (list) --

        The targets of the pull request, including the source branch and destination branch for the pull request.

        • (dict) --

          Returns information about a pull request target.

          • repositoryName (string) --

            The name of the repository that contains the pull request source and destination branches.

          • sourceReference (string) --

            The branch of the repository that contains the changes for the pull request. Also known as the source branch.

          • destinationReference (string) --

            The branch of the repository where the pull request changes will be merged into. Also known as the destination branch.

          • destinationCommit (string) --

            The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.

          • mergeBase (string) --

            The commit ID of the most recent commit that the source branch and the destination branch have in common.

          • sourceCommit (string) --

            The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID will change to reflect the new tip of the branch.

          • mergeMetadata (dict) --

            Returns metadata about the state of the merge, including whether the merge has been made.

            • isMerged (boolean) --

              A Boolean value indicating whether the merge has been made.

            • mergedBy (string) --

              The Amazon Resource Name (ARN) of the user who merged the branches.

      • clientRequestToken (string) --

        A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.

DescribePullRequestEvents (updated) Link ¶
Changes (response) 
{'pullRequestEvents': {'pullRequestCreatedEventMetadata': {'destinationCommitId': 'string',
                                                           'mergeBase': 'string',
                                                           'repositoryName': 'string',
                                                           'sourceCommitId': 'string'},
                       'pullRequestSourceReferenceUpdatedEventMetadata': {'mergeBase': 'string'}}}

Returns information about one or more pull request events.

See also: AWS API Documentation

Request Syntax

client.describe_pull_request_events(
    pullRequestId='string',
    pullRequestEventType='PULL_REQUEST_CREATED'|'PULL_REQUEST_STATUS_CHANGED'|'PULL_REQUEST_SOURCE_REFERENCE_UPDATED'|'PULL_REQUEST_MERGE_STATE_CHANGED',
    actorArn='string',
    nextToken='string',
    maxResults=123
)
type pullRequestId

string

param pullRequestId

[REQUIRED]

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

type pullRequestEventType

string

param pullRequestEventType

Optional. The pull request event type about which you want to return information.

type actorArn

string

param actorArn

The Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the pull request with additional commits or changing the status of a pull request.

type nextToken

string

param nextToken

An enumeration token that when provided in a request, returns the next batch of the results.

type maxResults

integer

param maxResults

A non-negative integer used to limit the number of returned results. The default is 100 events, which is also the maximum number of events that can be returned in a result.

rtype

dict

returns

Response Syntax

{
    'pullRequestEvents': [
        {
            'pullRequestId': 'string',
            'eventDate': datetime(2015, 1, 1),
            'pullRequestEventType': 'PULL_REQUEST_CREATED'|'PULL_REQUEST_STATUS_CHANGED'|'PULL_REQUEST_SOURCE_REFERENCE_UPDATED'|'PULL_REQUEST_MERGE_STATE_CHANGED',
            'actorArn': 'string',
            'pullRequestCreatedEventMetadata': {
                'repositoryName': 'string',
                'sourceCommitId': 'string',
                'destinationCommitId': 'string',
                'mergeBase': 'string'
            },
            'pullRequestStatusChangedEventMetadata': {
                'pullRequestStatus': 'OPEN'|'CLOSED'
            },
            'pullRequestSourceReferenceUpdatedEventMetadata': {
                'repositoryName': 'string',
                'beforeCommitId': 'string',
                'afterCommitId': 'string',
                'mergeBase': 'string'
            },
            'pullRequestMergedStateChangedEventMetadata': {
                'repositoryName': 'string',
                'destinationReference': 'string',
                'mergeMetadata': {
                    'isMerged': True|False,
                    'mergedBy': 'string'
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • pullRequestEvents (list) --

      Information about the pull request events.

      • (dict) --

        Returns information about a pull request event.

        • pullRequestId (string) --

          The system-generated ID of the pull request.

        • eventDate (datetime) --

          The day and time of the pull request event, in timestamp format.

        • pullRequestEventType (string) --

          The type of the pull request event, for example a status change event (PULL_REQUEST_STATUS_CHANGED) or update event (PULL_REQUEST_SOURCE_REFERENCE_UPDATED).

        • actorArn (string) --

          The Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the pull request with additional commits or changing the status of a pull request.

        • pullRequestCreatedEventMetadata (dict) --

          Information about the source and destination branches for the pull request.

          • repositoryName (string) --

            The name of the repository where the pull request was created.

          • sourceCommitId (string) --

            The commit ID on the source branch used when the pull request was created.

          • destinationCommitId (string) --

            The commit ID of the tip of the branch specified as the destination branch when the pull request was created.

          • mergeBase (string) --

            The commit ID of the most recent commit that the source branch and the destination branch have in common.

        • pullRequestStatusChangedEventMetadata (dict) --

          Information about the change in status for the pull request event.

          • pullRequestStatus (string) --

            The changed status of the pull request.

        • pullRequestSourceReferenceUpdatedEventMetadata (dict) --

          Information about the updated source branch for the pull request event.

          • repositoryName (string) --

            The name of the repository where the pull request was updated.

          • beforeCommitId (string) --

            The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was updated.

          • afterCommitId (string) --

            The full commit ID of the commit in the source branch that was the tip of the branch at the time the pull request was updated.

          • mergeBase (string) --

            The commit ID of the most recent commit that the source branch and the destination branch have in common.

        • pullRequestMergedStateChangedEventMetadata (dict) --

          Information about the change in mergability state for the pull request event.

          • repositoryName (string) --

            The name of the repository where the pull request was created.

          • destinationReference (string) --

            The name of the branch that the pull request will be merged into.

          • mergeMetadata (dict) --

            Information about the merge state change event.

            • isMerged (boolean) --

              A Boolean value indicating whether the merge has been made.

            • mergedBy (string) --

              The Amazon Resource Name (ARN) of the user who merged the branches.

    • nextToken (string) --

      An enumeration token that can be used in a request to return the next batch of the results.

GetPullRequest (updated) Link ¶
Changes (response) 
{'pullRequest': {'pullRequestTargets': {'mergeBase': 'string'}}}

Gets information about a pull request in a specified repository.

See also: AWS API Documentation

Request Syntax

client.get_pull_request(
    pullRequestId='string'
)
type pullRequestId

string

param pullRequestId

[REQUIRED]

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

rtype

dict

returns

Response Syntax

{
    'pullRequest': {
        'pullRequestId': 'string',
        'title': 'string',
        'description': 'string',
        'lastActivityDate': datetime(2015, 1, 1),
        'creationDate': datetime(2015, 1, 1),
        'pullRequestStatus': 'OPEN'|'CLOSED',
        'authorArn': 'string',
        'pullRequestTargets': [
            {
                'repositoryName': 'string',
                'sourceReference': 'string',
                'destinationReference': 'string',
                'destinationCommit': 'string',
                'mergeBase': 'string',
                'sourceCommit': 'string',
                'mergeMetadata': {
                    'isMerged': True|False,
                    'mergedBy': 'string'
                }
            },
        ],
        'clientRequestToken': 'string'
    }
}

Response Structure

  • (dict) --

    • pullRequest (dict) --

      Information about the specified pull request.

      • pullRequestId (string) --

        The system-generated ID of the pull request.

      • title (string) --

        The user-defined title of the pull request. This title is displayed in the list of pull requests to other users of the repository.

      • description (string) --

        The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.

      • lastActivityDate (datetime) --

        The day and time of the last user or system activity on the pull request, in timestamp format.

      • creationDate (datetime) --

        The date and time the pull request was originally created, in timestamp format.

      • pullRequestStatus (string) --

        The status of the pull request. Pull request status can only change from OPEN to CLOSED .

      • authorArn (string) --

        The Amazon Resource Name (ARN) of the user who created the pull request.

      • pullRequestTargets (list) --

        The targets of the pull request, including the source branch and destination branch for the pull request.

        • (dict) --

          Returns information about a pull request target.

          • repositoryName (string) --

            The name of the repository that contains the pull request source and destination branches.

          • sourceReference (string) --

            The branch of the repository that contains the changes for the pull request. Also known as the source branch.

          • destinationReference (string) --

            The branch of the repository where the pull request changes will be merged into. Also known as the destination branch.

          • destinationCommit (string) --

            The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.

          • mergeBase (string) --

            The commit ID of the most recent commit that the source branch and the destination branch have in common.

          • sourceCommit (string) --

            The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID will change to reflect the new tip of the branch.

          • mergeMetadata (dict) --

            Returns metadata about the state of the merge, including whether the merge has been made.

            • isMerged (boolean) --

              A Boolean value indicating whether the merge has been made.

            • mergedBy (string) --

              The Amazon Resource Name (ARN) of the user who merged the branches.

      • clientRequestToken (string) --

        A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.

MergePullRequestByFastForward (updated) Link ¶
Changes (response) 
{'pullRequest': {'pullRequestTargets': {'mergeBase': 'string'}}}

Closes a pull request and attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the fast-forward merge option.

See also: AWS API Documentation

Request Syntax

client.merge_pull_request_by_fast_forward(
    pullRequestId='string',
    repositoryName='string',
    sourceCommitId='string'
)
type pullRequestId

string

param pullRequestId

[REQUIRED]

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

type repositoryName

string

param repositoryName

[REQUIRED]

The name of the repository where the pull request was created.

type sourceCommitId

string

param sourceCommitId

The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.

rtype

dict

returns

Response Syntax

{
    'pullRequest': {
        'pullRequestId': 'string',
        'title': 'string',
        'description': 'string',
        'lastActivityDate': datetime(2015, 1, 1),
        'creationDate': datetime(2015, 1, 1),
        'pullRequestStatus': 'OPEN'|'CLOSED',
        'authorArn': 'string',
        'pullRequestTargets': [
            {
                'repositoryName': 'string',
                'sourceReference': 'string',
                'destinationReference': 'string',
                'destinationCommit': 'string',
                'mergeBase': 'string',
                'sourceCommit': 'string',
                'mergeMetadata': {
                    'isMerged': True|False,
                    'mergedBy': 'string'
                }
            },
        ],
        'clientRequestToken': 'string'
    }
}

Response Structure

  • (dict) --

    • pullRequest (dict) --

      Information about the specified pull request, including information about the merge.

      • pullRequestId (string) --

        The system-generated ID of the pull request.

      • title (string) --

        The user-defined title of the pull request. This title is displayed in the list of pull requests to other users of the repository.

      • description (string) --

        The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.

      • lastActivityDate (datetime) --

        The day and time of the last user or system activity on the pull request, in timestamp format.

      • creationDate (datetime) --

        The date and time the pull request was originally created, in timestamp format.

      • pullRequestStatus (string) --

        The status of the pull request. Pull request status can only change from OPEN to CLOSED .

      • authorArn (string) --

        The Amazon Resource Name (ARN) of the user who created the pull request.

      • pullRequestTargets (list) --

        The targets of the pull request, including the source branch and destination branch for the pull request.

        • (dict) --

          Returns information about a pull request target.

          • repositoryName (string) --

            The name of the repository that contains the pull request source and destination branches.

          • sourceReference (string) --

            The branch of the repository that contains the changes for the pull request. Also known as the source branch.

          • destinationReference (string) --

            The branch of the repository where the pull request changes will be merged into. Also known as the destination branch.

          • destinationCommit (string) --

            The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.

          • mergeBase (string) --

            The commit ID of the most recent commit that the source branch and the destination branch have in common.

          • sourceCommit (string) --

            The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID will change to reflect the new tip of the branch.

          • mergeMetadata (dict) --

            Returns metadata about the state of the merge, including whether the merge has been made.

            • isMerged (boolean) --

              A Boolean value indicating whether the merge has been made.

            • mergedBy (string) --

              The Amazon Resource Name (ARN) of the user who merged the branches.

      • clientRequestToken (string) --

        A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.

UpdatePullRequestDescription (updated) Link ¶
Changes (response) 
{'pullRequest': {'pullRequestTargets': {'mergeBase': 'string'}}}

Replaces the contents of the description of a pull request.

See also: AWS API Documentation

Request Syntax

client.update_pull_request_description(
    pullRequestId='string',
    description='string'
)
type pullRequestId

string

param pullRequestId

[REQUIRED]

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

type description

string

param description

[REQUIRED]

The updated content of the description for the pull request. This content will replace the existing description.

rtype

dict

returns

Response Syntax

{
    'pullRequest': {
        'pullRequestId': 'string',
        'title': 'string',
        'description': 'string',
        'lastActivityDate': datetime(2015, 1, 1),
        'creationDate': datetime(2015, 1, 1),
        'pullRequestStatus': 'OPEN'|'CLOSED',
        'authorArn': 'string',
        'pullRequestTargets': [
            {
                'repositoryName': 'string',
                'sourceReference': 'string',
                'destinationReference': 'string',
                'destinationCommit': 'string',
                'mergeBase': 'string',
                'sourceCommit': 'string',
                'mergeMetadata': {
                    'isMerged': True|False,
                    'mergedBy': 'string'
                }
            },
        ],
        'clientRequestToken': 'string'
    }
}

Response Structure

  • (dict) --

    • pullRequest (dict) --

      Information about the updated pull request.

      • pullRequestId (string) --

        The system-generated ID of the pull request.

      • title (string) --

        The user-defined title of the pull request. This title is displayed in the list of pull requests to other users of the repository.

      • description (string) --

        The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.

      • lastActivityDate (datetime) --

        The day and time of the last user or system activity on the pull request, in timestamp format.

      • creationDate (datetime) --

        The date and time the pull request was originally created, in timestamp format.

      • pullRequestStatus (string) --

        The status of the pull request. Pull request status can only change from OPEN to CLOSED .

      • authorArn (string) --

        The Amazon Resource Name (ARN) of the user who created the pull request.

      • pullRequestTargets (list) --

        The targets of the pull request, including the source branch and destination branch for the pull request.

        • (dict) --

          Returns information about a pull request target.

          • repositoryName (string) --

            The name of the repository that contains the pull request source and destination branches.

          • sourceReference (string) --

            The branch of the repository that contains the changes for the pull request. Also known as the source branch.

          • destinationReference (string) --

            The branch of the repository where the pull request changes will be merged into. Also known as the destination branch.

          • destinationCommit (string) --

            The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.

          • mergeBase (string) --

            The commit ID of the most recent commit that the source branch and the destination branch have in common.

          • sourceCommit (string) --

            The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID will change to reflect the new tip of the branch.

          • mergeMetadata (dict) --

            Returns metadata about the state of the merge, including whether the merge has been made.

            • isMerged (boolean) --

              A Boolean value indicating whether the merge has been made.

            • mergedBy (string) --

              The Amazon Resource Name (ARN) of the user who merged the branches.

      • clientRequestToken (string) --

        A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.

UpdatePullRequestStatus (updated) Link ¶
Changes (response) 
{'pullRequest': {'pullRequestTargets': {'mergeBase': 'string'}}}

Updates the status of a pull request.

See also: AWS API Documentation

Request Syntax

client.update_pull_request_status(
    pullRequestId='string',
    pullRequestStatus='OPEN'|'CLOSED'
)
type pullRequestId

string

param pullRequestId

[REQUIRED]

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

type pullRequestStatus

string

param pullRequestStatus

[REQUIRED]

The status of the pull request. The only valid operations are to update the status from OPEN to OPEN , OPEN to CLOSED or from from CLOSED to CLOSED .

rtype

dict

returns

Response Syntax

{
    'pullRequest': {
        'pullRequestId': 'string',
        'title': 'string',
        'description': 'string',
        'lastActivityDate': datetime(2015, 1, 1),
        'creationDate': datetime(2015, 1, 1),
        'pullRequestStatus': 'OPEN'|'CLOSED',
        'authorArn': 'string',
        'pullRequestTargets': [
            {
                'repositoryName': 'string',
                'sourceReference': 'string',
                'destinationReference': 'string',
                'destinationCommit': 'string',
                'mergeBase': 'string',
                'sourceCommit': 'string',
                'mergeMetadata': {
                    'isMerged': True|False,
                    'mergedBy': 'string'
                }
            },
        ],
        'clientRequestToken': 'string'
    }
}

Response Structure

  • (dict) --

    • pullRequest (dict) --

      Information about the pull request.

      • pullRequestId (string) --

        The system-generated ID of the pull request.

      • title (string) --

        The user-defined title of the pull request. This title is displayed in the list of pull requests to other users of the repository.

      • description (string) --

        The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.

      • lastActivityDate (datetime) --

        The day and time of the last user or system activity on the pull request, in timestamp format.

      • creationDate (datetime) --

        The date and time the pull request was originally created, in timestamp format.

      • pullRequestStatus (string) --

        The status of the pull request. Pull request status can only change from OPEN to CLOSED .

      • authorArn (string) --

        The Amazon Resource Name (ARN) of the user who created the pull request.

      • pullRequestTargets (list) --

        The targets of the pull request, including the source branch and destination branch for the pull request.

        • (dict) --

          Returns information about a pull request target.

          • repositoryName (string) --

            The name of the repository that contains the pull request source and destination branches.

          • sourceReference (string) --

            The branch of the repository that contains the changes for the pull request. Also known as the source branch.

          • destinationReference (string) --

            The branch of the repository where the pull request changes will be merged into. Also known as the destination branch.

          • destinationCommit (string) --

            The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.

          • mergeBase (string) --

            The commit ID of the most recent commit that the source branch and the destination branch have in common.

          • sourceCommit (string) --

            The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID will change to reflect the new tip of the branch.

          • mergeMetadata (dict) --

            Returns metadata about the state of the merge, including whether the merge has been made.

            • isMerged (boolean) --

              A Boolean value indicating whether the merge has been made.

            • mergedBy (string) --

              The Amazon Resource Name (ARN) of the user who merged the branches.

      • clientRequestToken (string) --

        A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.

UpdatePullRequestTitle (updated) Link ¶
Changes (response) 
{'pullRequest': {'pullRequestTargets': {'mergeBase': 'string'}}}

Replaces the title of a pull request.

See also: AWS API Documentation

Request Syntax

client.update_pull_request_title(
    pullRequestId='string',
    title='string'
)
type pullRequestId

string

param pullRequestId

[REQUIRED]

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

type title

string

param title

[REQUIRED]

The updated title of the pull request. This will replace the existing title.

rtype

dict

returns

Response Syntax

{
    'pullRequest': {
        'pullRequestId': 'string',
        'title': 'string',
        'description': 'string',
        'lastActivityDate': datetime(2015, 1, 1),
        'creationDate': datetime(2015, 1, 1),
        'pullRequestStatus': 'OPEN'|'CLOSED',
        'authorArn': 'string',
        'pullRequestTargets': [
            {
                'repositoryName': 'string',
                'sourceReference': 'string',
                'destinationReference': 'string',
                'destinationCommit': 'string',
                'mergeBase': 'string',
                'sourceCommit': 'string',
                'mergeMetadata': {
                    'isMerged': True|False,
                    'mergedBy': 'string'
                }
            },
        ],
        'clientRequestToken': 'string'
    }
}

Response Structure

  • (dict) --

    • pullRequest (dict) --

      Information about the updated pull request.

      • pullRequestId (string) --

        The system-generated ID of the pull request.

      • title (string) --

        The user-defined title of the pull request. This title is displayed in the list of pull requests to other users of the repository.

      • description (string) --

        The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.

      • lastActivityDate (datetime) --

        The day and time of the last user or system activity on the pull request, in timestamp format.

      • creationDate (datetime) --

        The date and time the pull request was originally created, in timestamp format.

      • pullRequestStatus (string) --

        The status of the pull request. Pull request status can only change from OPEN to CLOSED .

      • authorArn (string) --

        The Amazon Resource Name (ARN) of the user who created the pull request.

      • pullRequestTargets (list) --

        The targets of the pull request, including the source branch and destination branch for the pull request.

        • (dict) --

          Returns information about a pull request target.

          • repositoryName (string) --

            The name of the repository that contains the pull request source and destination branches.

          • sourceReference (string) --

            The branch of the repository that contains the changes for the pull request. Also known as the source branch.

          • destinationReference (string) --

            The branch of the repository where the pull request changes will be merged into. Also known as the destination branch.

          • destinationCommit (string) --

            The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.

          • mergeBase (string) --

            The commit ID of the most recent commit that the source branch and the destination branch have in common.

          • sourceCommit (string) --

            The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID will change to reflect the new tip of the branch.

          • mergeMetadata (dict) --

            Returns metadata about the state of the merge, including whether the merge has been made.

            • isMerged (boolean) --

              A Boolean value indicating whether the merge has been made.

            • mergedBy (string) --

              The Amazon Resource Name (ARN) of the user who merged the branches.

      • clientRequestToken (string) --

        A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.