CodeCommit / Client / update_repository_description

update_repository_description#

CodeCommit.Client.update_repository_description(**kwargs)#

Sets or changes the comment or description for a repository.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.update_repository_description(
    repositoryName='string',
    repositoryDescription='string'
)
Parameters:
  • repositoryName (string) –

    [REQUIRED]

    The name of the repository to set or change the comment or description for.

  • repositoryDescription (string) – The new comment or description for the specified repository. Repository descriptions are limited to 1,000 characters.

Returns:

None

Exceptions

  • CodeCommit.Client.exceptions.RepositoryNameRequiredException

  • CodeCommit.Client.exceptions.RepositoryDoesNotExistException

  • CodeCommit.Client.exceptions.InvalidRepositoryNameException

  • CodeCommit.Client.exceptions.InvalidRepositoryDescriptionException

  • CodeCommit.Client.exceptions.EncryptionIntegrityChecksFailedException

  • CodeCommit.Client.exceptions.EncryptionKeyAccessDeniedException

  • CodeCommit.Client.exceptions.EncryptionKeyDisabledException

  • CodeCommit.Client.exceptions.EncryptionKeyNotFoundException

  • CodeCommit.Client.exceptions.EncryptionKeyUnavailableException