@aws-sdk/client-resource-groups-tagging-api 3.408.0 → 3.409.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/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/commands/DescribeReportCreationCommand.d.ts +12 -12
- package/dist-types/commands/GetComplianceSummaryCommand.d.ts +16 -16
- package/dist-types/commands/GetResourcesCommand.d.ts +11 -11
- package/dist-types/commands/GetTagKeysCommand.d.ts +7 -7
- package/dist-types/commands/GetTagValuesCommand.d.ts +7 -7
- package/dist-types/commands/StartReportCreationCommand.d.ts +14 -14
- package/dist-types/commands/TagResourcesCommand.d.ts +19 -19
- package/dist-types/commands/UntagResourcesCommand.d.ts +15 -16
- package/dist-types/models/models_0.d.ts +59 -59
- package/package.json +3 -3
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const
|
|
5
|
-
const a = "
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
4
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
5
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }, { conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ endpoint: { url: "https://tagging-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://tagging-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://tagging.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://tagging.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const
|
|
2
|
-
const a = "
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
1
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
2
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }, { conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ endpoint: { url: "https://tagging-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://tagging-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://tagging.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://tagging.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -24,7 +24,7 @@ export interface DescribeReportCreationCommandOutput extends DescribeReportCreat
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Describes the status of the <code>StartReportCreation</code> operation. </p>
|
|
27
|
-
*
|
|
27
|
+
* <p>You can call this operation only from the organization's
|
|
28
28
|
* management account and from the us-east-1 Region.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -52,22 +52,22 @@ export interface DescribeReportCreationCommandOutput extends DescribeReportCreat
|
|
|
52
52
|
*
|
|
53
53
|
* @throws {@link ConstraintViolationException} (client fault)
|
|
54
54
|
* <p>The request was denied because performing this operation violates a constraint. </p>
|
|
55
|
-
*
|
|
55
|
+
* <p>Some of the reasons in the following list might not apply to this specific
|
|
56
56
|
* operation.</p>
|
|
57
|
-
*
|
|
57
|
+
* <ul>
|
|
58
58
|
* <li>
|
|
59
|
-
*
|
|
59
|
+
* <p>You must meet the prerequisites for using tag policies. For information, see
|
|
60
60
|
* <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html">Prerequisites and Permissions for Using Tag Policies</a> in the
|
|
61
61
|
* <i>Organizations User Guide.</i>
|
|
62
62
|
* </p>
|
|
63
63
|
* </li>
|
|
64
64
|
* <li>
|
|
65
|
-
*
|
|
65
|
+
* <p>You must enable the tag policies service principal
|
|
66
66
|
* (<code>tagpolicies.tag.amazonaws.com</code>) to integrate with Organizations For
|
|
67
67
|
* information, see <a href="https://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAWSServiceAccess.html">EnableAWSServiceAccess</a>.</p>
|
|
68
68
|
* </li>
|
|
69
69
|
* <li>
|
|
70
|
-
*
|
|
70
|
+
* <p>You must have a tag policy attached to the organization root, an OU, or an
|
|
71
71
|
* account.</p>
|
|
72
72
|
* </li>
|
|
73
73
|
* </ul>
|
|
@@ -78,21 +78,21 @@ export interface DescribeReportCreationCommandOutput extends DescribeReportCreat
|
|
|
78
78
|
*
|
|
79
79
|
* @throws {@link InvalidParameterException} (client fault)
|
|
80
80
|
* <p>This error indicates one of the following:</p>
|
|
81
|
-
*
|
|
81
|
+
* <ul>
|
|
82
82
|
* <li>
|
|
83
|
-
*
|
|
83
|
+
* <p>A parameter is missing.</p>
|
|
84
84
|
* </li>
|
|
85
85
|
* <li>
|
|
86
|
-
*
|
|
86
|
+
* <p>A malformed string was supplied for the request parameter.</p>
|
|
87
87
|
* </li>
|
|
88
88
|
* <li>
|
|
89
|
-
*
|
|
89
|
+
* <p>An out-of-range value was supplied for the request parameter.</p>
|
|
90
90
|
* </li>
|
|
91
91
|
* <li>
|
|
92
|
-
*
|
|
92
|
+
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
93
93
|
* </li>
|
|
94
94
|
* <li>
|
|
95
|
-
*
|
|
95
|
+
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
96
96
|
* <a href="https://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
|
|
97
97
|
* Reports</a> in the <i>Organizations User Guide.</i>
|
|
98
98
|
* </p>
|
|
@@ -25,12 +25,12 @@ export interface GetComplianceSummaryCommandOutput extends GetComplianceSummaryO
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns a table that shows counts of resources that are noncompliant with their tag
|
|
27
27
|
* policies.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>For more information on tag policies, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html">Tag Policies</a> in
|
|
29
29
|
* the <i>Organizations User Guide.</i>
|
|
30
30
|
* </p>
|
|
31
|
-
*
|
|
31
|
+
* <p>You can call this operation only from the organization's
|
|
32
32
|
* management account and from the us-east-1 Region.</p>
|
|
33
|
-
*
|
|
33
|
+
* <p>This operation supports pagination, where the response can be sent in
|
|
34
34
|
* multiple pages. You should check the <code>PaginationToken</code> response parameter to determine
|
|
35
35
|
* if there are additional results available to return. Repeat the query, passing the
|
|
36
36
|
* <code>PaginationToken</code> response parameter value as an input to the next request until you
|
|
@@ -56,7 +56,7 @@ export interface GetComplianceSummaryCommandOutput extends GetComplianceSummaryO
|
|
|
56
56
|
* "STRING_VALUE",
|
|
57
57
|
* ],
|
|
58
58
|
* GroupBy: [ // GroupBy
|
|
59
|
-
* "
|
|
59
|
+
* "TARGET_ID" || "REGION" || "RESOURCE_TYPE",
|
|
60
60
|
* ],
|
|
61
61
|
* MaxResults: Number("int"),
|
|
62
62
|
* PaginationToken: "STRING_VALUE",
|
|
@@ -68,7 +68,7 @@ export interface GetComplianceSummaryCommandOutput extends GetComplianceSummaryO
|
|
|
68
68
|
* // { // Summary
|
|
69
69
|
* // LastUpdated: "STRING_VALUE",
|
|
70
70
|
* // TargetId: "STRING_VALUE",
|
|
71
|
-
* // TargetIdType: "
|
|
71
|
+
* // TargetIdType: "ACCOUNT" || "OU" || "ROOT",
|
|
72
72
|
* // Region: "STRING_VALUE",
|
|
73
73
|
* // ResourceType: "STRING_VALUE",
|
|
74
74
|
* // NonCompliantResources: Number("long"),
|
|
@@ -87,22 +87,22 @@ export interface GetComplianceSummaryCommandOutput extends GetComplianceSummaryO
|
|
|
87
87
|
*
|
|
88
88
|
* @throws {@link ConstraintViolationException} (client fault)
|
|
89
89
|
* <p>The request was denied because performing this operation violates a constraint. </p>
|
|
90
|
-
*
|
|
90
|
+
* <p>Some of the reasons in the following list might not apply to this specific
|
|
91
91
|
* operation.</p>
|
|
92
|
-
*
|
|
92
|
+
* <ul>
|
|
93
93
|
* <li>
|
|
94
|
-
*
|
|
94
|
+
* <p>You must meet the prerequisites for using tag policies. For information, see
|
|
95
95
|
* <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html">Prerequisites and Permissions for Using Tag Policies</a> in the
|
|
96
96
|
* <i>Organizations User Guide.</i>
|
|
97
97
|
* </p>
|
|
98
98
|
* </li>
|
|
99
99
|
* <li>
|
|
100
|
-
*
|
|
100
|
+
* <p>You must enable the tag policies service principal
|
|
101
101
|
* (<code>tagpolicies.tag.amazonaws.com</code>) to integrate with Organizations For
|
|
102
102
|
* information, see <a href="https://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAWSServiceAccess.html">EnableAWSServiceAccess</a>.</p>
|
|
103
103
|
* </li>
|
|
104
104
|
* <li>
|
|
105
|
-
*
|
|
105
|
+
* <p>You must have a tag policy attached to the organization root, an OU, or an
|
|
106
106
|
* account.</p>
|
|
107
107
|
* </li>
|
|
108
108
|
* </ul>
|
|
@@ -113,21 +113,21 @@ export interface GetComplianceSummaryCommandOutput extends GetComplianceSummaryO
|
|
|
113
113
|
*
|
|
114
114
|
* @throws {@link InvalidParameterException} (client fault)
|
|
115
115
|
* <p>This error indicates one of the following:</p>
|
|
116
|
-
*
|
|
116
|
+
* <ul>
|
|
117
117
|
* <li>
|
|
118
|
-
*
|
|
118
|
+
* <p>A parameter is missing.</p>
|
|
119
119
|
* </li>
|
|
120
120
|
* <li>
|
|
121
|
-
*
|
|
121
|
+
* <p>A malformed string was supplied for the request parameter.</p>
|
|
122
122
|
* </li>
|
|
123
123
|
* <li>
|
|
124
|
-
*
|
|
124
|
+
* <p>An out-of-range value was supplied for the request parameter.</p>
|
|
125
125
|
* </li>
|
|
126
126
|
* <li>
|
|
127
|
-
*
|
|
127
|
+
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
128
128
|
* </li>
|
|
129
129
|
* <li>
|
|
130
|
-
*
|
|
130
|
+
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
131
131
|
* <a href="https://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
|
|
132
132
|
* Reports</a> in the <i>Organizations User Guide.</i>
|
|
133
133
|
* </p>
|
|
@@ -25,23 +25,23 @@ export interface GetResourcesCommandOutput extends GetResourcesOutput, __Metadat
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns all the tagged or previously tagged resources that are located in the
|
|
27
27
|
* specified Amazon Web Services Region for the account.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>Depending on what information you want returned, you can also specify the
|
|
29
29
|
* following:</p>
|
|
30
|
-
*
|
|
30
|
+
* <ul>
|
|
31
31
|
* <li>
|
|
32
|
-
*
|
|
32
|
+
* <p>
|
|
33
33
|
* <i>Filters</i> that specify what tags and resource types you
|
|
34
34
|
* want returned. The response includes all tags that are associated with the
|
|
35
35
|
* requested resources.</p>
|
|
36
36
|
* </li>
|
|
37
37
|
* <li>
|
|
38
|
-
*
|
|
38
|
+
* <p>Information about compliance with the account's effective tag policy. For more
|
|
39
39
|
* information on tag policies, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html">Tag
|
|
40
40
|
* Policies</a> in the <i>Organizations User Guide.</i>
|
|
41
41
|
* </p>
|
|
42
42
|
* </li>
|
|
43
43
|
* </ul>
|
|
44
|
-
*
|
|
44
|
+
* <p>This operation supports pagination, where the response can be sent in
|
|
45
45
|
* multiple pages. You should check the <code>PaginationToken</code> response parameter to determine
|
|
46
46
|
* if there are additional results available to return. Repeat the query, passing the
|
|
47
47
|
* <code>PaginationToken</code> response parameter value as an input to the next request until you
|
|
@@ -114,21 +114,21 @@ export interface GetResourcesCommandOutput extends GetResourcesOutput, __Metadat
|
|
|
114
114
|
*
|
|
115
115
|
* @throws {@link InvalidParameterException} (client fault)
|
|
116
116
|
* <p>This error indicates one of the following:</p>
|
|
117
|
-
*
|
|
117
|
+
* <ul>
|
|
118
118
|
* <li>
|
|
119
|
-
*
|
|
119
|
+
* <p>A parameter is missing.</p>
|
|
120
120
|
* </li>
|
|
121
121
|
* <li>
|
|
122
|
-
*
|
|
122
|
+
* <p>A malformed string was supplied for the request parameter.</p>
|
|
123
123
|
* </li>
|
|
124
124
|
* <li>
|
|
125
|
-
*
|
|
125
|
+
* <p>An out-of-range value was supplied for the request parameter.</p>
|
|
126
126
|
* </li>
|
|
127
127
|
* <li>
|
|
128
|
-
*
|
|
128
|
+
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
129
129
|
* </li>
|
|
130
130
|
* <li>
|
|
131
|
-
*
|
|
131
|
+
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
132
132
|
* <a href="https://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
|
|
133
133
|
* Reports</a> in the <i>Organizations User Guide.</i>
|
|
134
134
|
* </p>
|
|
@@ -25,7 +25,7 @@ export interface GetTagKeysCommandOutput extends GetTagKeysOutput, __MetadataBea
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns all tag keys currently in use in the specified Amazon Web Services Region for the calling
|
|
27
27
|
* account.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>This operation supports pagination, where the response can be sent in
|
|
29
29
|
* multiple pages. You should check the <code>PaginationToken</code> response parameter to determine
|
|
30
30
|
* if there are additional results available to return. Repeat the query, passing the
|
|
31
31
|
* <code>PaginationToken</code> response parameter value as an input to the next request until you
|
|
@@ -63,21 +63,21 @@ export interface GetTagKeysCommandOutput extends GetTagKeysOutput, __MetadataBea
|
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link InvalidParameterException} (client fault)
|
|
65
65
|
* <p>This error indicates one of the following:</p>
|
|
66
|
-
*
|
|
66
|
+
* <ul>
|
|
67
67
|
* <li>
|
|
68
|
-
*
|
|
68
|
+
* <p>A parameter is missing.</p>
|
|
69
69
|
* </li>
|
|
70
70
|
* <li>
|
|
71
|
-
*
|
|
71
|
+
* <p>A malformed string was supplied for the request parameter.</p>
|
|
72
72
|
* </li>
|
|
73
73
|
* <li>
|
|
74
|
-
*
|
|
74
|
+
* <p>An out-of-range value was supplied for the request parameter.</p>
|
|
75
75
|
* </li>
|
|
76
76
|
* <li>
|
|
77
|
-
*
|
|
77
|
+
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
78
78
|
* </li>
|
|
79
79
|
* <li>
|
|
80
|
-
*
|
|
80
|
+
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
81
81
|
* <a href="https://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
|
|
82
82
|
* Reports</a> in the <i>Organizations User Guide.</i>
|
|
83
83
|
* </p>
|
|
@@ -25,7 +25,7 @@ export interface GetTagValuesCommandOutput extends GetTagValuesOutput, __Metadat
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns all tag values for the specified key that are used in the specified Amazon Web Services
|
|
27
27
|
* Region for the calling account.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>This operation supports pagination, where the response can be sent in
|
|
29
29
|
* multiple pages. You should check the <code>PaginationToken</code> response parameter to determine
|
|
30
30
|
* if there are additional results available to return. Repeat the query, passing the
|
|
31
31
|
* <code>PaginationToken</code> response parameter value as an input to the next request until you
|
|
@@ -64,21 +64,21 @@ export interface GetTagValuesCommandOutput extends GetTagValuesOutput, __Metadat
|
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link InvalidParameterException} (client fault)
|
|
66
66
|
* <p>This error indicates one of the following:</p>
|
|
67
|
-
*
|
|
67
|
+
* <ul>
|
|
68
68
|
* <li>
|
|
69
|
-
*
|
|
69
|
+
* <p>A parameter is missing.</p>
|
|
70
70
|
* </li>
|
|
71
71
|
* <li>
|
|
72
|
-
*
|
|
72
|
+
* <p>A malformed string was supplied for the request parameter.</p>
|
|
73
73
|
* </li>
|
|
74
74
|
* <li>
|
|
75
|
-
*
|
|
75
|
+
* <p>An out-of-range value was supplied for the request parameter.</p>
|
|
76
76
|
* </li>
|
|
77
77
|
* <li>
|
|
78
|
-
*
|
|
78
|
+
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
79
79
|
* </li>
|
|
80
80
|
* <li>
|
|
81
|
-
*
|
|
81
|
+
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
82
82
|
* <a href="https://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
|
|
83
83
|
* Reports</a> in the <i>Organizations User Guide.</i>
|
|
84
84
|
* </p>
|
|
@@ -26,11 +26,11 @@ export interface StartReportCreationCommandOutput extends StartReportCreationOut
|
|
|
26
26
|
* <p>Generates a report that lists all tagged resources in the accounts across your
|
|
27
27
|
* organization and tells whether each resource is compliant with the effective tag policy.
|
|
28
28
|
* Compliance data is refreshed daily. The report is generated asynchronously.</p>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
29
|
+
* <p>The generated report is saved to the following location:</p>
|
|
30
|
+
* <p>
|
|
31
31
|
* <code>s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv</code>
|
|
32
32
|
* </p>
|
|
33
|
-
*
|
|
33
|
+
* <p>You can call this operation only from the organization's
|
|
34
34
|
* management account and from the us-east-1 Region.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -59,22 +59,22 @@ export interface StartReportCreationCommandOutput extends StartReportCreationOut
|
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link ConstraintViolationException} (client fault)
|
|
61
61
|
* <p>The request was denied because performing this operation violates a constraint. </p>
|
|
62
|
-
*
|
|
62
|
+
* <p>Some of the reasons in the following list might not apply to this specific
|
|
63
63
|
* operation.</p>
|
|
64
|
-
*
|
|
64
|
+
* <ul>
|
|
65
65
|
* <li>
|
|
66
|
-
*
|
|
66
|
+
* <p>You must meet the prerequisites for using tag policies. For information, see
|
|
67
67
|
* <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html">Prerequisites and Permissions for Using Tag Policies</a> in the
|
|
68
68
|
* <i>Organizations User Guide.</i>
|
|
69
69
|
* </p>
|
|
70
70
|
* </li>
|
|
71
71
|
* <li>
|
|
72
|
-
*
|
|
72
|
+
* <p>You must enable the tag policies service principal
|
|
73
73
|
* (<code>tagpolicies.tag.amazonaws.com</code>) to integrate with Organizations For
|
|
74
74
|
* information, see <a href="https://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAWSServiceAccess.html">EnableAWSServiceAccess</a>.</p>
|
|
75
75
|
* </li>
|
|
76
76
|
* <li>
|
|
77
|
-
*
|
|
77
|
+
* <p>You must have a tag policy attached to the organization root, an OU, or an
|
|
78
78
|
* account.</p>
|
|
79
79
|
* </li>
|
|
80
80
|
* </ul>
|
|
@@ -85,21 +85,21 @@ export interface StartReportCreationCommandOutput extends StartReportCreationOut
|
|
|
85
85
|
*
|
|
86
86
|
* @throws {@link InvalidParameterException} (client fault)
|
|
87
87
|
* <p>This error indicates one of the following:</p>
|
|
88
|
-
*
|
|
88
|
+
* <ul>
|
|
89
89
|
* <li>
|
|
90
|
-
*
|
|
90
|
+
* <p>A parameter is missing.</p>
|
|
91
91
|
* </li>
|
|
92
92
|
* <li>
|
|
93
|
-
*
|
|
93
|
+
* <p>A malformed string was supplied for the request parameter.</p>
|
|
94
94
|
* </li>
|
|
95
95
|
* <li>
|
|
96
|
-
*
|
|
96
|
+
* <p>An out-of-range value was supplied for the request parameter.</p>
|
|
97
97
|
* </li>
|
|
98
98
|
* <li>
|
|
99
|
-
*
|
|
99
|
+
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
100
100
|
* </li>
|
|
101
101
|
* <li>
|
|
102
|
-
*
|
|
102
|
+
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
103
103
|
* <a href="https://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
|
|
104
104
|
* Reports</a> in the <i>Organizations User Guide.</i>
|
|
105
105
|
* </p>
|
|
@@ -24,9 +24,9 @@ export interface TagResourcesCommandOutput extends TagResourcesOutput, __Metadat
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Applies one or more tags to the specified resources. Note the following:</p>
|
|
27
|
-
*
|
|
27
|
+
* <ul>
|
|
28
28
|
* <li>
|
|
29
|
-
*
|
|
29
|
+
* <p>Not all resources can have tags. For a list of services with resources that
|
|
30
30
|
* support tagging using this operation, see <a href="https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html">Services that support the
|
|
31
31
|
* Resource Groups Tagging API</a>. If the resource doesn't yet support
|
|
32
32
|
* this operation, the resource's service might support tagging using its own API
|
|
@@ -34,41 +34,41 @@ export interface TagResourcesCommandOutput extends TagResourcesOutput, __Metadat
|
|
|
34
34
|
* service.</p>
|
|
35
35
|
* </li>
|
|
36
36
|
* <li>
|
|
37
|
-
*
|
|
37
|
+
* <p>Each resource can have up to 50 tags. For other limits, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions">Tag Naming and Usage Conventions</a> in the <i>Amazon Web Services General
|
|
38
38
|
* Reference.</i>
|
|
39
39
|
* </p>
|
|
40
40
|
* </li>
|
|
41
41
|
* <li>
|
|
42
|
-
*
|
|
42
|
+
* <p>You can only tag resources that are located in the specified Amazon Web Services Region for
|
|
43
43
|
* the Amazon Web Services account.</p>
|
|
44
44
|
* </li>
|
|
45
45
|
* <li>
|
|
46
|
-
*
|
|
46
|
+
* <p>To add tags to a resource, you need the necessary permissions for the service
|
|
47
47
|
* that the resource belongs to as well as permissions for adding tags. For more
|
|
48
48
|
* information, see the documentation for each service.</p>
|
|
49
49
|
* </li>
|
|
50
50
|
* </ul>
|
|
51
|
-
*
|
|
51
|
+
* <important>
|
|
52
52
|
* <p>Do not store personally identifiable information (PII) or other confidential or
|
|
53
53
|
* sensitive information in tags. We use tags to provide you with billing and
|
|
54
54
|
* administration services. Tags are not intended to be used for private or sensitive
|
|
55
55
|
* data.</p>
|
|
56
|
-
*
|
|
57
|
-
*
|
|
56
|
+
* </important>
|
|
57
|
+
* <p>
|
|
58
58
|
* <b>Minimum permissions</b>
|
|
59
59
|
* </p>
|
|
60
|
-
*
|
|
60
|
+
* <p>In addition to the <code>tag:TagResources</code> permission required by this
|
|
61
61
|
* operation, you must also have the tagging permission defined by the service that created
|
|
62
62
|
* the resource. For example, to tag an Amazon EC2 instance using the <code>TagResources</code>
|
|
63
63
|
* operation, you must have both of the following permissions:</p>
|
|
64
|
-
*
|
|
64
|
+
* <ul>
|
|
65
65
|
* <li>
|
|
66
|
-
*
|
|
66
|
+
* <p>
|
|
67
67
|
* <code>tag:TagResource</code>
|
|
68
68
|
* </p>
|
|
69
69
|
* </li>
|
|
70
70
|
* <li>
|
|
71
|
-
*
|
|
71
|
+
* <p>
|
|
72
72
|
* <code>ec2:CreateTags</code>
|
|
73
73
|
* </p>
|
|
74
74
|
* </li>
|
|
@@ -93,7 +93,7 @@ export interface TagResourcesCommandOutput extends TagResourcesOutput, __Metadat
|
|
|
93
93
|
* // FailedResourcesMap: { // FailedResourcesMap
|
|
94
94
|
* // "<keys>": { // FailureInfo
|
|
95
95
|
* // StatusCode: Number("int"),
|
|
96
|
-
* // ErrorCode: "
|
|
96
|
+
* // ErrorCode: "InternalServiceException" || "InvalidParameterException",
|
|
97
97
|
* // ErrorMessage: "STRING_VALUE",
|
|
98
98
|
* // },
|
|
99
99
|
* // },
|
|
@@ -113,21 +113,21 @@ export interface TagResourcesCommandOutput extends TagResourcesOutput, __Metadat
|
|
|
113
113
|
*
|
|
114
114
|
* @throws {@link InvalidParameterException} (client fault)
|
|
115
115
|
* <p>This error indicates one of the following:</p>
|
|
116
|
-
*
|
|
116
|
+
* <ul>
|
|
117
117
|
* <li>
|
|
118
|
-
*
|
|
118
|
+
* <p>A parameter is missing.</p>
|
|
119
119
|
* </li>
|
|
120
120
|
* <li>
|
|
121
|
-
*
|
|
121
|
+
* <p>A malformed string was supplied for the request parameter.</p>
|
|
122
122
|
* </li>
|
|
123
123
|
* <li>
|
|
124
|
-
*
|
|
124
|
+
* <p>An out-of-range value was supplied for the request parameter.</p>
|
|
125
125
|
* </li>
|
|
126
126
|
* <li>
|
|
127
|
-
*
|
|
127
|
+
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
128
128
|
* </li>
|
|
129
129
|
* <li>
|
|
130
|
-
*
|
|
130
|
+
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
131
131
|
* <a href="https://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
|
|
132
132
|
* Reports</a> in the <i>Organizations User Guide.</i>
|
|
133
133
|
* </p>
|
|
@@ -27,35 +27,34 @@ export interface UntagResourcesCommandOutput extends UntagResourcesOutput, __Met
|
|
|
27
27
|
* the action removes both that key and its associated value. The operation succeeds even
|
|
28
28
|
* if you attempt to remove tags from a resource that were already removed. Note the
|
|
29
29
|
* following:</p>
|
|
30
|
-
*
|
|
30
|
+
* <ul>
|
|
31
31
|
* <li>
|
|
32
|
-
*
|
|
32
|
+
* <p>To remove tags from a resource, you need the necessary permissions for the
|
|
33
33
|
* service that the resource belongs to as well as permissions for removing tags.
|
|
34
34
|
* For more information, see the documentation for the service whose resource you
|
|
35
35
|
* want to untag.</p>
|
|
36
36
|
* </li>
|
|
37
37
|
* <li>
|
|
38
|
-
*
|
|
38
|
+
* <p>You can only tag resources that are located in the specified Amazon Web Services Region for
|
|
39
39
|
* the calling Amazon Web Services account.</p>
|
|
40
40
|
* </li>
|
|
41
41
|
* </ul>
|
|
42
|
-
*
|
|
43
|
-
* <p>
|
|
42
|
+
* <p>
|
|
44
43
|
* <b>Minimum permissions</b>
|
|
45
44
|
* </p>
|
|
46
|
-
*
|
|
45
|
+
* <p>In addition to the <code>tag:UntagResources</code> permission required by this
|
|
47
46
|
* operation, you must also have the remove tags permission defined by the service that
|
|
48
47
|
* created the resource. For example, to remove the tags from an Amazon EC2 instance using the
|
|
49
48
|
* <code>UntagResources</code> operation, you must have both of the following
|
|
50
49
|
* permissions:</p>
|
|
51
|
-
*
|
|
50
|
+
* <ul>
|
|
52
51
|
* <li>
|
|
53
|
-
*
|
|
52
|
+
* <p>
|
|
54
53
|
* <code>tag:UntagResource</code>
|
|
55
54
|
* </p>
|
|
56
55
|
* </li>
|
|
57
56
|
* <li>
|
|
58
|
-
*
|
|
57
|
+
* <p>
|
|
59
58
|
* <code>ec2:DeleteTags</code>
|
|
60
59
|
* </p>
|
|
61
60
|
* </li>
|
|
@@ -80,7 +79,7 @@ export interface UntagResourcesCommandOutput extends UntagResourcesOutput, __Met
|
|
|
80
79
|
* // FailedResourcesMap: { // FailedResourcesMap
|
|
81
80
|
* // "<keys>": { // FailureInfo
|
|
82
81
|
* // StatusCode: Number("int"),
|
|
83
|
-
* // ErrorCode: "
|
|
82
|
+
* // ErrorCode: "InternalServiceException" || "InvalidParameterException",
|
|
84
83
|
* // ErrorMessage: "STRING_VALUE",
|
|
85
84
|
* // },
|
|
86
85
|
* // },
|
|
@@ -100,21 +99,21 @@ export interface UntagResourcesCommandOutput extends UntagResourcesOutput, __Met
|
|
|
100
99
|
*
|
|
101
100
|
* @throws {@link InvalidParameterException} (client fault)
|
|
102
101
|
* <p>This error indicates one of the following:</p>
|
|
103
|
-
*
|
|
102
|
+
* <ul>
|
|
104
103
|
* <li>
|
|
105
|
-
*
|
|
104
|
+
* <p>A parameter is missing.</p>
|
|
106
105
|
* </li>
|
|
107
106
|
* <li>
|
|
108
|
-
*
|
|
107
|
+
* <p>A malformed string was supplied for the request parameter.</p>
|
|
109
108
|
* </li>
|
|
110
109
|
* <li>
|
|
111
|
-
*
|
|
110
|
+
* <p>An out-of-range value was supplied for the request parameter.</p>
|
|
112
111
|
* </li>
|
|
113
112
|
* <li>
|
|
114
|
-
*
|
|
113
|
+
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
115
114
|
* </li>
|
|
116
115
|
* <li>
|
|
117
|
-
*
|
|
116
|
+
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
118
117
|
* <a href="https://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
|
|
119
118
|
* Reports</a> in the <i>Organizations User Guide.</i>
|
|
120
119
|
* </p>
|
|
@@ -40,22 +40,22 @@ export declare class ConcurrentModificationException extends __BaseException {
|
|
|
40
40
|
/**
|
|
41
41
|
* @public
|
|
42
42
|
* <p>The request was denied because performing this operation violates a constraint. </p>
|
|
43
|
-
*
|
|
43
|
+
* <p>Some of the reasons in the following list might not apply to this specific
|
|
44
44
|
* operation.</p>
|
|
45
|
-
*
|
|
45
|
+
* <ul>
|
|
46
46
|
* <li>
|
|
47
|
-
*
|
|
47
|
+
* <p>You must meet the prerequisites for using tag policies. For information, see
|
|
48
48
|
* <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html">Prerequisites and Permissions for Using Tag Policies</a> in the
|
|
49
49
|
* <i>Organizations User Guide.</i>
|
|
50
50
|
* </p>
|
|
51
51
|
* </li>
|
|
52
52
|
* <li>
|
|
53
|
-
*
|
|
53
|
+
* <p>You must enable the tag policies service principal
|
|
54
54
|
* (<code>tagpolicies.tag.amazonaws.com</code>) to integrate with Organizations For
|
|
55
55
|
* information, see <a href="https://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAWSServiceAccess.html">EnableAWSServiceAccess</a>.</p>
|
|
56
56
|
* </li>
|
|
57
57
|
* <li>
|
|
58
|
-
*
|
|
58
|
+
* <p>You must have a tag policy attached to the organization root, an OU, or an
|
|
59
59
|
* account.</p>
|
|
60
60
|
* </li>
|
|
61
61
|
* </ul>
|
|
@@ -81,25 +81,25 @@ export interface DescribeReportCreationOutput {
|
|
|
81
81
|
/**
|
|
82
82
|
* @public
|
|
83
83
|
* <p>Reports the status of the operation.</p>
|
|
84
|
-
*
|
|
85
|
-
*
|
|
84
|
+
* <p>The operation status can be one of the following:</p>
|
|
85
|
+
* <ul>
|
|
86
86
|
* <li>
|
|
87
|
-
*
|
|
87
|
+
* <p>
|
|
88
88
|
* <code>RUNNING</code> - Report creation is in progress.</p>
|
|
89
89
|
* </li>
|
|
90
90
|
* <li>
|
|
91
|
-
*
|
|
91
|
+
* <p>
|
|
92
92
|
* <code>SUCCEEDED</code> - Report creation is complete. You can open the report
|
|
93
93
|
* from the Amazon S3 bucket that you specified when you ran
|
|
94
94
|
* <code>StartReportCreation</code>.</p>
|
|
95
95
|
* </li>
|
|
96
96
|
* <li>
|
|
97
|
-
*
|
|
97
|
+
* <p>
|
|
98
98
|
* <code>FAILED</code> - Report creation timed out or the Amazon S3 bucket is not
|
|
99
99
|
* accessible. </p>
|
|
100
100
|
* </li>
|
|
101
101
|
* <li>
|
|
102
|
-
*
|
|
102
|
+
* <p>
|
|
103
103
|
* <code>NO REPORT</code> - No report was generated in the last 90 days.</p>
|
|
104
104
|
* </li>
|
|
105
105
|
* </ul>
|
|
@@ -138,21 +138,21 @@ export declare class InternalServiceException extends __BaseException {
|
|
|
138
138
|
/**
|
|
139
139
|
* @public
|
|
140
140
|
* <p>This error indicates one of the following:</p>
|
|
141
|
-
*
|
|
141
|
+
* <ul>
|
|
142
142
|
* <li>
|
|
143
|
-
*
|
|
143
|
+
* <p>A parameter is missing.</p>
|
|
144
144
|
* </li>
|
|
145
145
|
* <li>
|
|
146
|
-
*
|
|
146
|
+
* <p>A malformed string was supplied for the request parameter.</p>
|
|
147
147
|
* </li>
|
|
148
148
|
* <li>
|
|
149
|
-
*
|
|
149
|
+
* <p>An out-of-range value was supplied for the request parameter.</p>
|
|
150
150
|
* </li>
|
|
151
151
|
* <li>
|
|
152
|
-
*
|
|
152
|
+
* <p>The target ID is invalid, unsupported, or doesn't exist.</p>
|
|
153
153
|
* </li>
|
|
154
154
|
* <li>
|
|
155
|
-
*
|
|
155
|
+
* <p>You can't access the Amazon S3 bucket for report storage. For more information, see
|
|
156
156
|
* <a href="https://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
|
|
157
157
|
* Reports</a> in the <i>Organizations User Guide.</i>
|
|
158
158
|
* </p>
|
|
@@ -200,31 +200,31 @@ export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
|
200
200
|
* <code>InvalidParameterException</code> errors. It can also include any valid error
|
|
201
201
|
* code returned by the Amazon Web Services service that hosts the resource that the ARN key
|
|
202
202
|
* represents.</p>
|
|
203
|
-
*
|
|
203
|
+
* <p>The following are common error codes that you might receive from other Amazon Web Services
|
|
204
204
|
* services:</p>
|
|
205
|
-
*
|
|
205
|
+
* <ul>
|
|
206
206
|
* <li>
|
|
207
|
-
*
|
|
207
|
+
* <p>
|
|
208
208
|
* <b>InternalServiceException</b> – This can
|
|
209
209
|
* mean that the Resource Groups Tagging API didn't receive a response from another Amazon Web Services service. It
|
|
210
210
|
* can also mean that the resource type in the request is not supported by the
|
|
211
211
|
* Resource Groups Tagging API. In these cases, it's safe to retry the request and then call <a href="https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html">GetResources</a> to verify the changes.</p>
|
|
212
212
|
* </li>
|
|
213
213
|
* <li>
|
|
214
|
-
*
|
|
214
|
+
* <p>
|
|
215
215
|
* <b>AccessDeniedException</b> – This can mean
|
|
216
216
|
* that you need permission to call the tagging operations in the Amazon Web Services service
|
|
217
217
|
* that contains the resource. For example, to use the Resource Groups Tagging API to tag a Amazon CloudWatch
|
|
218
218
|
* alarm resource, you need permission to call both <a href="https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html">
|
|
219
219
|
* <code>TagResources</code>
|
|
220
220
|
* </a>
|
|
221
|
-
*
|
|
222
|
-
*
|
|
221
|
+
* <i>and</i>
|
|
222
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">
|
|
223
223
|
* <code>TagResource</code>
|
|
224
224
|
* </a> in the CloudWatch API. </p>
|
|
225
225
|
* </li>
|
|
226
226
|
* </ul>
|
|
227
|
-
*
|
|
227
|
+
* <p>For more information on errors that are generated from other Amazon Web Services services, see the
|
|
228
228
|
* documentation for that service. </p>
|
|
229
229
|
*/
|
|
230
230
|
export interface FailureInfo {
|
|
@@ -286,25 +286,25 @@ export interface GetComplianceSummaryInput {
|
|
|
286
286
|
* <code>ec2</code> returns all Amazon EC2 resources (which includes EC2 instances).
|
|
287
287
|
* Specifying a resource type of <code>ec2:instance</code> returns only EC2
|
|
288
288
|
* instances.</p>
|
|
289
|
-
*
|
|
289
|
+
* <p>The string for each service name and resource type is the same as that embedded in a
|
|
290
290
|
* resource's Amazon Resource Name (ARN). Consult the <i>
|
|
291
291
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/">Amazon Web Services General Reference</a>
|
|
292
292
|
* </i>
|
|
293
293
|
* for the following:</p>
|
|
294
|
-
*
|
|
294
|
+
* <ul>
|
|
295
295
|
* <li>
|
|
296
|
-
*
|
|
296
|
+
* <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">Amazon Web Services Service Namespaces</a>.</p>
|
|
297
297
|
* </li>
|
|
298
298
|
* <li>
|
|
299
|
-
*
|
|
299
|
+
* <p>For resource type strings, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax">Example
|
|
300
300
|
* ARNs</a>.</p>
|
|
301
301
|
* </li>
|
|
302
302
|
* <li>
|
|
303
|
-
*
|
|
303
|
+
* <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
|
|
304
304
|
* (ARNs) and Amazon Web Services Service Namespaces</a>.</p>
|
|
305
305
|
* </li>
|
|
306
306
|
* </ul>
|
|
307
|
-
*
|
|
307
|
+
* <p>You can specify multiple resource types by using a comma separated array. The array
|
|
308
308
|
* can include up to 100 items. Note that the length constraint requirement applies to each
|
|
309
309
|
* resource type filter. </p>
|
|
310
310
|
*/
|
|
@@ -441,55 +441,55 @@ export interface GetResourcesInput {
|
|
|
441
441
|
* resources that have tags with the specified keys and, if included, the specified values.
|
|
442
442
|
* Each <code>TagFilter</code> must contain a key with values optional. A request can
|
|
443
443
|
* include up to 50 keys, and each key can include up to 20 values. </p>
|
|
444
|
-
*
|
|
445
|
-
*
|
|
444
|
+
* <p>Note the following when deciding how to use TagFilters:</p>
|
|
445
|
+
* <ul>
|
|
446
446
|
* <li>
|
|
447
|
-
*
|
|
447
|
+
* <p>If you <i>don't</i> specify a <code>TagFilter</code>, the
|
|
448
448
|
* response includes all resources that are currently tagged or ever had a tag.
|
|
449
449
|
* Resources that currently don't have tags are shown with an empty tag set, like
|
|
450
450
|
* this: <code>"Tags": []</code>.</p>
|
|
451
451
|
* </li>
|
|
452
452
|
* <li>
|
|
453
|
-
*
|
|
453
|
+
* <p>If you specify more than one filter in a single request, the response returns
|
|
454
454
|
* only those resources that satisfy all filters.</p>
|
|
455
455
|
* </li>
|
|
456
456
|
* <li>
|
|
457
|
-
*
|
|
457
|
+
* <p>If you specify a filter that contains more than one value for a key, the
|
|
458
458
|
* response returns resources that match <i>any</i> of the specified
|
|
459
459
|
* values for that key.</p>
|
|
460
460
|
* </li>
|
|
461
461
|
* <li>
|
|
462
|
-
*
|
|
462
|
+
* <p>If you don't specify a value for a key, the response returns all resources
|
|
463
463
|
* that are tagged with that key, with any or no value.</p>
|
|
464
|
-
*
|
|
464
|
+
* <p>For example, for the following filters: <code>filter1= \{keyA,\{value1\}\}</code>,
|
|
465
465
|
* <code>filter2=\{keyB,\{value2,value3,value4\}\}</code>, <code>filter3=
|
|
466
466
|
* \{keyC\}</code>:</p>
|
|
467
|
-
*
|
|
467
|
+
* <ul>
|
|
468
468
|
* <li>
|
|
469
|
-
*
|
|
469
|
+
* <p>
|
|
470
470
|
* <code>GetResources(\{filter1\})</code> returns resources tagged with
|
|
471
471
|
* <code>key1=value1</code>
|
|
472
472
|
* </p>
|
|
473
|
-
*
|
|
473
|
+
* </li>
|
|
474
474
|
* <li>
|
|
475
|
-
*
|
|
475
|
+
* <p>
|
|
476
476
|
* <code>GetResources(\{filter2\})</code> returns resources tagged with
|
|
477
477
|
* <code>key2=value2</code> or <code>key2=value3</code> or
|
|
478
478
|
* <code>key2=value4</code>
|
|
479
479
|
* </p>
|
|
480
|
-
*
|
|
480
|
+
* </li>
|
|
481
481
|
* <li>
|
|
482
|
-
*
|
|
482
|
+
* <p>
|
|
483
483
|
* <code>GetResources(\{filter3\})</code> returns resources tagged with any
|
|
484
484
|
* tag with the key <code>key3</code>, and with any or no value</p>
|
|
485
|
-
*
|
|
485
|
+
* </li>
|
|
486
486
|
* <li>
|
|
487
|
-
*
|
|
487
|
+
* <p>
|
|
488
488
|
* <code>GetResources(\{filter1,filter2,filter3\})</code> returns resources
|
|
489
489
|
* tagged with <code>(key1=value1) and (key2=value2 or key2=value3 or
|
|
490
490
|
* key2=value4) and (key3, any or no value)</code>
|
|
491
491
|
* </p>
|
|
492
|
-
*
|
|
492
|
+
* </li>
|
|
493
493
|
* </ul>
|
|
494
494
|
* </li>
|
|
495
495
|
* </ul>
|
|
@@ -506,10 +506,10 @@ export interface GetResourcesInput {
|
|
|
506
506
|
/**
|
|
507
507
|
* @public
|
|
508
508
|
* <p>Amazon Web Services recommends using <code>ResourcesPerPage</code> instead of this parameter.</p>
|
|
509
|
-
*
|
|
509
|
+
* <p>A limit that restricts the number of tags (key and value pairs) returned by
|
|
510
510
|
* <code>GetResources</code> in paginated output. A resource with no tags is counted as
|
|
511
511
|
* having one tag (one key and value pair).</p>
|
|
512
|
-
*
|
|
512
|
+
* <p>
|
|
513
513
|
* <code>GetResources</code> does not split a resource and its associated tags across
|
|
514
514
|
* pages. If the specified <code>TagsPerPage</code> would cause such a break, a
|
|
515
515
|
* <code>PaginationToken</code> is returned in place of the affected resource and its
|
|
@@ -519,7 +519,7 @@ export interface GetResourcesInput {
|
|
|
519
519
|
* will consist of three pages. The first page displays the first 10 resources, each with
|
|
520
520
|
* its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The
|
|
521
521
|
* third page displays the remaining 2 resources, each with its 10 tags.</p>
|
|
522
|
-
*
|
|
522
|
+
* <p>You can set <code>TagsPerPage</code> to a minimum of 100 items up to a maximum of 500
|
|
523
523
|
* items.</p>
|
|
524
524
|
*/
|
|
525
525
|
TagsPerPage?: number;
|
|
@@ -530,14 +530,14 @@ export interface GetResourcesInput {
|
|
|
530
530
|
* resource type of <code>ec2</code> returns all Amazon EC2 resources (which includes EC2
|
|
531
531
|
* instances). Specifying a resource type of <code>ec2:instance</code> returns only EC2
|
|
532
532
|
* instances. </p>
|
|
533
|
-
*
|
|
533
|
+
* <p>The string for each service name and resource type is the same as that embedded in a
|
|
534
534
|
* resource's Amazon Resource Name (ARN). For the list of services whose resources you can
|
|
535
535
|
* use in this parameter, see <a href="https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html">Services that support the Resource Groups Tagging API</a>.</p>
|
|
536
|
-
*
|
|
536
|
+
* <p>You can specify multiple resource types by using an array. The array can include up to
|
|
537
537
|
* 100 items. Note that the length constraint requirement applies to each resource type
|
|
538
538
|
* filter. For example, the following string would limit the response to only Amazon EC2
|
|
539
539
|
* instances, Amazon S3 buckets, or any Audit Manager resource:</p>
|
|
540
|
-
*
|
|
540
|
+
* <p>
|
|
541
541
|
* <code>ec2:instance,s3:bucket,auditmanager</code>
|
|
542
542
|
* </p>
|
|
543
543
|
*/
|
|
@@ -554,7 +554,7 @@ export interface GetResourcesInput {
|
|
|
554
554
|
* <p>Specifies whether to exclude resources that are compliant with the tag policy. Set
|
|
555
555
|
* this to <code>true</code> if you are interested in retrieving information on
|
|
556
556
|
* noncompliant resources only.</p>
|
|
557
|
-
*
|
|
557
|
+
* <p>You can use this parameter only if the <code>IncludeComplianceDetails</code> parameter
|
|
558
558
|
* is also set to <code>true</code>.</p>
|
|
559
559
|
*/
|
|
560
560
|
ExcludeCompliantResources?: boolean;
|
|
@@ -565,9 +565,9 @@ export interface GetResourcesInput {
|
|
|
565
565
|
* (<code>ResourcesPerPage</code>, <code>TagsPerPage</code>,
|
|
566
566
|
* <code>PaginationToken</code>) in the same request. If you specify both, you get an
|
|
567
567
|
* <code>Invalid Parameter</code> exception.</p>
|
|
568
|
-
*
|
|
568
|
+
* <p>If a resource specified by this parameter doesn't exist, it doesn't generate an error;
|
|
569
569
|
* it simply isn't included in the response.</p>
|
|
570
|
-
*
|
|
570
|
+
* <p>An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,
|
|
571
571
|
* see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
572
572
|
* Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the
|
|
573
573
|
* <i>Amazon Web Services General Reference</i>.</p>
|
|
@@ -721,10 +721,10 @@ export interface StartReportCreationInput {
|
|
|
721
721
|
/**
|
|
722
722
|
* @public
|
|
723
723
|
* <p>The name of the Amazon S3 bucket where the report will be stored; for example:</p>
|
|
724
|
-
*
|
|
724
|
+
* <p>
|
|
725
725
|
* <code>awsexamplebucket</code>
|
|
726
726
|
* </p>
|
|
727
|
-
*
|
|
727
|
+
* <p>For more information on S3 bucket requirements, including an example bucket policy,
|
|
728
728
|
* see the example S3 bucket policy on this page.</p>
|
|
729
729
|
*/
|
|
730
730
|
S3Bucket: string | undefined;
|
|
@@ -741,7 +741,7 @@ export interface TagResourcesInput {
|
|
|
741
741
|
/**
|
|
742
742
|
* @public
|
|
743
743
|
* <p>Specifies the list of ARNs of the resources that you want to apply tags to.</p>
|
|
744
|
-
*
|
|
744
|
+
* <p>An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,
|
|
745
745
|
* see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
746
746
|
* Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services
|
|
747
747
|
* General Reference</i>.</p>
|
|
@@ -774,7 +774,7 @@ export interface UntagResourcesInput {
|
|
|
774
774
|
/**
|
|
775
775
|
* @public
|
|
776
776
|
* <p>Specifies a list of ARNs of the resources that you want to remove tags from.</p>
|
|
777
|
-
*
|
|
777
|
+
* <p>An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,
|
|
778
778
|
* see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
|
|
779
779
|
* Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services
|
|
780
780
|
* General Reference</i>.</p>
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-resource-groups-tagging-api",
|
|
3
3
|
"description": "AWS SDK for JavaScript Resource Groups Tagging Api Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.409.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,8 +21,8 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.409.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.409.0",
|
|
26
26
|
"@aws-sdk/middleware-host-header": "3.408.0",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.408.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.408.0",
|