sub_package_groups
Creates, updates, deletes, gets or lists a sub_package_groups resource.
Overview
| Name | sub_package_groups |
| Type | Resource |
| Id | aws.codeartifact.sub_package_groups |
Fields
The following fields are returned by SELECT queries:
- list_sub_package_groups
| Name | Datatype | Description |
|---|---|---|
arn | string | The ARN of the package group. (pattern: <code>\S+</code>) |
contact_info | string | The contact information of the package group. (pattern: <code>\P{C}*</code>) |
created_time | string (date-time) | A timestamp that represents the date and time the repository was created. |
description | string | The description of the package group. (pattern: <code>\P{C}*</code>) |
domain_name | string | The domain that contains the package group. (pattern: <code>[a-z][a-z0-9-]{0,48}[a-z0-9]</code>) |
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. (pattern: <code>[0-9]{12}</code>) |
origin_configuration | object | Details about the package origin configuration of a package group. |
parent | object | The direct parent package group of the package group. |
pattern_ | string | The 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:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_sub_package_groups | select | domain, package-group, region | domain-owner, max-results, next-token | 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. |
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 which contains the package group from which to list sub package groups. |
package-group | string | The pattern of the package group from which to list sub package groups. |
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. |
max-results | integer | The maximum number of results to return per page. |
next-token | string | 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. |
SELECT examples
- list_sub_package_groups
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 }}'
;