@aws-sdk/client-resource-groups-tagging-api 3.36.0 → 3.36.1

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 (37) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist-cjs/ResourceGroupsTaggingAPI.js +0 -3
  3. package/dist-cjs/ResourceGroupsTaggingAPIClient.js +0 -8
  4. package/dist-cjs/commands/DescribeReportCreationCommand.js +0 -26
  5. package/dist-cjs/commands/GetComplianceSummaryCommand.js +0 -36
  6. package/dist-cjs/commands/GetResourcesCommand.js +0 -47
  7. package/dist-cjs/commands/GetTagKeysCommand.js +0 -31
  8. package/dist-cjs/commands/GetTagValuesCommand.js +0 -31
  9. package/dist-cjs/commands/StartReportCreationCommand.js +0 -32
  10. package/dist-cjs/commands/TagResourcesCommand.js +0 -51
  11. package/dist-cjs/commands/UntagResourcesCommand.js +0 -39
  12. package/dist-cjs/models/models_0.js +0 -84
  13. package/dist-cjs/pagination/GetComplianceSummaryPaginator.js +0 -10
  14. package/dist-cjs/pagination/GetResourcesPaginator.js +0 -10
  15. package/dist-cjs/pagination/GetTagKeysPaginator.js +0 -10
  16. package/dist-cjs/pagination/GetTagValuesPaginator.js +0 -10
  17. package/dist-cjs/protocols/Aws_json1_1.js +0 -5
  18. package/dist-cjs/runtimeConfig.browser.js +1 -5
  19. package/dist-cjs/runtimeConfig.js +1 -5
  20. package/dist-cjs/runtimeConfig.native.js +0 -3
  21. package/dist-cjs/runtimeConfig.shared.js +0 -3
  22. package/dist-types/ts3.4/ResourceGroupsTaggingAPI.d.ts +9 -128
  23. package/dist-types/ts3.4/ResourceGroupsTaggingAPIClient.d.ts +24 -89
  24. package/dist-types/ts3.4/commands/DescribeReportCreationCommand.d.ts +2 -22
  25. package/dist-types/ts3.4/commands/GetComplianceSummaryCommand.d.ts +2 -32
  26. package/dist-types/ts3.4/commands/GetResourcesCommand.d.ts +2 -43
  27. package/dist-types/ts3.4/commands/GetTagKeysCommand.d.ts +2 -27
  28. package/dist-types/ts3.4/commands/GetTagValuesCommand.d.ts +2 -27
  29. package/dist-types/ts3.4/commands/StartReportCreationCommand.d.ts +2 -28
  30. package/dist-types/ts3.4/commands/TagResourcesCommand.d.ts +2 -47
  31. package/dist-types/ts3.4/commands/UntagResourcesCommand.d.ts +2 -35
  32. package/dist-types/ts3.4/models/models_0.d.ts +96 -569
  33. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  34. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  35. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  36. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  37. package/package.json +3 -3
@@ -1,253 +1,102 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
- /**
3
- * <p>Information that shows whether a resource is compliant with the effective tag policy,
4
- * including details on any noncompliant tag keys.</p>
5
- */
2
+
6
3
  export interface ComplianceDetails {
7
- /**
8
- * <p>These tag keys on the resource are noncompliant with the effective tag policy.</p>
9
- */
4
+
10
5
  NoncompliantKeys?: string[];
11
- /**
12
- * <p>These are keys defined in the effective policy that are on the resource with either
13
- * incorrect case treatment or noncompliant values. </p>
14
- */
6
+
15
7
  KeysWithNoncompliantValues?: string[];
16
- /**
17
- * <p>Whether a resource is compliant with the effective tag policy.</p>
18
- */
8
+
19
9
  ComplianceStatus?: boolean;
20
10
  }
21
11
  export declare namespace ComplianceDetails {
22
- /**
23
- * @internal
24
- */
12
+
25
13
  const filterSensitiveLog: (obj: ComplianceDetails) => any;
26
14
  }
27
- /**
28
- * <p>The target of the operation is currently being modified by a different request. Try
29
- * again later.</p>
30
- */
15
+
31
16
  export interface ConcurrentModificationException extends __SmithyException, $MetadataBearer {
32
17
  name: "ConcurrentModificationException";
33
18
  $fault: "client";
34
19
  Message?: string;
35
20
  }
36
21
  export declare namespace ConcurrentModificationException {
37
- /**
38
- * @internal
39
- */
22
+
40
23
  const filterSensitiveLog: (obj: ConcurrentModificationException) => any;
41
24
  }
