associated_package_groups

Creates, updates, deletes, gets or lists an associated_package_groups resource.

Overview

Name	associated_package_groups
Type	Resource
Id	aws.codeartifact.associated_package_groups

Fields

The following fields are returned by SELECT queries:

get_associated_package_group

Name	Datatype	Description
association_type	string	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. (STRONG, WEAK)
package_group	object	The package group that is associated with the requested package.

Methods

The following methods are available for this resource:

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

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 package from which to get the associated package group.
format	string	The format of the package from which to get the associated package group.
package	string	The package from which to get the associated package group.
region	string	AWS region (default: us-east-1)
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 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.

SELECT examples

get_associated_package_group

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.

SELECT
association_type,
package_group
FROM aws.codeartifact.associated_package_groups
WHERE domain = '{{ domain }}' -- required
AND format = '{{ format }}' -- required
AND package = '{{ package }}' -- required
AND region = '{{ region }}' -- required
AND `domain-owner` = '{{ domain-owner }}'
AND namespace = '{{ namespace }}'
;