Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . codeartifact ]

update-package-versions-status

Description

Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus , you can update the status of package versions to Archived , Published , or Unlisted . To set the status of a package version to Disposed , use DisposePackageVersions .

See also: AWS API Documentation

Synopsis

  update-package-versions-status
--domain <value>
[--domain-owner <value>]
--repository <value>
--format <value>
[--namespace <value>]
--package <value>
--versions <value>
[--version-revisions <value>]
[--expected-status <value>]
--target-status <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--domain (string)

The name of the domain that contains the repository that contains the package versions with a status to be updated.

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

The repository that contains the package versions with the status you want to update.

--format (string)

A format that specifies the type of the package with the statuses to update.

Possible values:

  • npm
  • pypi
  • maven
  • nuget

--namespace (string)

The namespace of the package version to be updated. The package version component that specifies its namespace depends on its type. For example:

  • The namespace of a Maven package version is its groupId .
  • The namespace of an npm package version is its scope .
  • Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

--package (string)

The name of the package with the version statuses to update.

--versions (list)

An array of strings that specify the versions of the package with the statuses to update.

(string)

Syntax:

"string" "string" ...

--version-revisions (map)

A map of package versions and package version revisions. The map key is the package version (for example, 3.5.2 ), and the map value is the package version revision.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--expected-status (string)

The package version’s expected status before it is updated. If expectedStatus is provided, the package version's status is updated only if its status at the time UpdatePackageVersionsStatus is called matches expectedStatus .

Possible values:

  • Published
  • Unfinished
  • Unlisted
  • Archived
  • Disposed
  • Deleted

--target-status (string)

The status you want to change the package version status to.

Possible values:

  • Published
  • Unfinished
  • Unlisted
  • Archived
  • Disposed
  • Deleted

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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 update package version status

The following update-package-versions-status example updates the status of version 4.0.0 of the test-package package to Archived.

aws codeartifact update-package-versions-status \
    --domain test-domain \
    --repo test-repo \
    --format npm \
    --package test-package \
    --versions 4.0.0 \
    --target-status Archived

Output:

{
    "successfulVersions": {
        "4.0.0": {
            "revision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs=",
            "status": "Archived"
        }
    },
    "failedVersions": {}
}

For more information, see Update package version status in the AWS CodeArtifact User Guide.

Output

successfulVersions -> (map)

A list of PackageVersionError objects, one for each package version with a status that failed to update.

key -> (string)

value -> (structure)

Contains the revision and status of a package version.

revision -> (string)

The revision of a package version.

status -> (string)

The status of a package version.

failedVersions -> (map)

A list of SuccessfulPackageVersionInfo objects, one for each package version with a status that successfully updated.

key -> (string)

value -> (structure)

l An error associated with package.

errorCode -> (string)

The error code associated with the error. Valid error codes are:

  • ALREADY_EXISTS
  • MISMATCHED_REVISION
  • MISMATCHED_STATUS
  • NOT_ALLOWED
  • NOT_FOUND
  • SKIPPED

errorMessage -> (string)

The error message associated with the error.