42
- /**
43
- * <p>The request was denied because performing this operation violates a constraint. </p>
44
- * <p>Some of the reasons in the following list might not apply to this specific
45
- * operation.</p>
46
- * <ul>
47
- * <li>
48
- * <p>You must meet the prerequisites for using tag policies. For information, see
49
- * <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html">Prerequisites and Permissions for Using Tag Policies</a> in the
50
- * <i>AWS Organizations User Guide.</i>
51
- * </p>
52
- * </li>
53
- * <li>
54
- * <p>You must enable the tag policies service principal
55
- * (<code>tagpolicies.tag.amazonaws.com</code>) to integrate with AWS Organizations For
56
- * information, see <a href="http://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAWSServiceAccess.html">EnableAWSServiceAccess</a>.</p>
57
- * </li>
58
- * <li>
59
- * <p>You must have a tag policy attached to the organization root, an OU, or an
60
- * account.</p>
61
- * </li>
62
- * </ul>
63
- */
25
+
64
26
  export interface ConstraintViolationException extends __SmithyException, $MetadataBearer {
65
27
  name: "ConstraintViolationException";
66
28
  $fault: "client";
67
29
  Message?: string;
68
30
  }
69
31
  export declare namespace ConstraintViolationException {
70
- /**
71
- * @internal
72
- */
32
+
73
33
  const filterSensitiveLog: (obj: ConstraintViolationException) => any;
74
34
  }
75
35
  export interface DescribeReportCreationInput {
76
36
  }
77
37
  export declare namespace DescribeReportCreationInput {
78
- /**
79
- * @internal
80
- */
38
+
81
39
  const filterSensitiveLog: (obj: DescribeReportCreationInput) => any;
82
40
  }
83
41
  export interface DescribeReportCreationOutput {
84
- /**
85
- * <p>Reports the status of the operation.</p>
86
- * <p>The operation status can be one of the following:</p>
87
- * <ul>
88
- * <li>
89
- * <p>
90
- * <code>RUNNING</code> - Report creation is in progress.</p>
91
- * </li>
92
- * <li>
93
- * <p>
94
- * <code>SUCCEEDED</code> - Report creation is complete. You can open the report
95
- * from the Amazon S3 bucket that you specified when you ran
96
- * <code>StartReportCreation</code>.</p>
97
- * </li>
98
- * <li>
99
- * <p>
100
- * <code>FAILED</code> - Report creation timed out or the Amazon S3 bucket is not
101
- * accessible. </p>
102
- * </li>
103
- * <li>
104
- * <p>
105
- * <code>NO REPORT</code> - No report was generated in the last 90 days.</p>
106
- * </li>
107
- * </ul>
108
- */
42
+
109
43
  Status?: string;
110
- /**
111
- * <p>The path to the Amazon S3 bucket where the report was stored on creation.</p>
112
- */
44
+
113
45
  S3Location?: string;
114
- /**
115
- * <p>The date and time that the report was started. </p>
116
- */
46
+
117
47
  StartDate?: string;
118
- /**
119
- * <p>Details of the common errors that all operations return.</p>
120
- */
48
+
121
49
  ErrorMessage?: string;
122
50
  }
123
51
  export declare namespace DescribeReportCreationOutput {
124
- /**
125
- * @internal
126
- */
52
+
127
53
  const filterSensitiveLog: (obj: DescribeReportCreationOutput) => any;
128
54
  }
129
- /**
130
- * <p>The request processing failed because of an unknown error, exception, or failure. You
131
- * can retry the request.</p>
132
- */
55
+
133
56
  export interface InternalServiceException extends __SmithyException, $MetadataBearer {
134
57
  name: "InternalServiceException";
135
58
  $fault: "server";
136
59
  Message?: string;
137
60
  }
138
61
  export declare namespace InternalServiceException {
139
- /**
140
- * @internal
141
- */
62
+
142
63
  const filterSensitiveLog: (obj: InternalServiceException) => any;
143
64
  }
144
- /**
145
- * <p>This error indicates one of the following:</p>
146
- * <ul>
147
- * <li>
148
- * <p>A parameter is missing.</p>
149
- * </li>
150
- * <li>
151
- * <p>A malformed string was supplied for the request parameter.</p>
152
- * </li>
153
- * <li>
154
- * <p>An out-of-range value was supplied for the request parameter.</p>
155
- * </li>
156
- * <li>
157
- * <p>The target ID is invalid, unsupported, or doesn't exist.</p>
158
- * </li>
159
- * <li>
160
- * <p>You can't access the Amazon S3 bucket for report storage. For more information, see
161
- * <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html#bucket-policies-org-report">Additional Requirements for Organization-wide Tag Compliance
162
- * Reports</a> in the <i>AWS Organizations User Guide.</i>
163
- * </p>
164
- * </li>
165
- * </ul>
166
- */
65
+
167
66
  export interface InvalidParameterException extends __SmithyException, $MetadataBearer {
168
67
  name: "InvalidParameterException";
169
68
  $fault: "client";
170
69
  Message?: string;
171
70
  }
