Skip to main content

sub_package_groups

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

Overview

Namesub_package_groups
TypeResource
Idaws.codeartifact.sub_package_groups

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
arnstringThe ARN of the package group. (pattern: <code>\S+</code>)
contact_infostringThe contact information of the package group. (pattern: <code>\P{C}*</code>)
created_timestring (date-time)A timestamp that represents the date and time the repository was created.
descriptionstringThe description of the package group. (pattern: <code>\P{C}*</code>)
domain_namestringThe domain that contains the package group. (pattern: <code>[a-z][a-z0-9-]{0,48}[a-z0-9]</code>)
domain_ownerstringThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. (pattern: <code>[0-9]{12}</code>)
origin_configurationobjectDetails about the package origin configuration of a package group.
parentobjectThe direct parent package group of the package group.
pattern_stringThe pattern of the package group. The pattern determines which packages are associated with the package group. (pattern: <code>[^\p{C}\p{IsWhitespace}]+</code>)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_sub_package_groupsselectdomain, package-group, regiondomain-owner, max-results, next-tokenReturns a list of direct children of the specified package group. For information package group hierarchy, 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.

NameDatatypeDescription
domainstringThe name of the domain which contains the package group from which to list sub package groups.
package-groupstringThe pattern of the package group from which to list sub package groups.
regionstringAWS region (default: us-east-1)
domain-ownerstringThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
max-resultsintegerThe maximum number of results to return per page.
next-tokenstringThe 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

Returns a list of direct children of the specified package group. For information package group hierarchy, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

SELECT
arn,
contact_info,
created_time,
description,
domain_name,
domain_owner,
origin_configuration,
parent,
pattern_
FROM aws.codeartifact.sub_package_groups
WHERE domain = '{{ domain }}' -- required
AND `package-group` = '{{ package-group }}' -- required
AND region = '{{ region }}' -- required
AND `domain-owner` = '{{ domain-owner }}'
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;