@aws-sdk/client-resource-groups 3.658.0 → 3.661.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 (51) hide show
  1. package/README.md +41 -1
  2. package/dist-cjs/index.js +367 -35
  3. package/dist-es/ResourceGroups.js +10 -0
  4. package/dist-es/commands/CancelTagSyncTaskCommand.js +22 -0
  5. package/dist-es/commands/GetTagSyncTaskCommand.js +22 -0
  6. package/dist-es/commands/ListGroupingStatusesCommand.js +22 -0
  7. package/dist-es/commands/ListTagSyncTasksCommand.js +22 -0
  8. package/dist-es/commands/StartTagSyncTaskCommand.js +22 -0
  9. package/dist-es/commands/index.js +5 -0
  10. package/dist-es/models/models_0.js +43 -22
  11. package/dist-es/pagination/ListGroupingStatusesPaginator.js +4 -0
  12. package/dist-es/pagination/ListTagSyncTasksPaginator.js +4 -0
  13. package/dist-es/pagination/index.js +2 -0
  14. package/dist-es/protocols/Aws_restJson1.js +204 -9
  15. package/dist-types/ResourceGroups.d.ts +37 -1
  16. package/dist-types/ResourceGroupsClient.d.ts +8 -3
  17. package/dist-types/commands/CancelTagSyncTaskCommand.d.ts +104 -0
  18. package/dist-types/commands/CreateGroupCommand.d.ts +9 -0
  19. package/dist-types/commands/DeleteGroupCommand.d.ts +6 -0
  20. package/dist-types/commands/GetGroupCommand.d.ts +6 -0
  21. package/dist-types/commands/GetTagSyncTaskCommand.d.ts +112 -0
  22. package/dist-types/commands/GetTagsCommand.d.ts +1 -1
  23. package/dist-types/commands/GroupResourcesCommand.d.ts +7 -3
  24. package/dist-types/commands/ListGroupResourcesCommand.d.ts +1 -1
  25. package/dist-types/commands/ListGroupingStatusesCommand.d.ts +109 -0
  26. package/dist-types/commands/ListGroupsCommand.d.ts +11 -1
  27. package/dist-types/commands/ListTagSyncTasksCommand.d.ts +122 -0
  28. package/dist-types/commands/StartTagSyncTaskCommand.d.ts +122 -0
  29. package/dist-types/commands/TagCommand.d.ts +1 -1
  30. package/dist-types/commands/UpdateGroupCommand.d.ts +9 -0
  31. package/dist-types/commands/index.d.ts +5 -0
  32. package/dist-types/index.d.ts +1 -1
  33. package/dist-types/models/models_0.d.ts +622 -93
  34. package/dist-types/pagination/ListGroupingStatusesPaginator.d.ts +7 -0
  35. package/dist-types/pagination/ListTagSyncTasksPaginator.d.ts +7 -0
  36. package/dist-types/pagination/index.d.ts +2 -0
  37. package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
  38. package/dist-types/ts3.4/ResourceGroups.d.ts +86 -0
  39. package/dist-types/ts3.4/ResourceGroupsClient.d.ts +30 -0
  40. package/dist-types/ts3.4/commands/CancelTagSyncTaskCommand.d.ts +45 -0
  41. package/dist-types/ts3.4/commands/GetTagSyncTaskCommand.d.ts +47 -0
  42. package/dist-types/ts3.4/commands/ListGroupingStatusesCommand.d.ts +51 -0
  43. package/dist-types/ts3.4/commands/ListTagSyncTasksCommand.d.ts +50 -0
  44. package/dist-types/ts3.4/commands/StartTagSyncTaskCommand.d.ts +50 -0
  45. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  46. package/dist-types/ts3.4/models/models_0.d.ts +158 -38
  47. package/dist-types/ts3.4/pagination/ListGroupingStatusesPaginator.d.ts +11 -0
  48. package/dist-types/ts3.4/pagination/ListTagSyncTasksPaginator.d.ts +11 -0
  49. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  50. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
  51. package/package.json +12 -12
