UpdatePullRequestDescription
Replaces the contents of the description of a pull request.
Request Syntax
{
"description": "string",
"pullRequestId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- description
-
The updated content of the description for the pull request. This content replaces the existing description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10240.
Required: Yes
- pullRequestId
-
The system-generated ID of the pull request. To get this ID, use ListPullRequests.
Type: String
Required: Yes
Response Syntax
{
"pullRequest": {
"approvalRules": [
{
"approvalRuleContent": "string",
"approvalRuleId": "string",
"approvalRuleName": "string",
"creationDate": number,
"lastModifiedDate": number,
"lastModifiedUser": "string",
"originApprovalRuleTemplate": {
"approvalRuleTemplateId": "string",
"approvalRuleTemplateName": "string"
},
"ruleContentSha256": "string"
}
],
"authorArn": "string",
"clientRequestToken": "string",
"creationDate": number,
"description": "string",
"lastActivityDate": number,
"pullRequestId": "string",
"pullRequestStatus": "string",
"pullRequestTargets": [
{
"destinationCommit": "string",
"destinationReference": "string",
"mergeBase": "string",
"mergeMetadata": {
"isMerged": boolean,
"mergeCommitId": "string",
"mergedBy": "string",
"mergeOption": "string"
},
"repositoryName": "string",
"sourceCommit": "string",
"sourceReference": "string"
}
],
"revisionId": "string",
"title": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- pullRequest
-
Information about the updated pull request.
Type: PullRequest object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- InvalidDescriptionException
-
The pull request description is not valid. Descriptions cannot be more than 1,000 characters.
- message
-
Any message associated with the exception.
HTTP Status Code: 400
- InvalidPullRequestIdException
-
The pull request ID is not valid. Make sure that you have provided the full ID and that the pull request is in the specified repository, and then try again.
- message
-
Any message associated with the exception.
HTTP Status Code: 400
- PullRequestAlreadyClosedException
-
The pull request status cannot be updated because it is already closed.
- message
-
Any message associated with the exception.
HTTP Status Code: 400
- PullRequestDoesNotExistException
-
The pull request ID could not be found. Make sure that you have specified the correct repository name and pull request ID, and then try again.
- message
-
Any message associated with the exception.
HTTP Status Code: 400
- PullRequestIdRequiredException
-
A pull request ID is required, but none was provided.
- message
-
Any message associated with the exception.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of UpdatePullRequestDescription.
Sample Request
>POST / HTTP/1.1
Host: codecommit.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 350
X-Amz-Target: CodeCommit_20150413.UpdatePullRequestDescription
X-Amz-Date: 20171025T132023Z
User-Agent: aws-cli/1.11.187 Python/2.7.9 Windows/8
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20171025/us-east-1/codecommit/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE
{
"description": "Updated the pull request to remove unused global variable.",
"pullRequestId": "47"
}Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 0728aaa8-EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 847
Date: Wed, 25 Oct 2017 20:20:13 GMT
{
"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": "dd8b17fe-OTHEREXAMPLE",
"approvalRuleTemplateName": "2-approver-rule-for-main"
},
"ruleContentSha256": "4711b576EXAMPLE"
}
],
"authorArn": "arn:aws:iam::123456789012:user/Li_Juan",
"clientRequestToken": "",
"creationDate": 1508530823.155,
"description": "Updated the pull request to remove unused global variable.",
"lastActivityDate": 1508372423.204,
"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"
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
