Skip to content

Returns an asset (or file) that is in a package

Description

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

Usage

codeartifact_get_package_version_asset(domain, domainOwner, repository,
  format, namespace, package, packageVersion, asset,
  packageVersionRevision)

Arguments

  • domain

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

  • domainOwner

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

  • repository

    [required] The repository that contains the package version with the requested asset.

  • format

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

  • namespace

    The namespace of the package version with the requested asset file. The package component that specifies its namespace depends on its type. For example:

    The namespace is required when requesting assets from 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

    [required] The name of the package that contains the requested asset.

  • packageVersion

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

  • asset

    [required] The name of the requested asset.

  • packageVersionRevision

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

Value

A list with the following syntax:

list(
  asset = raw,
  assetName = "string",
  packageVersion = "string",
  packageVersionRevision = "string"
)

Request syntax

svc$get_package_version_asset(
  domain = "string",
  domainOwner = "string",
  repository = "string",
  format = "npm"|"pypi"|"maven"|"nuget"|"generic"|"ruby"|"swift"|"cargo",
  namespace = "string",
  package = "string",
  packageVersion = "string",
  asset = "string",
  packageVersionRevision = "string"
)