Skip to content
AWS for Query.Farm

aws.codeartifact.get_associated_package_group

Example SQL Queries

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

Description

Returns the most closely associated package group to the specified package. This API does not require that the package exist in any repository in the domain. As such, GetAssociatedPackageGroup can be used to see which package group's origin configuration applies to a package before that package is in a repository. This can be helpful to check if public packages are blocked without ingesting them.

For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

Table Definition

Column NameColumn Data Type
domain Required Input Column

The name of the domain that contains the package from which to get the associated package group. 

VARCHAR
format Required Input Column

The format of the package from which to get the associated package group. 

VARCHAR
package Required Input Column

The package from which to get the associated package group. 

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 from which to get the associated package group. The package component that specifies its namespace depends on its type. For example:

The namespace is required when getting associated package groups from packages 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
association_type

Describes the strength of the association between the package and package group. A strong match is also known as an exact match, and a weak match is known as a relative match.

VARCHAR
package_group

The package group that is associated with the requested package.

STRUCT(
    "arn" VARCHAR,
    "pattern" VARCHAR,
    "domain_name" VARCHAR,
    "domain_owner" VARCHAR,
    "created_time" TIMESTAMP_S,
    "contact_info" VARCHAR,
    "description" VARCHAR,
    "origin_configuration" STRUCT(
        "restrictions" MAP(VARCHAR, STRUCT(
                "mode" VARCHAR,
                "effective_mode" VARCHAR,
                "inherited_from" STRUCT(
                    "arn" VARCHAR,
                    "pattern" VARCHAR
                ),
                "repositories_count" BIGINT
            ))
    ),
    "parent" STRUCT(
        "arn" VARCHAR,
        "pattern" VARCHAR
    )
)
Show child fields
package_group.arn

The ARN of the package group.

package_group.contact_info

The contact information of the package group.

package_group.created_time

A timestamp that represents the date and time the package group was created.

package_group.description

The description of the package group.

package_group.domain_name

The name of the domain that contains the package group.

package_group.domain_owner

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

package_group.origin_configuration

The package group origin configuration that determines how package versions can enter repositories.

Show child fields
package_group.origin_configuration.restrictions

The origin configuration settings that determine how package versions can enter repositories.

package_group.parent

The direct parent package group of the package group.

Show child fields
package_group.parent.arn

The ARN of the package group.

package_group.parent.pattern

The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.

package_group.pattern

The pattern of the package group. The pattern determines which packages are associated with the package group.