CodeCommit / Client / batch_get_repositories

batch_get_repositories#

CodeCommit.Client.batch_get_repositories(**kwargs)#

Returns information about one or more repositories.

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.

Request Syntax

response = client.batch_get_repositories(
    repositoryNames=[
        'string',
    ]
)

Parameters:

repositoryNames (list) –

[REQUIRED]

The names of the repositories to get information about.

Note

The length constraint limit is for each string in the array. The array itself can be empty.

(string) –

Return type:

dict

Returns:

Response Syntax

{
    'repositories': [
        {
            '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',
            'kmsKeyId': 'string'
        },
    ],
    'repositoriesNotFound': [
        'string',
    ],
    'errors': [
        {
            'repositoryId': 'string',
            'repositoryName': 'string',
            'errorCode': 'EncryptionIntegrityChecksFailedException'|'EncryptionKeyAccessDeniedException'|'EncryptionKeyDisabledException'|'EncryptionKeyNotFoundException'|'EncryptionKeyUnavailableException'|'RepositoryDoesNotExistException',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

(dict) –

Represents the output of a batch get repositories operation.
- repositories (list) –
  
  A list of repositories returned by the batch get repositories operation.
  - (dict) –
    
    Information about a repository.
    - accountId (string) –
      
      The ID of the Amazon Web Services 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.
    - kmsKeyId (string) –
      
      The ID of the Key Management Service encryption key used to encrypt and decrypt the repository.
- repositoriesNotFound (list) –
  
  Returns a list of repository names for which information could not be found.
  - (string) –
- errors (list) –
  
  Returns information about any errors returned when attempting to retrieve information about the repositories.
  - (dict) –
    
    Returns information about errors in a BatchGetRepositories operation.
    - repositoryId (string) –
      
      The ID of a repository that either could not be found or was not in a valid state.
    - repositoryName (string) –
      
      The name of a repository that either could not be found or was not in a valid state.
    - errorCode (string) –
      
      An error code that specifies the type of failure.
    - errorMessage (string) –
      
      An error message that provides detail about why the repository either was not found or was not in a valid state.

Exceptions

CodeCommit.Client.exceptions.RepositoryNamesRequiredException
CodeCommit.Client.exceptions.MaximumRepositoryNamesExceededException
CodeCommit.Client.exceptions.InvalidRepositoryNameException
CodeCommit.Client.exceptions.EncryptionIntegrityChecksFailedException
CodeCommit.Client.exceptions.EncryptionKeyAccessDeniedException
CodeCommit.Client.exceptions.EncryptionKeyDisabledException
CodeCommit.Client.exceptions.EncryptionKeyNotFoundException
CodeCommit.Client.exceptions.EncryptionKeyUnavailableException