ListPackageVersionAssets - AWS CodeArtifact

ListPackageVersionAssets

Returns a list of AssetSummary objects for assets in a package version.

Request Syntax

POST /v1/package/version/assets?domain=domain&domain-owner=domainOwner&format=format&max-results=maxResults&namespace=namespace&next-token=nextToken&package=package&repository=repository&version=packageVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domain

The name of the domain that contains the repository associated with the package version assets.

Length Constraints: Minimum length of 2. Maximum length of 50.

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Required: Yes

domainOwner

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

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

format

The format of the package that contains the requested package version assets.

Valid Values: npm | pypi | maven | nuget | generic | ruby | swift | cargo

Required: Yes

maxResults

The maximum number of results to return per page.

Valid Range: Minimum value of 1. Maximum value of 1000.

namespace

The namespace of the package version that contains the requested package version assets. The package component that specifies its namespace depends on its type. For example:

Note

The namespace is required 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.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Length Constraints: Minimum length of 1. Maximum length of 2000.

Pattern: \S+

package

The name of the package that contains the requested package version assets.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

Required: Yes

packageVersion

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

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

Required: Yes

repository

The name of the repository that contains the package that contains the requested package version assets.

Length Constraints: Minimum length of 2. Maximum length of 100.

Pattern: [A-Za-z0-9][A-Za-z0-9._\-]{1,99}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "assets": [ { "hashes": { "string" : "string" }, "name": "string", "size": number } ], "format": "string", "namespace": "string", "nextToken": "string", "package": "string", "version": "string", "versionRevision": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

assets

The returned list of AssetSummary objects.

Type: Array of AssetSummary objects

format

The format of the package that contains the requested package version assets.

Type: String

Valid Values: npm | pypi | maven | nuget | generic | ruby | swift | cargo

namespace

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

nextToken

If there are additional results, this is the token for the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Pattern: \S+

package

The name of the package that contains the requested package version assets.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

version

The version of the package associated with the requested assets.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

versionRevision

The current revision associated with the package version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: \S+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The operation did not succeed because of an unauthorized access attempt.

HTTP Status Code: 403

InternalServerException

The operation did not succeed because of an error that occurred inside AWS CodeArtifact.

HTTP Status Code: 500

ResourceNotFoundException

The operation did not succeed because the resource requested is not found in the service.

HTTP Status Code: 404

ThrottlingException

The operation did not succeed because too many requests are sent to the service.

HTTP Status Code: 429

ValidationException

The operation did not succeed because a parameter in the request was sent with an invalid value.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: