POST

/v1/package/version/dependencies#domain&repository&format&package&version

http://codeartifact.{region}.amazonaws.com/v1/package/version/dependencies#domain&repository&format&package&version

Returns the direct dependencies for a package version. The dependencies are returned as <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html">PackageDependency</a> objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, the <code>package.json</code> file for npm packages and the <code>pom.xml</code> file for Maven). Any package version dependencies that are not listed in the configuration file are not returned.

Access Token Required: API Key

Query Params

domainstringrequired

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

domain-ownerstring

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

repositorystringrequired

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

formatstringrequired

The format of the package with the requested dependencies.

Allowed:

namespacestring

The namespace of the package version with the requested dependencies. The package version component that specifies its namespace depends on its type. For example: <ul> <li> The namespace of a Maven package version is its <code>groupId</code>. </li> <li> The namespace of an npm package version is its <code>scope</code>. </li> <li> Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace. </li> <li> The namespace of a generic package is its <code>namespace</code>. </li> </ul>

packagestringrequired

The name of the package versions' package.

versionstringrequired

A string that contains the package version (for example, <code>3.5.2</code>).

next-tokenstring

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://codeartifact.{region}.amazonaws.com/v1/package/version/dependencies#domain&repository&format&package&version' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}