@aws-sdk/client-resource-groups 3.245.0 → 3.252.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/README.md +8 -10
  2. package/dist-cjs/ResourceGroups.js +30 -0
  3. package/dist-cjs/commands/GetAccountSettingsCommand.js +46 -0
  4. package/dist-cjs/commands/UpdateAccountSettingsCommand.js +46 -0
  5. package/dist-cjs/commands/index.js +2 -0
  6. package/dist-cjs/endpoint/ruleset.js +3 -3
  7. package/dist-cjs/models/models_0.js +31 -2
  8. package/dist-cjs/protocols/Aws_restJson1.js +142 -1
  9. package/dist-es/ResourceGroups.js +30 -0
  10. package/dist-es/commands/GetAccountSettingsCommand.js +42 -0
  11. package/dist-es/commands/UpdateAccountSettingsCommand.js +42 -0
  12. package/dist-es/commands/index.js +2 -0
  13. package/dist-es/endpoint/ruleset.js +3 -3
  14. package/dist-es/models/models_0.js +25 -0
  15. package/dist-es/protocols/Aws_restJson1.js +137 -0
  16. package/dist-types/ResourceGroups.d.ts +120 -84
  17. package/dist-types/ResourceGroupsClient.d.ts +18 -18
  18. package/dist-types/commands/CreateGroupCommand.d.ts +7 -7
  19. package/dist-types/commands/DeleteGroupCommand.d.ts +3 -3
  20. package/dist-types/commands/GetAccountSettingsCommand.d.ts +37 -0
  21. package/dist-types/commands/GetGroupCommand.d.ts +3 -3
  22. package/dist-types/commands/GetGroupConfigurationCommand.d.ts +5 -6
  23. package/dist-types/commands/GetGroupQueryCommand.d.ts +3 -3
  24. package/dist-types/commands/GetTagsCommand.d.ts +3 -3
  25. package/dist-types/commands/GroupResourcesCommand.d.ts +21 -3
  26. package/dist-types/commands/ListGroupResourcesCommand.d.ts +6 -6
  27. package/dist-types/commands/ListGroupsCommand.d.ts +4 -4
  28. package/dist-types/commands/PutGroupConfigurationCommand.d.ts +3 -3
  29. package/dist-types/commands/SearchResourcesCommand.d.ts +9 -9
  30. package/dist-types/commands/TagCommand.d.ts +5 -5
  31. package/dist-types/commands/UngroupResourcesCommand.d.ts +7 -4
  32. package/dist-types/commands/UntagCommand.d.ts +3 -3
  33. package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +41 -0
  34. package/dist-types/commands/UpdateGroupCommand.d.ts +3 -3
  35. package/dist-types/commands/UpdateGroupQueryCommand.d.ts +3 -3
  36. package/dist-types/commands/index.d.ts +2 -0
  37. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  38. package/dist-types/models/models_0.d.ts +251 -207
  39. package/dist-types/protocols/Aws_restJson1.d.ts +6 -0
  40. package/dist-types/ts3.4/ResourceGroups.d.ts +34 -0
  41. package/dist-types/ts3.4/ResourceGroupsClient.d.ts +12 -0
  42. package/dist-types/ts3.4/commands/GetAccountSettingsCommand.d.ts +34 -0
  43. package/dist-types/ts3.4/commands/UpdateAccountSettingsCommand.d.ts +41 -0
  44. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  45. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  46. package/dist-types/ts3.4/models/models_0.d.ts +41 -0
  47. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  48. package/package.json +4 -4
@@ -8,16 +8,15 @@ export interface GetGroupConfigurationCommandInput extends GetGroupConfiguration
8
8
  export interface GetGroupConfigurationCommandOutput extends GetGroupConfigurationOutput, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Returns the service configuration associated with the specified resource group. For
12
- * details about the service configuration syntax, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for resource
13
- * groups</a>.</p>
14
- * <p>
11
+ * <p>Retrieves the service configuration associated with the specified resource group. For
12
+ * details about the service configuration syntax, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for Resource Groups</a>.</p>
13
+ * <p>
15
14
  * <b>Minimum permissions</b>
16
15
  * </p>
17
16
  * <p>To run this command, you must have the following permissions:</p>
18
- * <ul>
17
+ * <ul>
19
18
  * <li>
20
- * <p>
19
+ * <p>
21
20
  * <code>resource-groups:GetGroupConfiguration</code>
22
21
  * </p>
23
22
  * </li>
@@ -11,13 +11,13 @@ export interface GetGroupQueryCommandOutput extends GetGroupQueryOutput, __Metad
11
11
  * <p>Retrieves the resource query associated with the specified resource group. For more