172
71
  export declare namespace InvalidParameterException {
173
- /**
174
- * @internal
175
- */
72
+
176
73
  const filterSensitiveLog: (obj: InvalidParameterException) => any;
177
74
  }
178
- /**
179
- * <p>The request was denied to limit the frequency of submitted requests.</p>
180
- */
75
+
181
76
  export interface ThrottledException extends __SmithyException, $MetadataBearer {
182
77
  name: "ThrottledException";
183
78
  $fault: "client";
184
79
  Message?: string;
185
80
  }
186
81
  export declare namespace ThrottledException {
187
- /**
188
- * @internal
189
- */
82
+
190
83
  const filterSensitiveLog: (obj: ThrottledException) => any;
191
84
  }
192
85
  export declare enum ErrorCode {
193
86
  INTERNAL_SERVICE_EXCEPTION = "InternalServiceException",
194
87
  INVALID_PARAMETER_EXCEPTION = "InvalidParameterException"
195
88
  }
196
- /**
197
- * <p>Information about the errors that are returned for each failed resource. This
198
- * information can include <code>InternalServiceException</code> and
199
- * <code>InvalidParameterException</code> errors. It can also include any valid error
200
- * code returned by the AWS service that hosts the resource that the ARN key
201
- * represents.</p>
202
- * <p>The following are common error codes that you might receive from other AWS
203
- * services:</p>
204
- * <ul>
205
- * <li>
206
- * <p>
207
- * <b>InternalServiceException</b> – This can
208
- * mean that the Resource Groups Tagging API didn't receive a response from another
209
- * AWS service. It can also mean the the resource type in the request is not
210
- * supported by the Resource Groups Tagging API. In these cases, it's safe to retry
211
- * the request and then call <a href="http://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html">GetResources</a> to verify the changes.</p>
212
- * </li>
213
- * <li>
214
- * <p>
215
- * <b>AccessDeniedException</b> – This can mean
216
- * that you need permission to calling tagging operations in the AWS service that
217
- * contains the resource. For example, to use the Resource Groups Tagging API to
218
- * tag a CloudWatch alarm resource, you need permission to call <a href="http://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html">
219
- * <code>TagResources</code>
220
- * </a>
221
- * <i>and</i>
222
- * <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">
223
- * <code>TagResource</code>
224
- * </a> in the CloudWatch API. </p>
225
- * </li>
226
- * </ul>
227
- * <p>For more information on errors that are generated from other AWS services, see the
228
- * documentation for that service. </p>
229
- */
89
+
230
90
  export interface FailureInfo {
231
- /**
232
- * <p>The HTTP status code of the common error.</p>
233
- */
91
+
234
92
  StatusCode?: number;
235
- /**
236
- * <p>The code of the common error. Valid values include
237
- * <code>InternalServiceException</code>, <code>InvalidParameterException</code>, and
238
- * any valid error code returned by the AWS service that hosts the resource that you want
239
- * to tag.</p>
240
- */
93
+
241
94
  ErrorCode?: ErrorCode | string;
242
- /**
243
- * <p>The message of the common error.</p>
244
- */
95
+
245
96
  ErrorMessage?: string;
246
97
  }
247
98
  export declare namespace FailureInfo {
248
- /**
249
- * @internal
250
- */
99
+
251
100
  const filterSensitiveLog: (obj: FailureInfo) => any;
252
101
  }