@@ -0,0 +1,122 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ListTagSyncTasksInput, ListTagSyncTasksOutput } from "../models/models_0";
4
+ import { ResourceGroupsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ResourceGroupsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListTagSyncTasksCommand}.
14
+ */
15
+ export interface ListTagSyncTasksCommandInput extends ListTagSyncTasksInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListTagSyncTasksCommand}.
21
+ */
22
+ export interface ListTagSyncTasksCommandOutput extends ListTagSyncTasksOutput, __MetadataBearer {
23
+ }
24
+ declare const ListTagSyncTasksCommand_base: {
25
+ new (input: ListTagSyncTasksCommandInput): import("@smithy/smithy-client").CommandImpl<ListTagSyncTasksCommandInput, ListTagSyncTasksCommandOutput, ResourceGroupsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [ListTagSyncTasksCommandInput]): import("@smithy/smithy-client").CommandImpl<ListTagSyncTasksCommandInput, ListTagSyncTasksCommandOutput, ResourceGroupsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns a list of tag-sync tasks. </p>
31
+ * <p>
32
+ * <b>Minimum permissions</b>
33
+ * </p>
34
+ * <p>To run this command, you must have the following permissions:</p>
35
+ * <ul>
36
+ * <li>
37
+ * <p>
38
+ * <code>resource-groups:ListTagSyncTasks</code> with the group passed in the filters as the resource
39
+ * or * if using no filters </p>
40
+ * </li>
41
+ * </ul>
42
+ * @example
43
+ * Use a bare-bones client and the command you need to make an API call.
44
+ * ```javascript
45
+ * import { ResourceGroupsClient, ListTagSyncTasksCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import
46
+ * // const { ResourceGroupsClient, ListTagSyncTasksCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import
47
+ * const client = new ResourceGroupsClient(config);
48
+ * const input = { // ListTagSyncTasksInput
49
+ * Filters: [ // ListTagSyncTasksFilterList
50
+ * { // ListTagSyncTasksFilter
51
+ * GroupArn: "STRING_VALUE",
52
+ * GroupName: "STRING_VALUE",
53
+ * },
54
+ * ],
55
+ * MaxResults: Number("int"),
56
+ * NextToken: "STRING_VALUE",
57
+ * };
58
+ * const command = new ListTagSyncTasksCommand(input);
59
+ * const response = await client.send(command);
60
+ * // { // ListTagSyncTasksOutput
61
+ * // TagSyncTasks: [ // TagSyncTaskList
62
+ * // { // TagSyncTaskItem
63
+ * // GroupArn: "STRING_VALUE",
64
+ * // GroupName: "STRING_VALUE",
65
+ * // TaskArn: "STRING_VALUE",
66
+ * // TagKey: "STRING_VALUE",
67
+ * // TagValue: "STRING_VALUE",
68
+ * // RoleArn: "STRING_VALUE",
69
+ * // Status: "ACTIVE" || "ERROR",
70
+ * // ErrorMessage: "STRING_VALUE",
71
+ * // CreatedAt: new Date("TIMESTAMP"),
72
+ * // },
73
+ * // ],
74
+ * // NextToken: "STRING_VALUE",
75
+ * // };
76
+ *
77
+ * ```
78
+ *
79
+ * @param ListTagSyncTasksCommandInput - {@link ListTagSyncTasksCommandInput}
80
+ * @returns {@link ListTagSyncTasksCommandOutput}
81
+ * @see {@link ListTagSyncTasksCommandInput} for command's `input` shape.
82
+ * @see {@link ListTagSyncTasksCommandOutput} for command's `response` shape.
83
+ * @see {@link ResourceGroupsClientResolvedConfig | config} for ResourceGroupsClient's `config` shape.
84
+ *
85
+ * @throws {@link BadRequestException} (client fault)
86
+ * <p>The request includes one or more parameters that violate validation rules.</p>
87
+ *
88
+ * @throws {@link ForbiddenException} (client fault)
89
+ * <p>The caller isn't authorized to make the request. Check permissions.</p>
90
+ *
91
+ * @throws {@link InternalServerErrorException} (server fault)
92
+ * <p>An internal error occurred while processing the request. Try again later.</p>
93
+ *
94
+ * @throws {@link MethodNotAllowedException} (client fault)
95
+ * <p>The request uses an HTTP method that isn't allowed for the specified resource.</p>
96
+ *
97
+ * @throws {@link TooManyRequestsException} (client fault)
98
+ * <p>You've exceeded throttling limits by making too many requests in a period of
99
+ * time.</p>
100
+ *
101
+ * @throws {@link UnauthorizedException} (client fault)
102
+ * <p>The request was rejected because it doesn't have valid credentials for the target
103
+ * resource.</p>
104
+ *
105
+ * @throws {@link ResourceGroupsServiceException}
106
+ * <p>Base exception class for all service exceptions from ResourceGroups service.</p>
107
+ *
108
+ * @public
109
+ */
110
+ export declare class ListTagSyncTasksCommand extends ListTagSyncTasksCommand_base {
111
+ /** @internal type navigation helper, not in runtime. */
112
+ protected static __types: {
113
+ api: {
114
+ input: ListTagSyncTasksInput;
115
+ output: ListTagSyncTasksOutput;
116
+ };
117
+ sdk: {
118
+ input: ListTagSyncTasksCommandInput;
119
+ output: ListTagSyncTasksCommandOutput;
120
+ };
121
+ };
122
+ }
@@ -0,0 +1,122 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { StartTagSyncTaskInput, StartTagSyncTaskOutput } from "../models/models_0";
4
+ import { ResourceGroupsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ResourceGroupsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StartTagSyncTaskCommand}.
14
+ */
15
+ export interface StartTagSyncTaskCommandInput extends StartTagSyncTaskInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StartTagSyncTaskCommand}.
21
+ */
22
+ export interface StartTagSyncTaskCommandOutput extends StartTagSyncTaskOutput, __MetadataBearer {
23
+ }
24
+ declare const StartTagSyncTaskCommand_base: {
25
+ new (input: StartTagSyncTaskCommandInput): import("@smithy/smithy-client").CommandImpl<StartTagSyncTaskCommandInput, StartTagSyncTaskCommandOutput, ResourceGroupsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: StartTagSyncTaskCommandInput): import("@smithy/smithy-client").CommandImpl<StartTagSyncTaskCommandInput, StartTagSyncTaskCommandOutput, ResourceGroupsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an
31
+ * application. </p>
32
+ * <p>
33
+ * <b>Minimum permissions</b>
34
+ * </p>
35
+ * <p>To run this command, you must have the following permissions:</p>
36
+ * <ul>
37
+ * <li>
38
+ * <p>
39
+ * <code>resource-groups:StartTagSyncTask</code> on the application group</p>
40
+ * </li>
41
+ * <li>
42
+ * <p>
43
+ * <code>resource-groups:CreateGroup</code>
44
+ * </p>
45
+ * </li>
46
+ * <li>
47
+ * <p>
48
+ * <code>iam:PassRole</code> on the role provided in the request </p>
49
+ * </li>
50
+ * </ul>
51
+ * @example
52
+ * Use a bare-bones client and the command you need to make an API call.
53
+ * ```javascript
54
+ * import { ResourceGroupsClient, StartTagSyncTaskCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import
55
+ * // const { ResourceGroupsClient, StartTagSyncTaskCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import
56
+ * const client = new ResourceGroupsClient(config);
57
+ * const input = { // StartTagSyncTaskInput
58
+ * Group: "STRING_VALUE", // required
59
+ * TagKey: "STRING_VALUE", // required
60
+ * TagValue: "STRING_VALUE", // required
61
+ * RoleArn: "STRING_VALUE", // required
62
+ * };
63
+ * const command = new StartTagSyncTaskCommand(input);
64
+ * const response = await client.send(command);
65
+ * // { // StartTagSyncTaskOutput
66
+ * // GroupArn: "STRING_VALUE",
67
+ * // GroupName: "STRING_VALUE",
68
+ * // TaskArn: "STRING_VALUE",
69
+ * // TagKey: "STRING_VALUE",
70
+ * // TagValue: "STRING_VALUE",
71
+ * // RoleArn: "STRING_VALUE",
72
+ * // };
73
+ *
74
+ * ```
75
+ *
76
+ * @param StartTagSyncTaskCommandInput - {@link StartTagSyncTaskCommandInput}
77
+ * @returns {@link StartTagSyncTaskCommandOutput}
78
+ * @see {@link StartTagSyncTaskCommandInput} for command's `input` shape.
79
+ * @see {@link StartTagSyncTaskCommandOutput} for command's `response` shape.
80
+ * @see {@link ResourceGroupsClientResolvedConfig | config} for ResourceGroupsClient's `config` shape.
81
+ *
82
+ * @throws {@link BadRequestException} (client fault)
83
+ * <p>The request includes one or more parameters that violate validation rules.</p>
84
+ *
85
+ * @throws {@link ForbiddenException} (client fault)
86
+ * <p>The caller isn't authorized to make the request. Check permissions.</p>
87
+ *
88
+ * @throws {@link InternalServerErrorException} (server fault)
89
+ * <p>An internal error occurred while processing the request. Try again later.</p>
90
+ *
91
+ * @throws {@link MethodNotAllowedException} (client fault)
92
+ * <p>The request uses an HTTP method that isn't allowed for the specified resource.</p>
93
+ *
94
+ * @throws {@link NotFoundException} (client fault)
95
+ * <p>One or more of the specified resources don't exist.</p>
96
+ *
97
+ * @throws {@link TooManyRequestsException} (client fault)
98
+ * <p>You've exceeded throttling limits by making too many requests in a period of
99
+ * time.</p>
100
+ *
101
+ * @throws {@link UnauthorizedException} (client fault)
102
+ * <p>The request was rejected because it doesn't have valid credentials for the target
103
+ * resource.</p>
104
+ *
105
+ * @throws {@link ResourceGroupsServiceException}
106
+ * <p>Base exception class for all service exceptions from ResourceGroups service.</p>
107
+ *
108
+ * @public
109
+ */
110
+ export declare class StartTagSyncTaskCommand extends StartTagSyncTaskCommand_base {
111
+ /** @internal type navigation helper, not in runtime. */
112
+ protected static __types: {
113
+ api: {
114
+ input: StartTagSyncTaskInput;
115
+ output: StartTagSyncTaskOutput;
116
+ };
117
+ sdk: {
118
+ input: StartTagSyncTaskCommandInput;
119
+ output: StartTagSyncTaskCommandOutput;
120
+ };
121
+ };
122
+ }
@@ -27,7 +27,7 @@ declare const TagCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Adds tags to a resource group with the specified ARN. Existing tags on a resource
30
+ * <p>Adds tags to a resource group with the specified Amazon resource name (ARN). Existing tags on a resource
31
31
  * group are not changed if they are not specified in the request parameters.</p>
