Skip to content
AWS for Query.Farm

aws.codeartifact.describe_package_version

Example SQL Queries

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

Description

Returns a PackageVersionDescription object that contains information about the requested package version.

Table Definition

Column NameColumn Data Type
domain Required Input Column

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

VARCHAR
format Required Input Column

A format that specifies the type of the requested package version. 

VARCHAR
package Required Input Column

The name of the requested package version. 

VARCHAR
repository Required Input Column

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

The namespace is required when requesting 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. 

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
_input_package_version Input Column
VARCHAR
package_version

A PackageVersionDescription object that contains information about the requested package version. 

STRUCT(
    "format" VARCHAR,
    "namespace" VARCHAR,
    "package_name" VARCHAR,
    "display_name" VARCHAR,
    "version" VARCHAR,
    "summary" VARCHAR,
    "home_page" VARCHAR,
    "source_code_repository" VARCHAR,
    "published_time" TIMESTAMP_S,
    "licenses" STRUCT(
        "name" VARCHAR,
        "url" VARCHAR
    )[],
    "revision" VARCHAR,
    "status" VARCHAR,
    "origin" STRUCT(
        "domain_entry_point" STRUCT(
            "repository_name" VARCHAR,
            "external_connection_name" VARCHAR
        ),
        "origin_type" VARCHAR
    )
)
Show child fields
package_version.display_name

The name of the package that is displayed. The displayName varies depending on the package version's format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui.

package_version.format

The format of the package version.

package_version.home_page

The homepage associated with the package.

package_version.licenses[]
Show child fields
package_version.licenses[].name

Name of the license.

package_version.licenses[].url

The URL for license data.

package_version.namespace

The namespace of the package version. 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.

package_version.origin

A PackageVersionOrigin object that contains information about how the package version was added to the repository.

Show child fields
package_version.origin.domain_entry_point

A DomainEntryPoint object that contains information about from which repository or external connection the package version was added to the domain.

Show child fields
package_version.origin.domain_entry_point.external_connection_name

The name of the external connection that a package was ingested from.

package_version.origin.domain_entry_point.repository_name

The name of the repository that a package was originally published to.

package_version.origin.origin_type

Describes how the package version was originally added to the domain. An INTERNAL origin type means the package version was published directly to a repository in the domain. An EXTERNAL origin type means the package version was ingested from an external connection.

package_version.package_name

The name of the requested package.

package_version.published_time

A timestamp that contains the date and time the package version was published.

package_version.revision

The revision of the package version.

package_version.source_code_repository

The repository for the source code in the package version, or the source code used to build it.

package_version.status

A string that contains the status of the package version.

package_version.summary

A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format.

package_version.version

The version of the package.