253
102
  export declare enum GroupByAttribute {
@@ -256,74 +105,23 @@ export declare enum GroupByAttribute {
256
105
  TARGET_ID = "TARGET_ID"
257
106
  }
258
107
  export interface GetComplianceSummaryInput {
259
- /**
260
- * <p>Specifies target identifiers (usually, specific account IDs) to limit the output by.
261
- * If you use this parameter, the count of returned noncompliant resources includes only
262
- * resources with the specified target IDs.</p>
263
- */
108
+
264
109
  TargetIdFilters?: string[];
265
- /**
266
- * <p>Specifies a list of AWS Regions to limit the output by. If you use this parameter,
267
- * the count of returned noncompliant resources includes only resources in the specified
268
- * Regions.</p>
269
- */
110
+
270
111
  RegionFilters?: string[];
271
- /**
272
- * <p>Specifies that you want the response to include information for only resources of the
273
- * specified types. The format of each resource type is
274
- * <code>service[:resourceType]</code>. For example, specifying a resource type of
275
- * <code>ec2</code> returns all Amazon EC2 resources (which includes EC2 instances).
276
- * Specifying a resource type of <code>ec2:instance</code> returns only EC2 instances. </p>
277
- * <p>The string for each service name and resource type is the same as that embedded in a
278
- * resource's Amazon Resource Name (ARN). Consult the <i>AWS General
279
- * Reference</i> for the following:</p>
280
- * <ul>
281
- * <li>
282
- * <p>For a list of service name strings, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces">AWS Service Namespaces</a>.</p>
283
- * </li>
284
- * <li>
285
- * <p>For resource type strings, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax">Example
286
- * ARNs</a>.</p>
287
- * </li>
288
- * <li>
289
- * <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names
290
- * (ARNs) and AWS Service Namespaces</a>.</p>
291
- * </li>
292
- * </ul>
293
- * <p>You can specify multiple resource types by using a comma separated array. The array
294
- * can include up to 100 items. Note that the length constraint requirement applies to each
295
- * resource type filter. </p>
296
- */
112
+
297
113
  ResourceTypeFilters?: string[];
298
- /**
299
- * <p>Specifies that you want the response to include information for only resources that
300
- * have tags with the specified tag keys. If you use this parameter, the count of returned
301
- * noncompliant resources includes only resources that have the specified tag keys.</p>
302
- */
114
+
303
115
  TagKeyFilters?: string[];
304
- /**
305
- * <p>Specifies a list of attributes to group the counts of noncompliant resources by. If
306
- * supplied, the counts are sorted by those attributes.</p>
307
- */
116
+
308
117
  GroupBy?: (GroupByAttribute | string)[];
309
- /**
310
- * <p>Specifies the maximum number of results to be returned in each page. A
311
- * query can return fewer than this maximum, even if there are more results still to return. You
312
- * should always check the <code>PaginationToken</code> response value to see if there are more
313
- * results. You can specify a minimum of 1 and a maximum value of 100.</p>
314
- */
118
+
315
119
  MaxResults?: number;
316
- /**
317
- * <p>Specifies a <code>PaginationToken</code> response value from a
318
- * previous request to indicate that you want the next page of results. Leave this parameter empty
319
- * in your initial request.</p>
320
- */
120
+
321
121
  PaginationToken?: string;
322
122
  }
323
123
  export declare namespace GetComplianceSummaryInput {
324
- /**
325
- * @internal
326
- */
124
+
327
125
  const filterSensitiveLog: (obj: GetComplianceSummaryInput) => any;
328
126
  }
329
127
  export declare enum TargetIdType {
@@ -331,474 +129,203 @@ export declare enum TargetIdType {
331
129
  OU = "OU",
332
130
  ROOT = "ROOT"
333
131
  }
334
- /**
335
- * <p>A count of noncompliant resources.</p>
336
- */
132
+
337
133
  export interface Summary {
338
- /**
339
- * <p>The timestamp that shows when this summary was generated in this Region. </p>
340
- */
134
+
341
135
  LastUpdated?: string;
342
- /**
343
- * <p>The account identifier or the root identifier of the organization. If you don't know
344
- * the root ID, you can call the AWS Organizations <a href="http://docs.aws.amazon.com/organizations/latest/APIReference/API_ListRoots.html">ListRoots</a> API.</p>
345
- */
136
+
346
137
  TargetId?: string;
347
- /**
348
- * <p>Whether the target is an account, an OU, or the organization root.</p>
349
- */
138
+
350
139
  TargetIdType?: TargetIdType | string;
351
- /**
352
- * <p>The AWS Region that the summary applies to.</p>
353
- */
140
+
354
141
  Region?: string;
355
- /**
356
- * <p>The AWS resource type.</p>
357
- */
142
+
358
143
  ResourceType?: string;
359
- /**
360
- * <p>The count of noncompliant resources.</p>
361
- */
144
+
362
145
  NonCompliantResources?: number;
363
146
  }
364
147
  export declare namespace Summary {
365
- /**
366
- * @internal
367
- */
148
+
368
149
  const filterSensitiveLog: (obj: Summary) => any;
369
150
  }
370
151
  export interface GetComplianceSummaryOutput {
371
- /**
372
- * <p>A table that shows counts of noncompliant resources.</p>
373
- */
152
+
374
153
  SummaryList?: Summary[];
375
- /**
376
- * <p>A string that indicates that there is more data available than this
377
- * response contains. To receive the next part of the response, specify this response value
378
- * as the <code>PaginationToken</code> value in the request for the next page.</p>
379
- */
154
+
380
155
  PaginationToken?: string;
381
156
  }
382
157
  export declare namespace GetComplianceSummaryOutput {
383
- /**
384
- * @internal
385
- */
158
+
386
159
  const filterSensitiveLog: (obj: GetComplianceSummaryOutput) => any;
387
160
  }
388
- /**
389
- * <p>A list of tags (keys and values) that are used to specify the associated
390
- * resources.</p>
391
- */
161
+
392
162
  export interface TagFilter {
393
- /**
394
- * <p>One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.</p>
395
- */
163
+
396
164
  Key?: string;
397
- /**
398
- * <p>One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.</p>
399
- */
165
+
400
166
  Values?: string[];
401
167
  }
402
168
  export declare namespace TagFilter {
403
- /**
404
- * @internal
405
- */
169
+
406
170
  const filterSensitiveLog: (obj: TagFilter) => any;
407
171
  }
408
172
  export interface GetResourcesInput {
409
- /**
410
- * <p>Specifies a <code>PaginationToken</code> response value from a
411
- * previous request to indicate that you want the next page of results. Leave this parameter empty
412
- * in your initial request.</p>
413
- */
173
+
414
174
  PaginationToken?: string;
415
- /**
416
- * <p>Specifies a list of TagFilters (keys and values) to restrict the output to only those
417
- * resources that have the specified tag and, if included, the specified value. Each
418
- * <code>TagFilter</code> must contain a key with values optional. A request can
419
- * include up to 50 keys, and each key can include up to 20 values. </p>
420
- * <p>Note the following when deciding how to use TagFilters:</p>
421
- * <ul>
422
- * <li>
423
- * <p>If you <i>don't</i> specify a <code>TagFilter</code>, the
424
- * response includes all resources that are currently tagged or ever had a tag.
425
- * Resources that currently don't have tags are shown with an empty tag set, like
426
- * this: <code>"Tags": []</code>.</p>
427
- * </li>
428
- * <li>
429
- * <p>If you specify more than one filter in a single request, the response returns
430
- * only those resources that satisfy all filters.</p>
431
- * </li>
432
- * <li>
433
- * <p>If you specify a filter that contains more than one value for a key, the
434
- * response returns resources that match any of the specified values for that
435
- * key.</p>
436
- * </li>
437
- * <li>
438
- * <p>If you don't specify any values for a key, the response returns resources that
439
- * are tagged with that key and any or no value.</p>
440
- * <p>For example, for the following filters: <code>filter1= {keyA,{value1}}</code>,
441
- * <code>filter2={keyB,{value2,value3,value4}}</code>, <code>filter3=
442
- * {keyC}</code>:</p>
443
- * <ul>
444
- * <li>
445
- * <p>
446
- * <code>GetResources({filter1})</code> returns resources tagged with
447
- * <code>key1=value1</code>
448
- * </p>
449
- * </li>
450
- * <li>
451
- * <p>
452
- * <code>GetResources({filter2})</code> returns resources tagged with
453
- * <code>key2=value2</code> or <code>key2=value3</code> or
454
- * <code>key2=value4</code>
455
- * </p>
456
- * </li>
457
- * <li>
458
- * <p>
459
- * <code>GetResources({filter3})</code> returns resources tagged with any
460
- * tag with the key <code>key3</code>, and with any or no value</p>
461
- * </li>
462
- * <li>
463
- * <p>
464
- * <code>GetResources({filter1,filter2,filter3})</code> returns resources
465
- * tagged with <code>(key1=value1) and (key2=value2 or key2=value3 or
466
- * key2=value4) and (key3, any or no value)</code>
467
- * </p>
468
- * </li>
469
- * </ul>
470
- * </li>
471
- * </ul>
472
- */
175
+
473
176
  TagFilters?: TagFilter[];
474
- /**
475
- * <p>Specifies the maximum number of results to be returned in each page. A
476
- * query can return fewer than this maximum, even if there are more results still to return. You
477
- * should always check the <code>PaginationToken</code> response value to see if there are more
478
- * results. You can specify a minimum of 1 and a maximum value of 100.</p>
479
- */
177
+
480
178
  ResourcesPerPage?: number;
481
- /**
482
- * <p>AWS recommends using <code>ResourcesPerPage</code> instead of this parameter.</p>
483
- * <p>A limit that restricts the number of tags (key and value pairs) returned by
484
- * <code>GetResources</code> in paginated output. A resource with no tags is counted as
485
- * having one tag (one key and value pair).</p>
486
- * <p>
487
- * <code>GetResources</code> does not split a resource and its associated tags across
488
- * pages. If the specified <code>TagsPerPage</code> would cause such a break, a
489
- * <code>PaginationToken</code> is returned in place of the affected resource and its
490
- * tags. Use that token in another request to get the remaining data. For example, if you
491
- * specify a <code>TagsPerPage</code> of <code>100</code> and the account has 22 resources
492
- * with 10 tags each (meaning that each resource has 10 key and value pairs), the output
493
- * will consist of three pages. The first page displays the first 10 resources, each with
494
- * its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The
495
- * third page displays the remaining 2 resources, each with its 10 tags.</p>
496
- * <p>You can set <code>TagsPerPage</code> to a minimum of 100 items up to a maximum of 500
497
- * items.</p>
498
- */
179
+
499
180
  TagsPerPage?: number;
500
- /**
501
- * <p>Specifies the resource types that you want included in the response. The format of
502
- * each resource type is <code>service[:resourceType]</code>. For example, specifying a
503
- * resource type of <code>ec2</code> returns all Amazon EC2 resources (which includes EC2
504
- * instances). Specifying a resource type of <code>ec2:instance</code> returns only EC2
505
- * instances. </p>
506
- * <p>The string for each service name and resource type is the same as that embedded in a
507
- * resource's Amazon Resource Name (ARN). Consult the <i>AWS General
508
- * Reference</i> for the following:</p>
509
- * <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and
510
- * AWS Service Namespaces</a>.</p>
511
- * <p>You can specify multiple resource types by using an array. The array can include up to
512
- * 100 items. Note that the length constraint requirement applies to each resource type
513
- * filter. </p>
514
- */
181
+
515
182
  ResourceTypeFilters?: string[];
516
- /**
517
- * <p>Specifies whether to include details regarding the compliance with the effective tag
518
- * policy. Set this to <code>true</code> to determine whether resources are compliant with
519
- * the tag policy and to get details.</p>
520
- */
183
+
521
184
  IncludeComplianceDetails?: boolean;
522
- /**
523
- * <p>Specifies whether to exclude resources that are compliant with the tag policy. Set
524
- * this to <code>true</code> if you are interested in retrieving information on
525
- * noncompliant resources only.</p>
526
- * <p>You can use this parameter only if the <code>IncludeComplianceDetails</code> parameter
527
- * is also set to <code>true</code>.</p>
528
- */
185
+
529
186
  ExcludeCompliantResources?: boolean;
530
- /**
531
- * <p>Specifies a list of ARNs of resources for which you want to retrieve tag data. You
532
- * can't specify both this parameter and any of the pagination parameters
533
- * (<code>ResourcesPerPage</code>, <code>TagsPerPage</code>,
534
- * <code>PaginationToken</code>) in the same request. If you specify both, you get an
535
- * <code>Invalid Parameter</code> exception.</p>
536
- * <p>If a resource specified by this parameter doesn't exist, it doesn't generate an error;
537
- * it simply isn't included in the response.</p>
538
- * <p>An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,
539
- * see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
540
- * Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS
541
- * General Reference</i>.</p>
542
- */
187
+
543
188
  ResourceARNList?: string[];
544
189
  }
545
190
  export declare namespace GetResourcesInput {
546
- /**
547
- * @internal
548
- */
191
+
549
192
  const filterSensitiveLog: (obj: GetResourcesInput) => any;
550
193
  }
551
- /**
552
- * <p>The metadata that you apply to AWS resources to help you categorize and organize
553
- * them. Each tag consists of a key and a value, both of which you define. For more
554
- * information, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
555
- * Resources</a> in the <i>AWS General Reference</i>.</p>
556
- */
194
+
557
195
  export interface Tag {
558
- /**
559
- * <p>One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.</p>
560
- */
196
+
561
197
  Key: string | undefined;
562
- /**
563
- * <p>One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.</p>
564
- */
198
+
565
199
  Value: string | undefined;
566
200
  }
567
201
  export declare namespace Tag {
568
- /**
569
- * @internal
570
- */
202
+
571
203
  const filterSensitiveLog: (obj: Tag) => any;
572
204
  }
573
- /**
574
- * <p>A list of resource ARNs and the tags (keys and values) that are associated with
575
- * each.</p>
576
- */
205
+
577
206
  export interface ResourceTagMapping {
578
- /**
579
- * <p>The ARN of the resource.</p>
580
- */
207
+
581
208
  ResourceARN?: string;
582
- /**
583
- * <p>The tags that have been applied to one or more AWS resources.</p>
584
- */
209
+
585
210
  Tags?: Tag[];
586
- /**
587
- * <p>Information that shows whether a resource is compliant with the effective tag policy,
588
- * including details on any noncompliant tag keys.</p>
589
- */
211
+
590
212
  ComplianceDetails?: ComplianceDetails;
591
213
  }
592
214
  export declare namespace ResourceTagMapping {
593
- /**
594
- * @internal
595
- */
215
+
596
216
  const filterSensitiveLog: (obj: ResourceTagMapping) => any;
597
217
  }
598
218
  export interface GetResourcesOutput {
599
- /**
600
- * <p>A string that indicates that there is more data available than this
601
- * response contains. To receive the next part of the response, specify this response value
602
- * as the <code>PaginationToken</code> value in the request for the next page.</p>
603
- */
219
+
604
220
  PaginationToken?: string;
605
- /**
606
- * <p>A list of resource ARNs and the tags (keys and values) associated with
607
- * those ARNs.</p>
608
- */
221
+
609
222
  ResourceTagMappingList?: ResourceTagMapping[];
610
223
  }
611
224
  export declare namespace GetResourcesOutput {
612
- /**
613
- * @internal
614
- */
225
+
615
226
  const filterSensitiveLog: (obj: GetResourcesOutput) => any;
616
227
  }
617
- /**
618
- * <p>A <code>PaginationToken</code> is valid for a maximum of 15 minutes. Your request was
619
- * denied because the specified <code>PaginationToken</code> has expired.</p>
620
- */
228
+
621
229
  export interface PaginationTokenExpiredException extends __SmithyException, $MetadataBearer {
622
230
  name: "PaginationTokenExpiredException";
623
231
  $fault: "client";
624
232
  Message?: string;
625
233
  }
626
234
  export declare namespace PaginationTokenExpiredException {
627
- /**
628
- * @internal
629
- */
235
+
630
236
  const filterSensitiveLog: (obj: PaginationTokenExpiredException) => any;
631
237
  }
632
238
  export interface GetTagKeysInput {
633
- /**
634
- * <p>Specifies a <code>PaginationToken</code> response value from a
635
- * previous request to indicate that you want the next page of results. Leave this parameter empty
636
- * in your initial request.</p>
637
- */
239
+
638
240
  PaginationToken?: string;
639
241
  }
640
242
  export declare namespace GetTagKeysInput {
641
- /**
642
- * @internal
643
- */
243
+
644
244
  const filterSensitiveLog: (obj: GetTagKeysInput) => any;
645
245
  }
646
246
  export interface GetTagKeysOutput {
647
- /**
648
- * <p>A string that indicates that there is more data available than this
649
- * response contains. To receive the next part of the response, specify this response value
650
- * as the <code>PaginationToken</code> value in the request for the next page.</p>
651
- */
247
+
652
248
  PaginationToken?: string;
653
- /**
654
- * <p>A list of all tag keys in the AWS account.</p>
655
- */
249
+
656
250
  TagKeys?: string[];
657
251
  }
658
252
  export declare namespace GetTagKeysOutput {
659
- /**
660
- * @internal
661
- */
253
+
662
254
  const filterSensitiveLog: (obj: GetTagKeysOutput) => any;
663
255
  }
664
256
  export interface GetTagValuesInput {
665
- /**
666
- * <p>Specifies a <code>PaginationToken</code> response value from a
667
- * previous request to indicate that you want the next page of results. Leave this parameter empty
668
- * in your initial request.</p>
669
- */
257
+
670
258
  PaginationToken?: string;
671
- /**
672
- * <p>Specifies the tag key for which you want to list all existing values that are
673
- * currently used in the specified AWS Region for the calling AWS account.</p>
674
- */
259
+
675
260
  Key: string | undefined;
676
261
  }
677
262
  export declare namespace GetTagValuesInput {
678
- /**
679
- * @internal
680
- */
263
+
681
264
  const filterSensitiveLog: (obj: GetTagValuesInput) => any;
682
265
  }
683
266
  export interface GetTagValuesOutput {
684
- /**
685
- * <p>A string that indicates that there is more data available than this
686
- * response contains. To receive the next part of the response, specify this response value
687
- * as the <code>PaginationToken</code> value in the request for the next page.</p>
688
- */
267
+
689
268
  PaginationToken?: string;
690
- /**
691
- * <p>A list of all tag values for the specified key currently used in the specified AWS
692
- * Region for the calling AWS account.</p>
693
- */
269
+
694
270
  TagValues?: string[];
695
271
  }
696
272
  export declare namespace GetTagValuesOutput {
697
- /**
698
- * @internal
699
- */
273
+
700
274
  const filterSensitiveLog: (obj: GetTagValuesOutput) => any;
701
275
  }
702
276
  export interface StartReportCreationInput {
703
- /**
704
- * <p>The name of the Amazon S3 bucket where the report will be stored; for example:</p>
705
- * <p>
706
- * <code>awsexamplebucket</code>
707
- * </p>
708
- * <p>For more information on S3 bucket requirements, including an example bucket policy,
709
- * see the example S3 bucket policy on this page.</p>
710
- */
277
+
711
278
  S3Bucket: string | undefined;
712
279
  }
713
280
  export declare namespace StartReportCreationInput {
714
- /**
715
- * @internal
716
- */
281
+
717
282
  const filterSensitiveLog: (obj: StartReportCreationInput) => any;
718
283
  }
719
284
  export interface StartReportCreationOutput {
720
285
  }
721
286
  export declare namespace StartReportCreationOutput {
722
- /**
723
- * @internal
724
- */
287
+
725
288
  const filterSensitiveLog: (obj: StartReportCreationOutput) => any;
726
289
  }
727
290
  export interface TagResourcesInput {
728
- /**
729
- * <p>Specifies the list of ARNs of the resources that you want to apply tags to.</p>
730
- * <p>An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,
731
- * see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
732
- * Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS
733
- * General Reference</i>.</p>
734
- */
291
+
735
292
  ResourceARNList: string[] | undefined;
736
- /**
737
- * <p>Specifies a list of tags that you want to add to the specified resources. A tag
738
- * consists of a key and a value that you define.</p>
739
- */
293
+
740
294
  Tags: {
741
295
  [key: string]: string;
742
296
  } | undefined;
743
297
  }
744
298
  export declare namespace TagResourcesInput {
745
- /**
746
- * @internal
747
- */
299
+
748
300
  const filterSensitiveLog: (obj: TagResourcesInput) => any;
749
301
  }
750
302
  export interface TagResourcesOutput {
751
- /**
752
- * <p>A map containing a key-value pair for each failed item that couldn't be tagged. The
753
- * key is the ARN of the failed resource. The value is a <code>FailureInfo</code> object
754
- * that contains an error code, a status code, and an error message. If there are no
755
- * errors, the <code>FailedResourcesMap</code> is empty.</p>
756
- */
303
+
757
304
  FailedResourcesMap?: {
758
305
  [key: string]: FailureInfo;
759
306
  };
760
307
  }
761
308
  export declare namespace TagResourcesOutput {
762
- /**
763
- * @internal
764
- */
309
+
765
310
  const filterSensitiveLog: (obj: TagResourcesOutput) => any;
766
311
  }
767
312
  export interface UntagResourcesInput {
768
- /**
769
- * <p>Specifies a list of ARNs of the resources that you want to remove tags from.</p>
770
- * <p>An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,
771
- * see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
772
- * Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS
773
- * General Reference</i>.</p>
774
- */
313
+
775
314
  ResourceARNList: string[] | undefined;
776
- /**
777
- * <p>Specifies a list of tag keys that you want to remove from the specified
778
- * resources.</p>
779
- */
315
+
780
316
  TagKeys: string[] | undefined;
781
317
  }
782
318
  export declare namespace UntagResourcesInput {
783
- /**
784
- * @internal
785
- */
319
+
786
320
  const filterSensitiveLog: (obj: UntagResourcesInput) => any;
787
321
  }
788
322
  export interface UntagResourcesOutput {
789
- /**
790
- * <p>A map containing a key-value pair for each failed item that couldn't be untagged. The
791
- * key is the ARN of the failed resource. The value is a <code>FailureInfo</code> object
792
- * that contains an error code, a status code, and an error message. If there are no
793
- * errors, the <code>FailedResourcesMap</code> is empty.</p>
794
- */
323
+
795
324
  FailedResourcesMap?: {
796
325
  [key: string]: FailureInfo;
797
326
  };
798
327
  }
799
328
  export declare namespace UntagResourcesOutput {
800
- /**
801
- * @internal
802
- */
329
+
803
330
  const filterSensitiveLog: (obj: UntagResourcesOutput) => any;
804
331
  }