CodeArtifact / Client / describe_repository

describe_repository

CodeArtifact.Client.describe_repository(**kwargs)

Returns a RepositoryDescription object that contains detailed information about the requested repository.

See also: AWS API Documentation

Request Syntax

response = client.describe_repository(
    domain='string',
    domainOwner='string',
    repository='string'
)

Parameters:

• domain (string) –

  [REQUIRED]

  The name of the domain that contains the repository to describe.

• domainOwner (string) – The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

• repository (string) –

  [REQUIRED]

  A string that specifies the name of the requested repository.

Return type:

dict

Returns:

Response Syntax

{
    'repository': {
        'name': 'string',
        'administratorAccount': 'string',
        'domainName': 'string',
        'domainOwner': 'string',
        'arn': 'string',
        'description': 'string',
        'upstreams': [
            {
                'repositoryName': 'string'
            },
        ],
        'externalConnections': [
            {
                'externalConnectionName': 'string',
                'packageFormat': 'npm'|'pypi'|'maven'|'nuget'|'generic'|'ruby'|'swift'|'cargo',
                'status': 'Available'
            },
        ],
        'createdTime': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  • repository (dict) –

    A RepositoryDescription object that contains the requested repository information.

    • name (string) –

      The name of the repository.

    • administratorAccount (string) –

      The 12-digit account number of the Amazon Web Services account that manages the repository.

    • domainName (string) –

      The name of the domain that contains the repository.

    • domainOwner (string) –

      The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.

    • arn (string) –

      The Amazon Resource Name (ARN) of the repository.

    • description (string) –

      A text description of the repository.

    • upstreams (list) –

      A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

      • (dict) –

        Information about an upstream repository.

        • repositoryName (string) –

          The name of an upstream repository.

    • externalConnections (list) –

      An array of external connections associated with the repository.

      • (dict) –

        Contains information about the external connection of a repository.

        • externalConnectionName (string) –

          The name of the external connection associated with a repository.

        • packageFormat (string) –

          The package format associated with a repository’s external connection. The valid package formats are:

          • npm: A Node Package Manager (npm) package.

          • pypi: A Python Package Index (PyPI) package.

          • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

          • nuget: A NuGet package.

          • generic: A generic package.

          • ruby: A Ruby package.

          • swift: A Swift package.

          • cargo: A Cargo package.

        • status (string) –

          The status of the external connection of a repository. There is one valid value, Available.

    • createdTime (datetime) –

      A timestamp that represents the date and time the repository was created.

Exceptions

• CodeArtifact.Client.exceptions.AccessDeniedException

• CodeArtifact.Client.exceptions.InternalServerException

• CodeArtifact.Client.exceptions.ResourceNotFoundException

• CodeArtifact.Client.exceptions.ThrottlingException

• CodeArtifact.Client.exceptions.ValidationException