[ aws . codeartifact ]

get-repository-endpoint

Description

Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:

  • npm

  • pypi

  • maven

  • nuget

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--domain (string)

The name of the domain that contains the repository.

--domain-owner (string)

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

--repository (string)

The name of the repository.

--format (string)

Returns which endpoint of a repository to return. A repository has one endpoint for each package format:

  • npm

  • pypi

  • maven

  • nuget

Possible values:

  • npm

  • pypi

  • maven

  • nuget

--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.

See ‘aws help’ for descriptions of global parameters.

Examples

To get a repository’s URL endpoint

The following get-repository-endpoint example returns the npm endpoint for the test-repo repository.

aws codeartifact get-repository-endpoint \
    --domain test-domain \
    --repository test-repo \
    --format npm

Output:

{
    "repositoryEndpoint": "https://test-domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/npm/test-repo/"
}

For more information, see Connect to a repository in the AWS CodeArtifact User Guide.

Output

repositoryEndpoint -> (string)

A string that specifies the URL of the returned endpoint.