AWS CLI Command Reference

[ aws . codecommit ]

update-pull-request-title

Description

Replaces the title of a pull request.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-pull-request-title
--pull-request-id <value>
--title <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--pull-request-id (string)

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

--title (string)

The updated title of the pull request. This replaces the existing title.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To change the title of a pull request

This example demonstrates how to change the title of a pull request with the ID of 47.

aws codecommit update-pull-request-title \
    --pull-request-id 47 \
    --title "Consolidation of global variables - updated review"

Output:

{
    "pullRequest": {
        "approvalRules": [
            {
                "approvalRuleContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
                "approvalRuleId": "dd8b17fe-EXAMPLE",
                "approvalRuleName": "2-approver-rule-for-main",
                "creationDate": 1571356106.936,
                "lastModifiedDate": 571356106.936,
                "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
                "originApprovalRuleTemplate": {
                    "approvalRuleTemplateId": "dd8b26gr-EXAMPLE",
                    "approvalRuleTemplateName": "2-approver-rule-for-main"
                },
                "ruleContentSha256": "4711b576EXAMPLE"
            }
        ],
        "authorArn": "arn:aws:iam::123456789012:user/Li_Juan",
        "clientRequestToken": "",
        "creationDate": 1508530823.12,
        "description": "Review the latest changes and updates to the global variables. I have updated this request with some changes, including removing some unused variables.",
        "lastActivityDate": 1508372657.188,
        "pullRequestId": "47",
        "pullRequestStatus": "OPEN",
        "pullRequestTargets": [
            {
                "destinationCommit": "9f31c968EXAMPLE",
                "destinationReference": "refs/heads/main",
                "mergeMetadata": {
                    "isMerged": false,
                },
                "repositoryName": "MyDemoRepo",
                "sourceCommit": "99132ab0EXAMPLE",
                "sourceReference": "refs/heads/variables-branch"
            }
        ],
        "title": "Consolidation of global variables - updated review"
    }
}

Output

pullRequest -> (structure)

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 repository users.

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 -> (timestamp)

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

creationDate -> (timestamp)

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.

(structure)

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 are merged. 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.

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 changes to reflect the new tip of the branch.

mergeBase -> (string)

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

mergeMetadata -> (structure)

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.

mergeCommitId -> (string)

The commit ID for the merge commit, if any.

mergeOption -> (string)

The merge strategy used in the merge.

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 returns information about the initial request that used that token.

revisionId -> (string)

The system-generated revision ID for the pull request.

approvalRules -> (list)

The approval rules applied to the pull request.

(structure)

Returns information about an approval rule.

approvalRuleId -> (string)

The system-generated ID of the approval rule.

approvalRuleName -> (string)

The name of the approval rule.

approvalRuleContent -> (string)

The content of the approval rule.

ruleContentSha256 -> (string)

The SHA-256 hash signature for the content of the approval rule.

lastModifiedDate -> (timestamp)

The date the approval rule was most recently changed, in timestamp format.

creationDate -> (timestamp)

The date the approval rule was created, in timestamp format.

lastModifiedUser -> (string)

The Amazon Resource Name (ARN) of the user who made the most recent changes to the approval rule.

originApprovalRuleTemplate -> (structure)

The approval rule template used to create the rule.

approvalRuleTemplateId -> (string)

The ID of the template that created the approval rule.

approvalRuleTemplateName -> (string)

The name of the template that created the approval rule.

© Copyright 2018, Amazon Web Services. Created using Sphinx.