32
32
  * <important>
33
33
  * <p>Do not store personally identifiable information (PII) or other confidential or
@@ -50,6 +50,9 @@ declare const UpdateGroupCommand_base: {
50
50
  * GroupName: "STRING_VALUE",
51
51
  * Group: "STRING_VALUE",
52
52
  * Description: "STRING_VALUE",
53
+ * Criticality: Number("int"),
54
+ * Owner: "STRING_VALUE",
55
+ * DisplayName: "STRING_VALUE",
53
56
  * };
54
57
  * const command = new UpdateGroupCommand(input);
55
58
  * const response = await client.send(command);
@@ -58,6 +61,12 @@ declare const UpdateGroupCommand_base: {
58
61
  * // GroupArn: "STRING_VALUE", // required
59
62
  * // Name: "STRING_VALUE", // required
60
63
  * // Description: "STRING_VALUE",
64
+ * // Criticality: Number("int"),
65
+ * // Owner: "STRING_VALUE",
66
+ * // DisplayName: "STRING_VALUE",
67
+ * // ApplicationTag: { // ApplicationTag
68
+ * // "<keys>": "STRING_VALUE",
69
+ * // },
61
70
  * // },
62
71
  * // };
63
72
  *
@@ -1,15 +1,20 @@
1
+ export * from "./CancelTagSyncTaskCommand";
1
2
  export * from "./CreateGroupCommand";
2
3
  export * from "./DeleteGroupCommand";
3
4
  export * from "./GetAccountSettingsCommand";
4
5
  export * from "./GetGroupCommand";
5
6
  export * from "./GetGroupConfigurationCommand";
6
7
  export * from "./GetGroupQueryCommand";
8
+ export * from "./GetTagSyncTaskCommand";
7
9
  export * from "./GetTagsCommand";
8
10
  export * from "./GroupResourcesCommand";
9
11
  export * from "./ListGroupResourcesCommand";
12
+ export * from "./ListGroupingStatusesCommand";
10
13
  export * from "./ListGroupsCommand";
14
+ export * from "./ListTagSyncTasksCommand";
11
15
  export * from "./PutGroupConfigurationCommand";
12
16
  export * from "./SearchResourcesCommand";
17
+ export * from "./StartTagSyncTaskCommand";
13
18
  export * from "./TagCommand";
14
19
  export * from "./UngroupResourcesCommand";
15
20
  export * from "./UntagCommand";
@@ -23,7 +23,7 @@
23
23
  * <p>Applying, editing, and removing tags from resource groups</p>
24
24
  * </li>
25
25
  * <li>
26
- * <p>Resolving resource group member ARNs so they can be returned as search
26
+ * <p>Resolving resource group member Amazon resource names (ARN)s so they can be returned as search
27
27
  * results</p>
28
28
  * </li>
29
29
  * <li>