ListPackageVersionDependencies - CodeArtifact
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

ListPackageVersionDependencies

Returns the direct dependencies for a package version. The dependencies are returned as PackageDependency objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, the package.json file for npm packages and the pom.xml file for Maven). Any package version dependencies that are not listed in the configuration file are not returned.

Request Syntax

POST /v1/package/version/dependencies?domain=domain&domain-owner=domainOwner&format=format&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 domain that contains the repository that contains the requested package version dependencies.

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 with the requested dependencies. The valid package types are:

  • npm: A Node Package Manager (npm) package.

  • pypi: A Python Package Index (PyPI) package.

  • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

Valid Values: npm | pypi | maven

Required: Yes

namespace

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

  • The namespace of a Maven package is its groupId.

  • The namespace of an npm package is its scope.

  • A Python package does not contain a corresponding component, so Python packages 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 versions' package.

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 requested package version.

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

{
   "dependencies": [ 
      { 
         "dependencyType": "string",
         "namespace": "string",
         "package": "string",
         "versionRequirement": "string"
      }
   ],
   "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.

dependencies

The returned list of PackageDependency objects.

Type: Array of PackageDependency objects

format

A format that specifies the type of the package that contains the returned dependencies. The valid values are:

  • npm

  • pypi

  • maven

Type: String

Valid Values: npm | pypi | maven

namespace

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

  • The namespace of a Maven package is its groupId.

  • The namespace of an npm package is its scope.

  • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

Type: String

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.

Type: String

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

Pattern: \S+

package

The name of the package that contains the returned package versions dependencies.

Type: String

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

Pattern: [^!#/\s]+

version

The version of the package that is specified in the request.

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: