CodeCommit / Client / get_repository

get_repository#

CodeCommit.Client.get_repository(**kwargs)#

Returns information about 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.get_repository(
    repositoryName='string'
)
Parameters:

repositoryName (string) –

[REQUIRED]

The name of the repository to get information about.

Return type:

dict

Returns:

Response Syntax

{
    'repositoryMetadata': {
        'accountId': 'string',
        'repositoryId': 'string',
        'repositoryName': 'string',
        'repositoryDescription': 'string',
        'defaultBranch': 'string',
        'lastModifiedDate': datetime(2015, 1, 1),
        'creationDate': datetime(2015, 1, 1),
        'cloneUrlHttp': 'string',
        'cloneUrlSsh': 'string',
        'Arn': 'string'
    }
}

Response Structure

  • (dict) –

    Represents the output of a get repository operation.

    • repositoryMetadata (dict) –

      Information about the repository.

      • accountId (string) –

        The ID of the AWS account associated with the repository.

      • repositoryId (string) –

        The ID of the repository.

      • repositoryName (string) –

        The repository’s name.

      • repositoryDescription (string) –

        A comment or description about the repository.

      • defaultBranch (string) –

        The repository’s default branch name.

      • lastModifiedDate (datetime) –

        The date and time the repository was last modified, in timestamp format.

      • creationDate (datetime) –

        The date and time the repository was created, in timestamp format.

      • cloneUrlHttp (string) –

        The URL to use for cloning the repository over HTTPS.

      • cloneUrlSsh (string) –

        The URL to use for cloning the repository over SSH.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the repository.

Exceptions

  • CodeCommit.Client.exceptions.RepositoryNameRequiredException

  • CodeCommit.Client.exceptions.RepositoryDoesNotExistException

  • CodeCommit.Client.exceptions.InvalidRepositoryNameException

  • CodeCommit.Client.exceptions.EncryptionIntegrityChecksFailedException

  • CodeCommit.Client.exceptions.EncryptionKeyAccessDeniedException

  • CodeCommit.Client.exceptions.EncryptionKeyDisabledException

  • CodeCommit.Client.exceptions.EncryptionKeyNotFoundException

  • CodeCommit.Client.exceptions.EncryptionKeyUnavailableException