package_version_dependencies

Creates, updates, deletes, gets or lists a package_version_dependencies resource.

Overview

Name	package_version_dependencies
Type	Resource
Id	aws.codeartifact.package_version_dependencies

Fields

The following fields are returned by SELECT queries:

list_package_version_dependencies

Name	Datatype	Description
dependencies	array	The returned list of PackageDependency objects.
format_	string	A format that specifies the type of the package that contains the returned dependencies. (npm, pypi, maven, nuget, generic, ruby, swift, cargo)
namespace	string	The namespace of the package version that contains the returned dependencies. The package component that specifies its namespace depends on its type. For example: The namespace is required when listing dependencies from package versions of the following formats: Maven The namespace of a Maven package version is its groupId. The namespace of an npm package version is its scope. Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace. (pattern: <code>[^#/\s]+</code>)
next_token	string	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. (pattern: <code>\S+</code>)
package	string	The name of the package that contains the returned package versions dependencies. (pattern: <code>[^#/\s]+</code>)
version	string	The version of the package that is specified in the request. (pattern: <code>[^#/\s]+</code>)
version_revision	string	The current revision associated with the package version. (pattern: <code>\S+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_package_version_dependencies	select	domain, repository, format, package, version, region	domain-owner, namespace, next-token	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain	string	The name of the domain that contains the repository that contains the requested package version dependencies.
format	string	The format of the package with the requested dependencies.
package	string	The name of the package versions' package.
region	string	AWS region (default: us-east-1)
repository	string	The name of the repository that contains the requested package version.
version	string	A string that contains the package version (for example, 3.5.2).
domain-owner	string	The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
namespace	string	The namespace of the package version with the requested dependencies. The package component that specifies its namespace depends on its type. For example: The namespace is required when listing dependencies from package versions of the following formats: Maven The namespace of a Maven package version is its groupId. The namespace of an npm package version is its scope. Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
next-token	string	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.

SELECT examples

list_package_version_dependencies

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.

SELECT
dependencies,
format_,
namespace,
next_token,
package,
version,
version_revision
FROM aws.codeartifact.package_version_dependencies
WHERE domain = '{{ domain }}' -- required
AND repository = '{{ repository }}' -- required
AND format = '{{ format }}' -- required
AND package = '{{ package }}' -- required
AND version = '{{ version }}' -- required
AND region = '{{ region }}' -- required
AND `domain-owner` = '{{ domain-owner }}'
AND namespace = '{{ namespace }}'
AND `next-token` = '{{ next-token }}'
;