AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Replaces the contents of the description of a pull request.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginUpdatePullRequestDescription and EndUpdatePullRequestDescription.

Namespace: Amazon.CodeCommit
Assembly: AWSSDK.CodeCommit.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<UpdatePullRequestDescriptionResponse> UpdatePullRequestDescriptionAsync(
         UpdatePullRequestDescriptionRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CodeCommit.Model.UpdatePullRequestDescriptionRequest

Container for the necessary parameters to execute the UpdatePullRequestDescription service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the UpdatePullRequestDescription service method, as returned by CodeCommit.

Exceptions

ExceptionCondition
InvalidDescriptionException The pull request description is not valid. Descriptions cannot be more than 1,000 characters.
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.
PullRequestAlreadyClosedException The pull request status cannot be updated because it is already closed.
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.
PullRequestIdRequiredException A pull request ID is required, but none was provided.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also