Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListPackageVersions

Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters. Package versions of all statuses will be returned by default when calling list-package-versions with no --status parameter.

Request Syntax


POST /v1/package/versions?domain=domain&domain-owner=domainOwner&format=format&max-results=maxResults&namespace=namespace&next-token=nextToken&originType=originType&package=package&repository=repository&sortBy=sortBy&status=status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domain

The name of the domain that contains the repository that contains the requested package versions.

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 versions you want to list.

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 that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:

Note

The namespace is required when deleting 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+

originType

The originType used to filter package versions. Only package versions with the provided originType will be returned.

Valid Values: INTERNAL | EXTERNAL | UNKNOWN

package

The name of the package for which you want to request package versions.

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

Pattern: [^#/\s]+

Required: Yes

repository

The name of the repository that contains the requested package versions.

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

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

Required: Yes

sortBy

How to sort the requested list of package versions.

Valid Values: PUBLISHED_TIME

status

A string that filters the requested package versions by status.

Valid Values: Archived | Disposed | Published | Unfinished | Unlisted

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "defaultDisplayVersion": "string",
   "format": "string",
   "namespace": "string",
   "nextToken": "string",
   "package": "string",
   "versions": [ 
      { 
         "origin": { 
            "domainEntryPoint": { 
               "externalConnectionName": "string",
               "repositoryName": "string"
            },
            "originType": "string"
         },
         "revision": "string",
         "status": "string",
         "version": "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.

defaultDisplayVersion

The default package version to display. This depends on the package format:

For Maven and PyPI packages, it's the most recently published package version.
For npm packages, it's the version referenced by the latest tag. If the latest tag is not set, it's the most recently published package version.

Type: String

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

Pattern: [^#/\s]+

format

A format of the package.

Type: String

namespace

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

Type: String

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

Pattern: [^#/\s]+

versions

The returned list of PackageVersionSummary objects.

Type: Array of PackageVersionSummary objects

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