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.

Sets or changes the comment or description for a repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a webpage can expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a webpage.

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 BeginUpdateRepositoryDescription and EndUpdateRepositoryDescription.

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

Syntax

C#
public virtual Task<UpdateRepositoryDescriptionResponse> UpdateRepositoryDescriptionAsync(
         UpdateRepositoryDescriptionRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CodeCommit.Model.UpdateRepositoryDescriptionRequest

Container for the necessary parameters to execute the UpdateRepositoryDescription 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 UpdateRepositoryDescription service method, as returned by CodeCommit.

Exceptions

ExceptionCondition
EncryptionIntegrityChecksFailedException An encryption integrity check failed.
EncryptionKeyAccessDeniedException An encryption key could not be accessed.
EncryptionKeyDisabledException The encryption key is disabled.
EncryptionKeyNotFoundException No encryption key was found.
EncryptionKeyUnavailableException The encryption key is not available.
InvalidRepositoryDescriptionException The specified repository description is not valid.
InvalidRepositoryNameException A specified repository name is not valid. This exception occurs only when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
RepositoryDoesNotExistException The specified repository does not exist.
RepositoryNameRequiredException A repository name is required, but was not specified.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also