Skip to content
AWS for Query.Farm

aws.codeartifact.list_package_version_dependencies

Example SQL Queries

SELECT * FROM
aws.codeartifact.list_package_version_dependencies
WHERE
"domain" = 'VALUE'
AND "repository" = 'VALUE'
AND "format" = 'VALUE'
AND "package" = 'VALUE'
AND "package_version" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
domain Required Input Column

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

VARCHAR
format Required Input Column

A format that specifies the type of the package that contains the returned dependencies. 

VARCHAR
package Required Input Column

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

VARCHAR
package_version Required Input Column

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

VARCHAR
repository Required Input Column

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

VARCHAR
domain_owner Input Column

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

VARCHAR
namespace Input Column

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. 

VARCHAR
next_token Input Column

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. 

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
dependencies

The returned list of PackageDependency objects. 

STRUCT(
    "namespace" VARCHAR,
    "package" VARCHAR,
    "dependency_type" VARCHAR,
    "version_requirement" VARCHAR
)[]
Show child fields
dependencies[]
Show child fields
dependencies[].dependency_type

The type of a package dependency. The possible values depend on the package type.

  • npm: regular, dev, peer, optional

  • maven: optional, parent, compile, runtime, test, system, provided.

    Note that parent is not a regular Maven dependency type; instead this is extracted from the <parent> element if one is defined in the package version's POM file.

  • nuget: The dependencyType field is never set for NuGet packages.

  • pypi: Requires-Dist

dependencies[].namespace

The namespace of the package that this package depends on. 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.

dependencies[].package

The name of the package that this package depends on.

dependencies[].version_requirement

The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x.

version

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

VARCHAR
version_revision

The current revision associated with the package version. 

VARCHAR