AWS CLI Command Reference

[ aws . codeartifact ]

copy-package-versions

Description

Copies package versions from one repository to another repository in the same domain.

Note

You must specify versions or versionRevisions . You cannot specify both.

See also: AWS API Documentation

Synopsis

  copy-package-versions
--domain <value>
[--domain-owner <value>]
--source-repository <value>
--destination-repository <value>
--format <value>
[--namespace <value>]
--package <value>
[--versions <value>]
[--version-revisions <value>]
[--allow-overwrite | --no-allow-overwrite]
[--include-from-upstream | --no-include-from-upstream]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--domain (string)

The name of the domain that contains the source and destination repositories.

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

--source-repository (string)

The name of the repository that contains the package versions to be copied.

--destination-repository (string)

The name of the repository into which package versions are copied.

--format (string)

The format of the package versions to be copied.

Possible values:

  • npm
  • pypi
  • maven
  • nuget
  • generic
  • ruby
  • swift
  • cargo

--namespace (string)

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

Note

The namespace is required when copying package versions of the following formats:

  • Maven
  • Swift
  • generic
  • The namespace of a Maven package version is its groupId .
  • The namespace of an npm or Swift package version is its scope .
  • The namespace of a generic package is its namespace .
  • Python, NuGet, Ruby, and Cargo 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 that contains the versions to be copied.

--versions (list)

The versions of the package to be copied.

Note

You must specify versions or versionRevisions . You cannot specify both.

(string)

Syntax:

"string" "string" ...

--version-revisions (map)

A list of key-value pairs. The keys are package versions and the values are package version revisions. A CopyPackageVersion operation succeeds if the specified versions in the source repository match the specified package version revision.

Note

You must specify versions or versionRevisions . You cannot specify both.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--allow-overwrite | --no-allow-overwrite (boolean)

Set to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the failedVersions field of the response with an ALREADY_EXISTS error code.

--include-from-upstream | --no-include-from-upstream (boolean)

Set to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see Working with upstream repositories .

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

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input 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 copy package versions from one repository to another

The following copy-package-versions moves versions 4.0.0 and 5.0.0 of a package named test-package from my-repo to test-repo.

aws codeartifact copy-package-versions \
    --domain test-domain \
    --source-repository my-repo \
    --destination-repository test-repo \
    --format npm \
    --package test-package \
    --versions '["4.0.0", "5.0.0"]'

Output:

{
    "format": "npm",
    "package": "test-package",
    "versions": [
        {
        "version": "5.0.0",
        "revision": "REVISION-1-SAMPLE-6C81EFF7DA55CC",
        "status": "Published"
        },
        {
        "version": "4.0.0",
        "revision": "REVISION-2-SAMPLE-55C752BEE772FC",
        "status": "Published"
        }
    ]
}

For more information, see Copy packages between repositories in the AWS CodeArtifact User Guide.

Output

successfulVersions -> (map)

A list of the package versions that were successfully copied to your repository.

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 map of package versions that failed to copy and their error codes. The possible error codes are in the PackageVersionError data type. They 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.
© Copyright 2018, Amazon Web Services. Created using Sphinx.