[ aws . codeartifact ]

get-package-version-asset

Description

Returns an asset (or file) that is in a package. For example, for a Maven package version, use GetPackageVersionAsset to download a JAR file, a POM file, or any other assets in the package version.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-package-version-asset
--domain <value>
[--domain-owner <value>]
--repository <value>
--format <value>
[--namespace <value>]
--package <value>
--package-version <value>
--asset <value>
[--package-version-revision <value>]
<outfile>

Options

--domain (string)

The name of the domain that contains the repository that contains the package version with the requested asset.

--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 version with the requested asset.

--format (string)

A format that specifies the type of the package version with the requested asset file.

Possible values:

  • npm

  • pypi

  • maven

  • nuget

--namespace (string)

The namespace of the package version with the requested asset file. 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 that contains the requested asset.

--package-version (string)

A string that contains the package version (for example, 3.5.2 ).

--asset (string)

The name of the requested asset.

--package-version-revision (string)

The name of the package version revision that contains the requested asset.

outfile (string) Filename where the content will be saved

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 get an asset from a package version

The following get-package-version-asset example retrieves the package.tgz asset for version 4.0.0 of an npm package named test-package.

aws codeartifact get-package-version-asset \
    --domain test-domain \
    --repository test-repo \
    --format npm \
    --package test-package \
    --package-version 4.0.0 \
    --asset 'package.tgz' \
    outfileName

Output:

The output for this command will also store the raw asset in the file provided in place of outfileName.

{
    "assetName": "package.tgz",
    "packageVersion": "4.0.0",
    "packageVersionRevision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs="
}

For more information, see List package version assets in the AWS CodeArtifact User Guide.

Output

asset -> (blob)

The binary file, or asset, that is downloaded.

assetName -> (string)

The name of the asset that is downloaded.

packageVersion -> (string)

A string that contains the package version (for example, 3.5.2 ).

packageVersionRevision -> (string)

The name of the package version revision that contains the downloaded asset.