@aws-sdk/client-resource-groups-tagging-api 3.933.0 → 3.934.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.
- package/README.md +18 -7
- package/dist-cjs/index.js +102 -10
- package/dist-es/ResourceGroupsTaggingAPI.js +2 -0
- package/dist-es/commands/ListRequiredTagsCommand.js +16 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/pagination/ListRequiredTagsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +87 -10
- package/dist-types/ResourceGroupsTaggingAPI.d.ts +8 -0
- package/dist-types/ResourceGroupsTaggingAPIClient.d.ts +3 -2
- package/dist-types/commands/DescribeReportCreationCommand.d.ts +14 -12
- package/dist-types/commands/GetComplianceSummaryCommand.d.ts +14 -12
- package/dist-types/commands/GetResourcesCommand.d.ts +21 -11
- package/dist-types/commands/GetTagKeysCommand.d.ts +14 -10
- package/dist-types/commands/GetTagValuesCommand.d.ts +14 -10
- package/dist-types/commands/ListRequiredTagsCommand.d.ts +124 -0
- package/dist-types/commands/StartReportCreationCommand.d.ts +26 -15
- package/dist-types/commands/TagResourcesCommand.d.ts +31 -9
- package/dist-types/commands/UntagResourcesCommand.d.ts +20 -9
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +116 -31
- package/dist-types/pagination/ListRequiredTagsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +7 -0
- package/dist-types/ts3.4/ResourceGroupsTaggingAPI.d.ts +18 -0
- package/dist-types/ts3.4/ResourceGroupsTaggingAPIClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/ListRequiredTagsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +13 -0
- package/dist-types/ts3.4/pagination/ListRequiredTagsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +7 -0
- package/package.json +5 -5
|
@@ -92,15 +92,13 @@ declare const GetComplianceSummaryCommand_base: {
|
|
|
92
92
|
* @see {@link ResourceGroupsTaggingAPIClientResolvedConfig | config} for ResourceGroupsTaggingAPIClient's `config` shape.
|
|
93
93
|
*
|
|
94
94
|
* @throws {@link ConstraintViolationException} (client fault)
|
|
95
|
-
* <p>The request
|
|
95
|
+
* <p>The request failed because performing the operation would violate a constraint.</p>
|
|
96
96
|
* <p>Some of the reasons in the following list might not apply to this specific
|
|
97
97
|
* operation.</p>
|
|
98
98
|
* <ul>
|
|
99
99
|
* <li>
|
|
100
100
|
* <p>You must meet the prerequisites for using tag policies. For information, see
|
|
101
|
-
* <a href="https://docs.aws.amazon.com/
|
|
102
|
-
* <i>Organizations User Guide.</i>
|
|
103
|
-
* </p>
|
|
101
|
+
* <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tag-policies-orgs.html#tag-policies-prereqs">Prerequisites and permissions</a> in the <i>Tagging Amazon Web Services resources and Tag Editor</i> user guide. </p>
|
|
104
102
|
* </li>
|
|
105
103
|
* <li>
|
|
106
104
|
* <p>You must enable the tag policies service principal
|
|
@@ -118,30 +116,34 @@ declare const GetComplianceSummaryCommand_base: {
|
|
|
118
116
|
* can retry the request.</p>
|
|
119
117
|
*
|
|
120
118
|
* @throws {@link InvalidParameterException} (client fault)
|
|
121
|
-
* <p>
|
|
119
|
+
* <p>The request failed because of one of the following reasons:</p>
|
|
122
120
|
* <ul>
|
|
123
121
|
* <li>
|
|
124
|
-
* <p>A parameter is missing.</p>
|
|
122
|
+
* <p>A required parameter is missing.</p>
|
|
125
123
|
* </li>
|
|
126
124
|
* <li>
|
|
127
|
-
* <p>A
|
|
125
|
+
* <p>A provided string parameter is malformed.</p>
|
|
128
126
|
* </li>
|
|
129
127
|
* <li>
|
|
130
|
-
* <p>An
|
|
128
|
+
* <p>An provided parameter value is out of range.</p>
|
|
131
129
|
* </li>
|
|
132
130
|
* <li>
|
|
133
131
|
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
134
132
|
* </li>
|
|
135
133
|
* <li>
|
|
136
134
|
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
137
|
-
* <a href="https://docs.aws.amazon.com/
|
|
138
|
-
*
|
|
139
|
-
*
|
|
135
|
+
* <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tag-policies-orgs.html#bucket-policy">Amazon S3 bucket policy for report storage</a> in the <i>Tagging Amazon Web Services resources and Tag Editor</i> user guide. </p>
|
|
136
|
+
* </li>
|
|
137
|
+
* <li>
|
|
138
|
+
* <p>The partition specified in an ARN parameter in the request doesn't match the
|
|
139
|
+
* partition where you invoked the operation. The partition is specified by the
|
|
140
|
+
* second field of the ARN.</p>
|
|
140
141
|
* </li>
|
|
141
142
|
* </ul>
|
|
142
143
|
*
|
|
143
144
|
* @throws {@link ThrottledException} (client fault)
|
|
144
|
-
* <p>The request
|
|
145
|
+
* <p>The request failed because it exceeded the allowed frequency of submitted
|
|
146
|
+
* requests.</p>
|
|
145
147
|
*
|
|
146
148
|
* @throws {@link ResourceGroupsTaggingAPIServiceException}
|
|
147
149
|
* <p>Base exception class for all service exceptions from ResourceGroupsTaggingAPI service.</p>
|
|
@@ -28,7 +28,7 @@ declare const GetResourcesCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Returns all the tagged or previously tagged resources that are located in the
|
|
31
|
-
* specified Amazon Web Services Region for the account
|
|
31
|
+
* specified Amazon Web Services Region for the account. </p>
|
|
32
32
|
* <p>Depending on what information you want returned, you can also specify the
|
|
33
33
|
* following:</p>
|
|
34
34
|
* <ul>
|
|
@@ -51,6 +51,12 @@ declare const GetResourcesCommand_base: {
|
|
|
51
51
|
* <code>PaginationToken</code> response parameter value as an input to the next request until you
|
|
52
52
|
* recieve a <code>null</code> value. A null value for <code>PaginationToken</code> indicates that
|
|
53
53
|
* there are no more results waiting to be returned.</p>
|
|
54
|
+
* <note>
|
|
55
|
+
* <p>
|
|
56
|
+
* <code>GetResources</code> does not return untagged resources. </p>
|
|
57
|
+
* <p>To find untagged resources in your account, use Amazon Web Services Resource Explorer with a
|
|
58
|
+
* query that uses <code>tag:none</code>. For more information, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html"> Search query syntax reference for Resource Explorer</a>. </p>
|
|
59
|
+
* </note>
|
|
54
60
|
* @example
|
|
55
61
|
* Use a bare-bones client and the command you need to make an API call.
|
|
56
62
|
* ```javascript
|
|
@@ -119,34 +125,38 @@ declare const GetResourcesCommand_base: {
|
|
|
119
125
|
* can retry the request.</p>
|
|
120
126
|
*
|
|
121
127
|
* @throws {@link InvalidParameterException} (client fault)
|
|
122
|
-
* <p>
|
|
128
|
+
* <p>The request failed because of one of the following reasons:</p>
|
|
123
129
|
* <ul>
|
|
124
130
|
* <li>
|
|
125
|
-
* <p>A parameter is missing.</p>
|
|
131
|
+
* <p>A required parameter is missing.</p>
|
|
126
132
|
* </li>
|
|
127
133
|
* <li>
|
|
128
|
-
* <p>A
|
|
134
|
+
* <p>A provided string parameter is malformed.</p>
|
|
129
135
|
* </li>
|
|
130
136
|
* <li>
|
|
131
|
-
* <p>An
|
|
137
|
+
* <p>An provided parameter value is out of range.</p>
|
|
132
138
|
* </li>
|
|
133
139
|
* <li>
|
|
134
140
|
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
135
141
|
* </li>
|
|
136
142
|
* <li>
|
|
137
143
|
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
138
|
-
* <a href="https://docs.aws.amazon.com/
|
|
139
|
-
*
|
|
140
|
-
*
|
|
144
|
+
* <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tag-policies-orgs.html#bucket-policy">Amazon S3 bucket policy for report storage</a> in the <i>Tagging Amazon Web Services resources and Tag Editor</i> user guide. </p>
|
|
145
|
+
* </li>
|
|
146
|
+
* <li>
|
|
147
|
+
* <p>The partition specified in an ARN parameter in the request doesn't match the
|
|
148
|
+
* partition where you invoked the operation. The partition is specified by the
|
|
149
|
+
* second field of the ARN.</p>
|
|
141
150
|
* </li>
|
|
142
151
|
* </ul>
|
|
143
152
|
*
|
|
144
153
|
* @throws {@link PaginationTokenExpiredException} (client fault)
|
|
145
|
-
* <p>
|
|
146
|
-
*
|
|
154
|
+
* <p>The request failed because the specified <code>PaginationToken</code> has expired. A
|
|
155
|
+
* <code>PaginationToken</code> is valid for a maximum of 15 minutes.</p>
|
|
147
156
|
*
|
|
148
157
|
* @throws {@link ThrottledException} (client fault)
|
|
149
|
-
* <p>The request
|
|
158
|
+
* <p>The request failed because it exceeded the allowed frequency of submitted
|
|
159
|
+
* requests.</p>
|
|
150
160
|
*
|
|
151
161
|
* @throws {@link ResourceGroupsTaggingAPIServiceException}
|
|
152
162
|
* <p>Base exception class for all service exceptions from ResourceGroupsTaggingAPI service.</p>
|
|
@@ -68,34 +68,38 @@ declare const GetTagKeysCommand_base: {
|
|
|
68
68
|
* can retry the request.</p>
|
|
69
69
|
*
|
|
70
70
|
* @throws {@link InvalidParameterException} (client fault)
|
|
71
|
-
* <p>
|
|
71
|
+
* <p>The request failed because of one of the following reasons:</p>
|
|
72
72
|
* <ul>
|
|
73
73
|
* <li>
|
|
74
|
-
* <p>A parameter is missing.</p>
|
|
74
|
+
* <p>A required parameter is missing.</p>
|
|
75
75
|
* </li>
|
|
76
76
|
* <li>
|
|
77
|
-
* <p>A
|
|
77
|
+
* <p>A provided string parameter is malformed.</p>
|
|
78
78
|
* </li>
|
|
79
79
|
* <li>
|
|
80
|
-
* <p>An
|
|
80
|
+
* <p>An provided parameter value is out of range.</p>
|
|
81
81
|
* </li>
|
|
82
82
|
* <li>
|
|
83
83
|
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
84
84
|
* </li>
|
|
85
85
|
* <li>
|
|
86
86
|
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
87
|
-
* <a href="https://docs.aws.amazon.com/
|
|
88
|
-
*
|
|
89
|
-
*
|
|
87
|
+
* <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tag-policies-orgs.html#bucket-policy">Amazon S3 bucket policy for report storage</a> in the <i>Tagging Amazon Web Services resources and Tag Editor</i> user guide. </p>
|
|
88
|
+
* </li>
|
|
89
|
+
* <li>
|
|
90
|
+
* <p>The partition specified in an ARN parameter in the request doesn't match the
|
|
91
|
+
* partition where you invoked the operation. The partition is specified by the
|
|
92
|
+
* second field of the ARN.</p>
|
|
90
93
|
* </li>
|
|
91
94
|
* </ul>
|
|
92
95
|
*
|
|
93
96
|
* @throws {@link PaginationTokenExpiredException} (client fault)
|
|
94
|
-
* <p>
|
|
95
|
-
*
|
|
97
|
+
* <p>The request failed because the specified <code>PaginationToken</code> has expired. A
|
|
98
|
+
* <code>PaginationToken</code> is valid for a maximum of 15 minutes.</p>
|
|
96
99
|
*
|
|
97
100
|
* @throws {@link ThrottledException} (client fault)
|
|
98
|
-
* <p>The request
|
|
101
|
+
* <p>The request failed because it exceeded the allowed frequency of submitted
|
|
102
|
+
* requests.</p>
|
|
99
103
|
*
|
|
100
104
|
* @throws {@link ResourceGroupsTaggingAPIServiceException}
|
|
101
105
|
* <p>Base exception class for all service exceptions from ResourceGroupsTaggingAPI service.</p>
|
|
@@ -69,34 +69,38 @@ declare const GetTagValuesCommand_base: {
|
|
|
69
69
|
* can retry the request.</p>
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link InvalidParameterException} (client fault)
|
|
72
|
-
* <p>
|
|
72
|
+
* <p>The request failed because of one of the following reasons:</p>
|
|
73
73
|
* <ul>
|
|
74
74
|
* <li>
|
|
75
|
-
* <p>A parameter is missing.</p>
|
|
75
|
+
* <p>A required parameter is missing.</p>
|
|
76
76
|
* </li>
|
|
77
77
|
* <li>
|
|
78
|
-
* <p>A
|
|
78
|
+
* <p>A provided string parameter is malformed.</p>
|
|
79
79
|
* </li>
|
|
80
80
|
* <li>
|
|
81
|
-
* <p>An
|
|
81
|
+
* <p>An provided parameter value is out of range.</p>
|
|
82
82
|
* </li>
|
|
83
83
|
* <li>
|
|
84
84
|
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
85
85
|
* </li>
|
|
86
86
|
* <li>
|
|
87
87
|
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
88
|
-
* <a href="https://docs.aws.amazon.com/
|
|
89
|
-
*
|
|
90
|
-
*
|
|
88
|
+
* <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tag-policies-orgs.html#bucket-policy">Amazon S3 bucket policy for report storage</a> in the <i>Tagging Amazon Web Services resources and Tag Editor</i> user guide. </p>
|
|
89
|
+
* </li>
|
|
90
|
+
* <li>
|
|
91
|
+
* <p>The partition specified in an ARN parameter in the request doesn't match the
|
|
92
|
+
* partition where you invoked the operation. The partition is specified by the
|
|
93
|
+
* second field of the ARN.</p>
|
|
91
94
|
* </li>
|
|
92
95
|
* </ul>
|
|
93
96
|
*
|
|
94
97
|
* @throws {@link PaginationTokenExpiredException} (client fault)
|
|
95
|
-
* <p>
|
|
96
|
-
*
|
|
98
|
+
* <p>The request failed because the specified <code>PaginationToken</code> has expired. A
|
|
99
|
+
* <code>PaginationToken</code> is valid for a maximum of 15 minutes.</p>
|
|
97
100
|
*
|
|
98
101
|
* @throws {@link ThrottledException} (client fault)
|
|
99
|
-
* <p>The request
|
|
102
|
+
* <p>The request failed because it exceeded the allowed frequency of submitted
|
|
103
|
+
* requests.</p>
|
|
100
104
|
*
|
|
101
105
|
* @throws {@link ResourceGroupsTaggingAPIServiceException}
|
|
102
106
|
* <p>Base exception class for all service exceptions from ResourceGroupsTaggingAPI service.</p>
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListRequiredTagsInput, ListRequiredTagsOutput } from "../models/models_0";
|
|
4
|
+
import { ResourceGroupsTaggingAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ResourceGroupsTaggingAPIClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListRequiredTagsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListRequiredTagsCommandInput extends ListRequiredTagsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListRequiredTagsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListRequiredTagsCommandOutput extends ListRequiredTagsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListRequiredTagsCommand_base: {
|
|
25
|
+
new (input: ListRequiredTagsCommandInput): import("@smithy/smithy-client").CommandImpl<ListRequiredTagsCommandInput, ListRequiredTagsCommandOutput, ResourceGroupsTaggingAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListRequiredTagsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListRequiredTagsCommandInput, ListRequiredTagsCommandOutput, ResourceGroupsTaggingAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists the required tags for supported resource types in an Amazon Web Services account.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ResourceGroupsTaggingAPIClient, ListRequiredTagsCommand } from "@aws-sdk/client-resource-groups-tagging-api"; // ES Modules import
|
|
35
|
+
* // const { ResourceGroupsTaggingAPIClient, ListRequiredTagsCommand } = require("@aws-sdk/client-resource-groups-tagging-api"); // CommonJS import
|
|
36
|
+
* // import type { ResourceGroupsTaggingAPIClientConfig } from "@aws-sdk/client-resource-groups-tagging-api";
|
|
37
|
+
* const config = {}; // type is ResourceGroupsTaggingAPIClientConfig
|
|
38
|
+
* const client = new ResourceGroupsTaggingAPIClient(config);
|
|
39
|
+
* const input = { // ListRequiredTagsInput
|
|
40
|
+
* NextToken: "STRING_VALUE",
|
|
41
|
+
* MaxResults: Number("int"),
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListRequiredTagsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListRequiredTagsOutput
|
|
46
|
+
* // RequiredTags: [ // RequiredTagsForListRequiredTags
|
|
47
|
+
* // { // RequiredTag
|
|
48
|
+
* // ResourceType: "STRING_VALUE",
|
|
49
|
+
* // CloudFormationResourceTypes: [ // CloudFormationResourceTypes
|
|
50
|
+
* // "STRING_VALUE",
|
|
51
|
+
* // ],
|
|
52
|
+
* // ReportingTagKeys: [ // ReportingTagKeys
|
|
53
|
+
* // "STRING_VALUE",
|
|
54
|
+
* // ],
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // NextToken: "STRING_VALUE",
|
|
58
|
+
* // };
|
|
59
|
+
*
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
62
|
+
* @param ListRequiredTagsCommandInput - {@link ListRequiredTagsCommandInput}
|
|
63
|
+
* @returns {@link ListRequiredTagsCommandOutput}
|
|
64
|
+
* @see {@link ListRequiredTagsCommandInput} for command's `input` shape.
|
|
65
|
+
* @see {@link ListRequiredTagsCommandOutput} for command's `response` shape.
|
|
66
|
+
* @see {@link ResourceGroupsTaggingAPIClientResolvedConfig | config} for ResourceGroupsTaggingAPIClient's `config` shape.
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
69
|
+
* <p>The request processing failed because of an unknown error, exception, or failure. You
|
|
70
|
+
* can retry the request.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
73
|
+
* <p>The request failed because of one of the following reasons:</p>
|
|
74
|
+
* <ul>
|
|
75
|
+
* <li>
|
|
76
|
+
* <p>A required parameter is missing.</p>
|
|
77
|
+
* </li>
|
|
78
|
+
* <li>
|
|
79
|
+
* <p>A provided string parameter is malformed.</p>
|
|
80
|
+
* </li>
|
|
81
|
+
* <li>
|
|
82
|
+
* <p>An provided parameter value is out of range.</p>
|
|
83
|
+
* </li>
|
|
84
|
+
* <li>
|
|
85
|
+
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
86
|
+
* </li>
|
|
87
|
+
* <li>
|
|
88
|
+
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
89
|
+
* <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tag-policies-orgs.html#bucket-policy">Amazon S3 bucket policy for report storage</a> in the <i>Tagging Amazon Web Services resources and Tag Editor</i> user guide. </p>
|
|
90
|
+
* </li>
|
|
91
|
+
* <li>
|
|
92
|
+
* <p>The partition specified in an ARN parameter in the request doesn't match the
|
|
93
|
+
* partition where you invoked the operation. The partition is specified by the
|
|
94
|
+
* second field of the ARN.</p>
|
|
95
|
+
* </li>
|
|
96
|
+
* </ul>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link PaginationTokenExpiredException} (client fault)
|
|
99
|
+
* <p>The request failed because the specified <code>PaginationToken</code> has expired. A
|
|
100
|
+
* <code>PaginationToken</code> is valid for a maximum of 15 minutes.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link ThrottledException} (client fault)
|
|
103
|
+
* <p>The request failed because it exceeded the allowed frequency of submitted
|
|
104
|
+
* requests.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link ResourceGroupsTaggingAPIServiceException}
|
|
107
|
+
* <p>Base exception class for all service exceptions from ResourceGroupsTaggingAPI service.</p>
|
|
108
|
+
*
|
|
109
|
+
*
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
export declare class ListRequiredTagsCommand extends ListRequiredTagsCommand_base {
|
|
113
|
+
/** @internal type navigation helper, not in runtime. */
|
|
114
|
+
protected static __types: {
|
|
115
|
+
api: {
|
|
116
|
+
input: ListRequiredTagsInput;
|
|
117
|
+
output: ListRequiredTagsOutput;
|
|
118
|
+
};
|
|
119
|
+
sdk: {
|
|
120
|
+
input: ListRequiredTagsCommandInput;
|
|
121
|
+
output: ListRequiredTagsCommandOutput;
|
|
122
|
+
};
|
|
123
|
+
};
|
|
124
|
+
}
|
|
@@ -32,10 +32,19 @@ declare const StartReportCreationCommand_base: {
|
|
|
32
32
|
* Compliance data is refreshed daily. The report is generated asynchronously.</p>
|
|
33
33
|
* <p>The generated report is saved to the following location:</p>
|
|
34
34
|
* <p>
|
|
35
|
-
* <code>s3://
|
|
35
|
+
* <code>s3://amzn-s3-demo-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv</code>
|
|
36
36
|
* </p>
|
|
37
|
+
* <p>For more information about evaluating resource compliance with tag policies, including
|
|
38
|
+
* the required permissions, review <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tag-policies-orgs.html#tag-policies-permissions-org">Permissions for evaluating organization-wide compliance</a> in the
|
|
39
|
+
* <i>Tagging Amazon Web Services Resources and Tag Editor</i> user guide. </p>
|
|
37
40
|
* <p>You can call this operation only from the organization's
|
|
38
41
|
* management account and from the us-east-1 Region.</p>
|
|
42
|
+
* <p>If the account associated with the identity used to call
|
|
43
|
+
* <code>StartReportCreation</code> is different from the account that owns the Amazon S3
|
|
44
|
+
* bucket, there must be a bucket policy attached to the bucket to provide access. For more
|
|
45
|
+
* information, review <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tag-policies-orgs.html#bucket-policy">Amazon S3 bucket
|
|
46
|
+
* policy for report storage</a> in the <i>Tagging Amazon Web Services Resources and Tag
|
|
47
|
+
* Editor</i> user guide.</p>
|
|
39
48
|
* @example
|
|
40
49
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
50
|
* ```javascript
|
|
@@ -60,19 +69,17 @@ declare const StartReportCreationCommand_base: {
|
|
|
60
69
|
* @see {@link ResourceGroupsTaggingAPIClientResolvedConfig | config} for ResourceGroupsTaggingAPIClient's `config` shape.
|
|
61
70
|
*
|
|
62
71
|
* @throws {@link ConcurrentModificationException} (client fault)
|
|
63
|
-
* <p>The target of the operation is currently being modified by
|
|
64
|
-
* again later.</p>
|
|
72
|
+
* <p>The request failed because the target of the operation is currently being modified by
|
|
73
|
+
* a different request. Try again later.</p>
|
|
65
74
|
*
|
|
66
75
|
* @throws {@link ConstraintViolationException} (client fault)
|
|
67
|
-
* <p>The request
|
|
76
|
+
* <p>The request failed because performing the operation would violate a constraint.</p>
|
|
68
77
|
* <p>Some of the reasons in the following list might not apply to this specific
|
|
69
78
|
* operation.</p>
|
|
70
79
|
* <ul>
|
|
71
80
|
* <li>
|
|
72
81
|
* <p>You must meet the prerequisites for using tag policies. For information, see
|
|
73
|
-
* <a href="https://docs.aws.amazon.com/
|
|
74
|
-
* <i>Organizations User Guide.</i>
|
|
75
|
-
* </p>
|
|
82
|
+
* <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tag-policies-orgs.html#tag-policies-prereqs">Prerequisites and permissions</a> in the <i>Tagging Amazon Web Services resources and Tag Editor</i> user guide. </p>
|
|
76
83
|
* </li>
|
|
77
84
|
* <li>
|
|
78
85
|
* <p>You must enable the tag policies service principal
|
|
@@ -90,30 +97,34 @@ declare const StartReportCreationCommand_base: {
|
|
|
90
97
|
* can retry the request.</p>
|
|
91
98
|
*
|
|
92
99
|
* @throws {@link InvalidParameterException} (client fault)
|
|
93
|
-
* <p>
|
|
100
|
+
* <p>The request failed because of one of the following reasons:</p>
|
|
94
101
|
* <ul>
|
|
95
102
|
* <li>
|
|
96
|
-
* <p>A parameter is missing.</p>
|
|
103
|
+
* <p>A required parameter is missing.</p>
|
|
97
104
|
* </li>
|
|
98
105
|
* <li>
|
|
99
|
-
* <p>A
|
|
106
|
+
* <p>A provided string parameter is malformed.</p>
|
|
100
107
|
* </li>
|
|
101
108
|
* <li>
|
|
102
|
-
* <p>An
|
|
109
|
+
* <p>An provided parameter value is out of range.</p>
|
|
103
110
|
* </li>
|
|
104
111
|
* <li>
|
|
105
112
|
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
106
113
|
* </li>
|
|
107
114
|
* <li>
|
|
108
115
|
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
109
|
-
* <a href="https://docs.aws.amazon.com/
|
|
110
|
-
*
|
|
111
|
-
*
|
|
116
|
+
* <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tag-policies-orgs.html#bucket-policy">Amazon S3 bucket policy for report storage</a> in the <i>Tagging Amazon Web Services resources and Tag Editor</i> user guide. </p>
|
|
117
|
+
* </li>
|
|
118
|
+
* <li>
|
|
119
|
+
* <p>The partition specified in an ARN parameter in the request doesn't match the
|
|
120
|
+
* partition where you invoked the operation. The partition is specified by the
|
|
121
|
+
* second field of the ARN.</p>
|
|
112
122
|
* </li>
|
|
113
123
|
* </ul>
|
|
114
124
|
*
|
|
115
125
|
* @throws {@link ThrottledException} (client fault)
|
|
116
|
-
* <p>The request
|
|
126
|
+
* <p>The request failed because it exceeded the allowed frequency of submitted
|
|
127
|
+
* requests.</p>
|
|
117
128
|
*
|
|
118
129
|
* @throws {@link ResourceGroupsTaggingAPIServiceException}
|
|
119
130
|
* <p>Base exception class for all service exceptions from ResourceGroupsTaggingAPI service.</p>
|
|
@@ -51,6 +51,17 @@ declare const TagResourcesCommand_base: {
|
|
|
51
51
|
* that the resource belongs to as well as permissions for adding tags. For more
|
|
52
52
|
* information, see the documentation for each service.</p>
|
|
53
53
|
* </li>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>When you use the <a href="https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/overview.html">Amazon Web Services Resource
|
|
56
|
+
* Groups Tagging API</a> to update tags for Amazon Web Services CloudFormation stack
|
|
57
|
+
* sets, Amazon Web Services calls the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStack.html">Amazon Web Services
|
|
58
|
+
* CloudFormation <code>UpdateStack</code>
|
|
59
|
+
* </a> operation. This operation
|
|
60
|
+
* may initiate additional resource property updates in addition to the desired tag
|
|
61
|
+
* updates. To avoid unexpected resource updates, Amazon Web Services recommends that you only
|
|
62
|
+
* apply or update tags to your CloudFormation stack sets using Amazon Web Services
|
|
63
|
+
* CloudFormation. </p>
|
|
64
|
+
* </li>
|
|
54
65
|
* </ul>
|
|
55
66
|
* <important>
|
|
56
67
|
* <p>Do not store personally identifiable information (PII) or other confidential or
|
|
@@ -68,7 +79,7 @@ declare const TagResourcesCommand_base: {
|
|
|
68
79
|
* <ul>
|
|
69
80
|
* <li>
|
|
70
81
|
* <p>
|
|
71
|
-
* <code>tag:
|
|
82
|
+
* <code>tag:TagResources</code>
|
|
72
83
|
* </p>
|
|
73
84
|
* </li>
|
|
74
85
|
* <li>
|
|
@@ -77,6 +88,13 @@ declare const TagResourcesCommand_base: {
|
|
|
77
88
|
* </p>
|
|
78
89
|
* </li>
|
|
79
90
|
* </ul>
|
|
91
|
+
* <note>
|
|
92
|
+
* <p>In addition, some services might have specific requirements for tagging some types
|
|
93
|
+
* of resources. For example, to tag an Amazon S3 bucket, you must also have the
|
|
94
|
+
* <code>s3:GetBucketTagging</code> permission. If the expected minimum permissions
|
|
95
|
+
* don't work, check the documentation for that service's tagging APIs for more
|
|
96
|
+
* information.</p>
|
|
97
|
+
* </note>
|
|
80
98
|
* @example
|
|
81
99
|
* Use a bare-bones client and the command you need to make an API call.
|
|
82
100
|
* ```javascript
|
|
@@ -118,30 +136,34 @@ declare const TagResourcesCommand_base: {
|
|
|
118
136
|
* can retry the request.</p>
|
|
119
137
|
*
|
|
120
138
|
* @throws {@link InvalidParameterException} (client fault)
|
|
121
|
-
* <p>
|
|
139
|
+
* <p>The request failed because of one of the following reasons:</p>
|
|
122
140
|
* <ul>
|
|
123
141
|
* <li>
|
|
124
|
-
* <p>A parameter is missing.</p>
|
|
142
|
+
* <p>A required parameter is missing.</p>
|
|
125
143
|
* </li>
|
|
126
144
|
* <li>
|
|
127
|
-
* <p>A
|
|
145
|
+
* <p>A provided string parameter is malformed.</p>
|
|
128
146
|
* </li>
|
|
129
147
|
* <li>
|
|
130
|
-
* <p>An
|
|
148
|
+
* <p>An provided parameter value is out of range.</p>
|
|
131
149
|
* </li>
|
|
132
150
|
* <li>
|
|
133
151
|
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
134
152
|
* </li>
|
|
135
153
|
* <li>
|
|
136
154
|
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
137
|
-
* <a href="https://docs.aws.amazon.com/
|
|
138
|
-
*
|
|
139
|
-
*
|
|
155
|
+
* <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tag-policies-orgs.html#bucket-policy">Amazon S3 bucket policy for report storage</a> in the <i>Tagging Amazon Web Services resources and Tag Editor</i> user guide. </p>
|
|
156
|
+
* </li>
|
|
157
|
+
* <li>
|
|
158
|
+
* <p>The partition specified in an ARN parameter in the request doesn't match the
|
|
159
|
+
* partition where you invoked the operation. The partition is specified by the
|
|
160
|
+
* second field of the ARN.</p>
|
|
140
161
|
* </li>
|
|
141
162
|
* </ul>
|
|
142
163
|
*
|
|
143
164
|
* @throws {@link ThrottledException} (client fault)
|
|
144
|
-
* <p>The request
|
|
165
|
+
* <p>The request failed because it exceeded the allowed frequency of submitted
|
|
166
|
+
* requests.</p>
|
|
145
167
|
*
|
|
146
168
|
* @throws {@link ResourceGroupsTaggingAPIServiceException}
|
|
147
169
|
* <p>Base exception class for all service exceptions from ResourceGroupsTaggingAPI service.</p>
|
|
@@ -54,7 +54,7 @@ declare const UntagResourcesCommand_base: {
|
|
|
54
54
|
* <ul>
|
|
55
55
|
* <li>
|
|
56
56
|
* <p>
|
|
57
|
-
* <code>tag:
|
|
57
|
+
* <code>tag:UntagResources</code>
|
|
58
58
|
* </p>
|
|
59
59
|
* </li>
|
|
60
60
|
* <li>
|
|
@@ -63,6 +63,13 @@ declare const UntagResourcesCommand_base: {
|
|
|
63
63
|
* </p>
|
|
64
64
|
* </li>
|
|
65
65
|
* </ul>
|
|
66
|
+
* <note>
|
|
67
|
+
* <p>In addition, some services might have specific requirements for untagging some
|
|
68
|
+
* types of resources. For example, to untag Amazon Web Services Glue Connection, you must also have the
|
|
69
|
+
* <code>glue:GetConnection</code> permission. If the expected minimum permissions
|
|
70
|
+
* don't work, check the documentation for that service's tagging APIs for more
|
|
71
|
+
* information.</p>
|
|
72
|
+
* </note>
|
|
66
73
|
* @example
|
|
67
74
|
* Use a bare-bones client and the command you need to make an API call.
|
|
68
75
|
* ```javascript
|
|
@@ -104,30 +111,34 @@ declare const UntagResourcesCommand_base: {
|
|
|
104
111
|
* can retry the request.</p>
|
|
105
112
|
*
|
|
106
113
|
* @throws {@link InvalidParameterException} (client fault)
|
|
107
|
-
* <p>
|
|
114
|
+
* <p>The request failed because of one of the following reasons:</p>
|
|
108
115
|
* <ul>
|
|
109
116
|
* <li>
|
|
110
|
-
* <p>A parameter is missing.</p>
|
|
117
|
+
* <p>A required parameter is missing.</p>
|
|
111
118
|
* </li>
|
|
112
119
|
* <li>
|
|
113
|
-
* <p>A
|
|
120
|
+
* <p>A provided string parameter is malformed.</p>
|
|
114
121
|
* </li>
|
|
115
122
|
* <li>
|
|
116
|
-
* <p>An
|
|
123
|
+
* <p>An provided parameter value is out of range.</p>
|
|
117
124
|
* </li>
|
|
118
125
|
* <li>
|
|
119
126
|
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
120
127
|
* </li>
|
|
121
128
|
* <li>
|
|
122
129
|
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
123
|
-
* <a href="https://docs.aws.amazon.com/
|
|
124
|
-
*
|
|
125
|
-
*
|
|
130
|
+
* <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tag-policies-orgs.html#bucket-policy">Amazon S3 bucket policy for report storage</a> in the <i>Tagging Amazon Web Services resources and Tag Editor</i> user guide. </p>
|
|
131
|
+
* </li>
|
|
132
|
+
* <li>
|
|
133
|
+
* <p>The partition specified in an ARN parameter in the request doesn't match the
|
|
134
|
+
* partition where you invoked the operation. The partition is specified by the
|
|
135
|
+
* second field of the ARN.</p>
|
|
126
136
|
* </li>
|
|
127
137
|
* </ul>
|
|
128
138
|
*
|
|
129
139
|
* @throws {@link ThrottledException} (client fault)
|
|
130
|
-
* <p>The request
|
|
140
|
+
* <p>The request failed because it exceeded the allowed frequency of submitted
|
|
141
|
+
* requests.</p>
|
|
131
142
|
*
|
|
132
143
|
* @throws {@link ResourceGroupsTaggingAPIServiceException}
|
|
133
144
|
* <p>Base exception class for all service exceptions from ResourceGroupsTaggingAPI service.</p>
|
|
@@ -3,6 +3,7 @@ export * from "./GetComplianceSummaryCommand";
|
|
|
3
3
|
export * from "./GetResourcesCommand";
|
|
4
4
|
export * from "./GetTagKeysCommand";
|
|
5
5
|
export * from "./GetTagValuesCommand";
|
|
6
|
+
export * from "./ListRequiredTagsCommand";
|
|
6
7
|
export * from "./StartReportCreationCommand";
|
|
7
8
|
export * from "./TagResourcesCommand";
|
|
8
9
|
export * from "./UntagResourcesCommand";
|