[ aws . codeartifact ]

delete-package-versions

Description

Deletes one or more versions of a package. A deleted package version cannot be restored in your repository. If you want to remove a package version from your repository and be able to restore it later, set its status to Archived . Archived packages cannot be downloaded from a repository and don’t show up with list package APIs (for example, ListackageVersions ), but you can restore them using UpdatePackageVersionsStatus .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  delete-package-versions
--domain <value>
[--domain-owner <value>]
--repository <value>
--format <value>
[--namespace <value>]
--package <value>
--versions <value>
[--expected-status <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--domain (string)

The name of the domain that contains the package to delete.

--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 name of the repository that contains the package versions to delete.

--format (string)

The format of the package versions to delete.

Possible values:

  • npm

  • pypi

  • maven

  • nuget

--namespace (string)

The namespace of the package versions to be deleted. 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 is required when deleting Maven package versions.

  • 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 versions to delete.

--versions (list)

An array of strings that specify the versions of the package to delete.

(string)

Syntax:

"string" "string" ...

--expected-status (string)

The expected status of the package version to delete.

Possible values:

  • Published

  • Unfinished

  • Unlisted

  • Archived

  • Disposed

  • Deleted

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

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 delete package versions

The following delete-package-versions example deletes version 4.0.0 of a package named test-package.

aws codeartifact delete-package-versions \
    --domain test-domain \
    --repo test-repo \
    --format npm \
    --package test-package \
    --versions 4.0.0

Output:

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

For more information, see Delete a package version in the AWS CodeArtifact User Guide.

Output

successfulVersions -> (map)

A list of the package versions that were successfully deleted. The status of every successful version will be Deleted .

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 PackageVersionError object that contains a map of errors codes for the deleted package that failed. The possible error codes are:

  • ALREADY_EXISTS

  • MISMATCHED_REVISION

  • MISMATCHED_STATUS

  • NOT_ALLOWED

  • NOT_FOUND

  • SKIPPED

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.