[ aws . codeartifact ]

update-repository

Description

Update the properties of a repository.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--domain (string)

The name of the domain associated with the repository to update.

--domain-owner (string)

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

--repository (string)

The name of the repository to update.

--description (string)

An updated repository description.

--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 AWS CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories .

(structure)

Information about an upstream repository. A list of UpstreamRepository objects is an input parameter to ` CreateRepository https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateRepository.html`__ and ` UpdateRepository https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdateRepository.html`__ .

repositoryName -> (string)

The name of an upstream repository.

Shorthand Syntax:

repositoryName=string ...

JSON Syntax:

[
  {
    "repositoryName": "string"
  }
  ...
]

--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 update a repository

The following update-repository example updates the description of a repo named test-repo in a domain named test-domain to “this is an updated description”.

aws codeartifact update-repository \
    --domain test-domain \
    --repository test-repo \
    --description "this is an updated description"

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 an updated description",
        "upstreams": [],
        "externalConnections": []
    }
}

For more information, see View or modify a repository configuration in the AWS CodeArtifact User Guide.

Output

repository -> (structure)

The updated repository.

name -> (string)

The name of the repository.

administratorAccount -> (string)

The 12-digit account number of the AWS 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 AWS 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 AWS 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 .