1---2name: aws-resource-groups3description: AWS Resource Groups API skill. Use when working with AWS Resource Groups for groups, delete-group, get-account-settings. Covers 18 endpoints.4---5
6# AWS Resource Groups
7API version: 2017-11-27
8
9## Auth
10AWS SigV4
11
12## Base URL
13Not specified.
14
15## Setup
161. Configure auth: AWS SigV4
172. GET /resources/{Arn}/tags -- verify access
183. POST /groups -- create first groups
19
20## Endpoints
21
2218 endpoints across 15 groups. See references/api-spec.lap for full details.
23
24### groups
25| Method | Path | Description |
26|--------|------|-------------|
27| POST | /groups | Creates a resource group with the specified name and description. You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide. For more information about service-linked groups and service configurations, see Service configurations for Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:CreateGroup |
28
29### delete-group
30| Method | Path | Description |
31|--------|------|-------------|
32| POST | /delete-group | Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure. Minimum permissions To run this command, you must have the following permissions: resource-groups:DeleteGroup |
33
34### get-account-settings
35| Method | Path | Description |
36|--------|------|-------------|
37| POST | /get-account-settings | Retrieves the current status of optional features in Resource Groups. |
38
39### get-group
40| Method | Path | Description |
41|--------|------|-------------|
42| POST | /get-group | Returns information about a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroup |
43
44### get-group-configuration
45| Method | Path | Description |
46|--------|------|-------------|
47| POST | /get-group-configuration | Retrieves the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroupConfiguration |
48
49### get-group-query
50| Method | Path | Description |
51|--------|------|-------------|
52| POST | /get-group-query | Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroupQuery |
53
54### resources
55| Method | Path | Description |
56|--------|------|-------------|
57| GET | /resources/{Arn}/tags | Returns a list of tags that are associated with a resource group, specified by an ARN. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetTags |
58| POST | /resources/search | Returns a list of Amazon Web Services resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation. Minimum permissions To run this command, you must have the following permissions: resource-groups:SearchResources cloudformation:DescribeStacks cloudformation:ListStackResources tag:GetResources |
59| PUT | /resources/{Arn}/tags | Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters. Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data. Minimum permissions To run this command, you must have the following permissions: resource-groups:Tag |
60| PATCH | /resources/{Arn}/tags | Deletes tags from a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:Untag |
61
62### group-resources
63| Method | Path | Description |
64|--------|------|-------------|
65| POST | /group-resources | Adds the specified resources to the specified group. You can use this operation with only resource groups that are configured with the following types: AWS::EC2::HostManagement AWS::EC2::CapacityReservationPool Other resource group type and resource types aren't currently supported by this operation. Minimum permissions To run this command, you must have the following permissions: resource-groups:GroupResources |
66
67### list-group-resources
68| Method | Path | Description |
69|--------|------|-------------|
70| POST | /list-group-resources | Returns a list of ARNs of the resources that are members of a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:ListGroupResources cloudformation:DescribeStacks cloudformation:ListStackResources tag:GetResources |
71
72### groups-list
73| Method | Path | Description |
74|--------|------|-------------|
75| POST | /groups-list | Returns a list of existing Resource Groups in your account. Minimum permissions To run this command, you must have the following permissions: resource-groups:ListGroups |
76
77### put-group-configuration
78| Method | Path | Description |
79|--------|------|-------------|
80| POST | /put-group-configuration | Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update. Minimum permissions To run this command, you must have the following permissions: resource-groups:PutGroupConfiguration |
81
82### ungroup-resources
83| Method | Path | Description |
84|--------|------|-------------|
85| POST | /ungroup-resources | Removes the specified resources from the specified group. This operation works only with static groups that you populated using the GroupResources operation. It doesn't work with any resource groups that are automatically populated by tag-based or CloudFormation stack-based queries. Minimum permissions To run this command, you must have the following permissions: resource-groups:UngroupResources |
86
87### update-account-settings
88| Method | Path | Description |
89|--------|------|-------------|
90| POST | /update-account-settings | Turns on or turns off optional features in Resource Groups. The preceding example shows that the request to turn on group lifecycle events is IN_PROGRESS. You can call the GetAccountSettings operation to check for completion by looking for GroupLifecycleEventsStatus to change to ACTIVE. |
91
92### update-group
93| Method | Path | Description |
94|--------|------|-------------|
95| POST | /update-group | Updates the description for an existing group. You cannot update the name of a resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:UpdateGroup |
96
97### update-group-query
98| Method | Path | Description |
99|--------|------|-------------|
100| POST | /update-group-query | Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:UpdateGroupQuery |
101
102## Common Questions
103
104Match user requests to endpoints in references/api-spec.lap. Key patterns:
105- "Create a group?" -> POST /groups
106- "Create a delete-group?" -> POST /delete-group
107- "Create a get-account-setting?" -> POST /get-account-settings
108- "Create a get-group?" -> POST /get-group
109- "Create a get-group-configuration?" -> POST /get-group-configuration
110- "Create a get-group-query?" -> POST /get-group-query
111- "List all tags?" -> GET /resources/{Arn}/tags
112- "Create a group-resource?" -> POST /group-resources
113- "Create a list-group-resource?" -> POST /list-group-resources
114- "Create a groups-list?" -> POST /groups-list
115- "Create a put-group-configuration?" -> POST /put-group-configuration
116- "Create a search?" -> POST /resources/search
117- "Create a ungroup-resource?" -> POST /ungroup-resources
118- "Create a update-account-setting?" -> POST /update-account-settings
119- "Create a update-group?" -> POST /update-group
120- "Create a update-group-query?" -> POST /update-group-query
121- "How to authenticate?" -> See Auth section
122
123## Response Tips
124- Check response schemas in references/api-spec.lap for field details
125- Create/update endpoints typically return the created/updated object
126
127## References
128- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
129
130> Generated from the official API spec by [LAP](https://lap.sh)
Lap-Platform