12
12
  * information about resource queries, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag">Create
13
13
  * a tag-based group in Resource Groups</a>.</p>
14
- * <p>
14
+ * <p>
15
15
  * <b>Minimum permissions</b>
16
16
  * </p>
17
17
  * <p>To run this command, you must have the following permissions:</p>
18
- * <ul>
18
+ * <ul>
19
19
  * <li>
20
- * <p>
20
+ * <p>
21
21
  * <code>resource-groups:GetGroupQuery</code>
22
22
  * </p>
23
23
  * </li>
@@ -10,13 +10,13 @@ export interface GetTagsCommandOutput extends GetTagsOutput, __MetadataBearer {
10
10
  /**
11
11
  * <p>Returns a list of tags that are associated with a resource group, specified by an
12
12
  * ARN.</p>
13
- * <p>
13
+ * <p>
14
14
  * <b>Minimum permissions</b>
15
15
  * </p>
16
16
  * <p>To run this command, you must have the following permissions:</p>
17
- * <ul>
17
+ * <ul>
18
18
  * <li>
19
- * <p>
19
+ * <p>
20
20
  * <code>resource-groups:GetTags</code>
21
21
  * </p>
22
22
  * </li>
@@ -9,13 +9,31 @@ export interface GroupResourcesCommandOutput extends GroupResourcesOutput, __Met
9
9
  }
10
10
  /**
11
11
  * <p>Adds the specified resources to the specified group.</p>
12
- * <p>
12
+ * <important>
13
+ * <p>You can use this operation with only resource groups that are configured with the
14
+ * following types:</p>
15
+ * <ul>
16
+ * <li>
17
+ * <p>
18
+ * <code>AWS::EC2::HostManagement</code>
19
+ * </p>
20
+ * </li>
21
+ * <li>
22
+ * <p>
23
+ * <code>AWS::EC2::CapacityReservationPool</code>
24
+ * </p>
25
+ * </li>
26
+ * </ul>
27
+ * <p>Other resource group type and resource types aren't currently supported by this
28
+ * operation.</p>
29
+ * </important>
30
+ * <p>
13
31
  * <b>Minimum permissions</b>
14
32
  * </p>
15
33
  * <p>To run this command, you must have the following permissions:</p>
16
- * <ul>
34
+ * <ul>
17
35
  * <li>
18
- * <p>
36
+ * <p>
19
37
  * <code>resource-groups:GroupResources</code>
20
38
  * </p>
21
39
  * </li>
@@ -10,28 +10,28 @@ export interface ListGroupResourcesCommandOutput extends ListGroupResourcesOutpu
10
10
  /**
11
11
  * <p>Returns a list of ARNs of the resources that are members of a specified resource
12
12
  * group.</p>
13
- * <p>
13
+ * <p>
14
14
  * <b>Minimum permissions</b>
15
15
  * </p>
16
16
  * <p>To run this command, you must have the following permissions:</p>
17
- * <ul>
17
+ * <ul>
18
18
  * <li>
19
- * <p>
19
+ * <p>
20
20
  * <code>resource-groups:ListGroupResources</code>
21
21
  * </p>
22
22
  * </li>
23
23
  * <li>
24
- * <p>
24
+ * <p>
25
25
  * <code>cloudformation:DescribeStacks</code>
26
26
  * </p>
27
27
  * </li>
28
28
  * <li>
29
- * <p>
29
+ * <p>
30
30
  * <code>cloudformation:ListStackResources</code>
31
31
  * </p>
32
32
  * </li>
33
33
  * <li>
34
- * <p>
34
+ * <p>
35
35
  * <code>tag:GetResources</code>
36
36
  * </p>
37
37
  * </li>
@@ -8,14 +8,14 @@ export interface ListGroupsCommandInput extends ListGroupsInput {
8
8
  export interface ListGroupsCommandOutput extends ListGroupsOutput, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Returns a list of existing resource groups in your account.</p>
12
- * <p>
11
+ * <p>Returns a list of existing Resource Groups in your account.</p>
12
+ * <p>
13
13
  * <b>Minimum permissions</b>
14
14
  * </p>
15
15
  * <p>To run this command, you must have the following permissions:</p>
16
- * <ul>
16
+ * <ul>
17
17
  * <li>
18
- * <p>
18
+ * <p>
19
19
  * <code>resource-groups:ListGroups</code>
20
20
  * </p>
21
21
  * </li>
@@ -11,13 +11,13 @@ export interface PutGroupConfigurationCommandOutput extends PutGroupConfiguratio
11
11
  * <p>Attaches a service configuration to the specified group. This occurs asynchronously,
12
12
  * and can take time to complete. You can use <a>GetGroupConfiguration</a> to
13
13
  * check the status of the update.</p>
14
- * <p>
14
+ * <p>
15
15
  * <b>Minimum permissions</b>
16
16
  * </p>
17
17
  * <p>To run this command, you must have the following permissions:</p>
18
- * <ul>
18
+ * <ul>
19
19
  * <li>
20
- * <p>
20
+ * <p>
21
21
  * <code>resource-groups:PutGroupConfiguration</code>
22
22
  * </p>
23
23
  * </li>
@@ -8,31 +8,31 @@ export interface SearchResourcesCommandInput extends SearchResourcesInput {
8
8
  export interface SearchResourcesCommandOutput extends SearchResourcesOutput, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Returns a list of AWS resource identifiers that matches the specified query. The
12
- * query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery
13
- * operation.</p>
14
- * <p>
11
+ * <p>Returns a list of Amazon Web Services resource identifiers that matches the specified query. The
12
+ * query uses the same format as a resource query in a <a>CreateGroup</a> or
13
+ * <a>UpdateGroupQuery</a> operation.</p>
14
+ * <p>
15
15
  * <b>Minimum permissions</b>
16
16
  * </p>
17
17
  * <p>To run this command, you must have the following permissions:</p>
18
- * <ul>
18
+ * <ul>
19
19
  * <li>
20
- * <p>
20
+ * <p>
21
21
  * <code>resource-groups:SearchResources</code>
22
22
  * </p>
23
23
  * </li>
24
24
  * <li>
25
- * <p>
25
+ * <p>
26
26
  * <code>cloudformation:DescribeStacks</code>
27
27
  * </p>
28
28
  * </li>
29
29
  * <li>
30
- * <p>
30
+ * <p>
31
31
  * <code>cloudformation:ListStackResources</code>
32
32
  * </p>
33
33
  * </li>
34
34
  * <li>
35
- * <p>
35
+ * <p>
36
36
  * <code>tag:GetResources</code>
37
37
  * </p>
38
38
  * </li>
@@ -10,19 +10,19 @@ export interface TagCommandOutput extends TagOutput, __MetadataBearer {
10
10
  /**
11
11
  * <p>Adds tags to a resource group with the specified ARN. Existing tags on a resource
12
12
  * group are not changed if they are not specified in the request parameters.</p>
13
- * <important>
13
+ * <important>
14
14
  * <p>Do not store personally identifiable information (PII) or other confidential or
15
15
  * sensitive information in tags. We use tags to provide you with billing and
16
16
  * administration services. Tags are not intended to be used for private or sensitive
17
17
  * data.</p>
18
- * </important>
19
- * <p>
18
+ * </important>
19
+ * <p>
20
20
  * <b>Minimum permissions</b>
21
21
  * </p>
22
22
  * <p>To run this command, you must have the following permissions:</p>
23
- * <ul>
23
+ * <ul>
24
24
  * <li>
25
- * <p>
25
+ * <p>
26
26
  * <code>resource-groups:Tag</code>
27
27
  * </p>
28
28
  * </li>
@@ -8,14 +8,17 @@ export interface UngroupResourcesCommandInput extends UngroupResourcesInput {
8
8
  export interface UngroupResourcesCommandOutput extends UngroupResourcesOutput, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Removes the specified resources from the specified group.</p>
12
- * <p>
11
+ * <p>Removes the specified resources from the specified group. This operation works only
12
+ * with static groups that you populated using the <a>GroupResources</a>
13
+ * operation. It doesn't work with any resource groups that are automatically populated by
14
+ * tag-based or CloudFormation stack-based queries.</p>
15
+ * <p>
13
16
  * <b>Minimum permissions</b>
14
17
  * </p>
15
18
  * <p>To run this command, you must have the following permissions:</p>
16
- * <ul>
19
+ * <ul>
17
20
  * <li>
18
- * <p>
21
+ * <p>
19
22
  * <code>resource-groups:UngroupResources</code>
20
23
  * </p>
21
24
  * </li>
@@ -9,13 +9,13 @@ export interface UntagCommandOutput extends UntagOutput, __MetadataBearer {
9
9
  }
10
10
  /**
11
11
  * <p>Deletes tags from a specified resource group.</p>
12
- * <p>
12
+ * <p>
13
13
  * <b>Minimum permissions</b>
14
14
  * </p>
15
15
  * <p>To run this command, you must have the following permissions:</p>
16
- * <ul>
16
+ * <ul>
17
17
  * <li>
18
- * <p>
18
+ * <p>
19
19
  * <code>resource-groups:Untag</code>
20
20
  * </p>
21
21
  * </li>
@@ -0,0 +1,41 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { UpdateAccountSettingsInput, UpdateAccountSettingsOutput } from "../models/models_0";
5
+ import { ResourceGroupsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ResourceGroupsClient";
6
+ export interface UpdateAccountSettingsCommandInput extends UpdateAccountSettingsInput {
7
+ }
8
+ export interface UpdateAccountSettingsCommandOutput extends UpdateAccountSettingsOutput, __MetadataBearer {
9
+ }
10
+ /**
11
+ * <p>Turns on or turns off optional features in Resource Groups.</p>
12
+ * <p>The preceding example shows that the request to turn on group lifecycle events is
13
+ * <code>IN_PROGRESS</code>. You can call the <a>GetAccountSettings</a>
14
+ * operation to check for completion by looking for <code>GroupLifecycleEventsStatus</code>
15
+ * to change to <code>ACTIVE</code>.</p>
16
+ * @example
17
+ * Use a bare-bones client and the command you need to make an API call.
18
+ * ```javascript
19
+ * import { ResourceGroupsClient, UpdateAccountSettingsCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import
20
+ * // const { ResourceGroupsClient, UpdateAccountSettingsCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import
21
+ * const client = new ResourceGroupsClient(config);
22
+ * const command = new UpdateAccountSettingsCommand(input);
23
+ * const response = await client.send(command);
24
+ * ```
25
+ *
26
+ * @see {@link UpdateAccountSettingsCommandInput} for command's `input` shape.
27
+ * @see {@link UpdateAccountSettingsCommandOutput} for command's `response` shape.
28
+ * @see {@link ResourceGroupsClientResolvedConfig | config} for ResourceGroupsClient's `config` shape.
29
+ *
30
+ */
31
+ export declare class UpdateAccountSettingsCommand extends $Command<UpdateAccountSettingsCommandInput, UpdateAccountSettingsCommandOutput, ResourceGroupsClientResolvedConfig> {
32
+ readonly input: UpdateAccountSettingsCommandInput;
33
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
34
+ constructor(input: UpdateAccountSettingsCommandInput);
35
+ /**
36
+ * @internal
37
+ */
38
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ResourceGroupsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAccountSettingsCommandInput, UpdateAccountSettingsCommandOutput>;
39
+ private serialize;
40
+ private deserialize;
41
+ }
@@ -10,13 +10,13 @@ export interface UpdateGroupCommandOutput extends UpdateGroupOutput, __MetadataB
10
10
  /**
11
11
  * <p>Updates the description for an existing group. You cannot update the name of a
12
12
  * resource group.</p>
13
- * <p>
13
+ * <p>
14
14
  * <b>Minimum permissions</b>
15
15
  * </p>
16
16
  * <p>To run this command, you must have the following permissions:</p>
17
- * <ul>
17
+ * <ul>
18
18
  * <li>
19
- * <p>
19
+ * <p>
20
20
  * <code>resource-groups:UpdateGroup</code>
21
21
  * </p>
22
22
  * </li>
@@ -10,13 +10,13 @@ export interface UpdateGroupQueryCommandOutput extends UpdateGroupQueryOutput, _
10
10
  /**
11
11
  * <p>Updates the resource query of a group. For more information about resource queries,
12
12
  * see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag">Create a tag-based group in Resource Groups</a>.</p>
13
- * <p>
13
+ * <p>
14
14
  * <b>Minimum permissions</b>
15
15
  * </p>
16
16
  * <p>To run this command, you must have the following permissions:</p>
17
- * <ul>
17
+ * <ul>
18
18
  * <li>
19
- * <p>
19
+ * <p>
20
20
  * <code>resource-groups:UpdateGroupQuery</code>
21
21
  * </p>
22
22
  * </li>
@@ -1,5 +1,6 @@
1
1
  export * from "./CreateGroupCommand";
2
2
  export * from "./DeleteGroupCommand";
3
+ export * from "./GetAccountSettingsCommand";
3
4
  export * from "./GetGroupCommand";
4
5
  export * from "./GetGroupConfigurationCommand";
5
6
  export * from "./GetGroupQueryCommand";
@@ -12,5 +13,6 @@ export * from "./SearchResourcesCommand";
12
13
  export * from "./TagCommand";
13
14
  export * from "./UngroupResourcesCommand";
14
15
  export * from "./UntagCommand";
16
+ export * from "./UpdateAccountSettingsCommand";
15
17
  export * from "./UpdateGroupCommand";
16
18
  export * from "./UpdateGroupQueryCommand";
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region?: string;
15
+ Region: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;