describe-repository¶

Description¶

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

Synopsis¶

  describe-repository
--domain <value>
[--domain-owner <value>]
--repository <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--domain (string)

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

--domain-owner (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)

A string that specifies the name of the requested repository.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get information about a repository

The following describe-repository example returns a RepositoryDescription object for a repository named test-repo.

aws codeartifact describe-repository \
    --domain test-domain \
    --repository test-repo

Output:

{
    "repository": {
        "name": "test-repo",
        "administratorAccount": "111122223333",
        "domainName": "test-domain",
        "domainOwner": "111122223333",
        "arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/test-domain/test-repo",
        "description": "This is a test repository.",
        "upstreams": [],
        "externalConnections": []
    }
}

For more information, see Create a domain in the AWS CodeArtifact User Guide.

Output¶

repository -> (structure)

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 .

(structure)

Information about an upstream repository.

repositoryName -> (string)

The name of an upstream repository.

externalConnections -> (list)

An array of external connections associated with the repository.

(structure)

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.

status -> (string)

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

Table of Contents

Feedback

User Guide