@aws-sdk/client-controltower 3.163.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +201 -0
  3. package/README.md +275 -0
  4. package/dist-cjs/ControlTower.js +67 -0
  5. package/dist-cjs/ControlTowerClient.js +37 -0
  6. package/dist-cjs/commands/DisableControlCommand.js +36 -0
  7. package/dist-cjs/commands/EnableControlCommand.js +36 -0
  8. package/dist-cjs/commands/GetControlOperationCommand.js +36 -0
  9. package/dist-cjs/commands/ListEnabledControlsCommand.js +36 -0
  10. package/dist-cjs/commands/index.js +7 -0
  11. package/dist-cjs/endpoints.js +169 -0
  12. package/dist-cjs/index.js +11 -0
  13. package/dist-cjs/models/ControlTowerServiceException.js +11 -0
  14. package/dist-cjs/models/index.js +4 -0
  15. package/dist-cjs/models/models_0.js +153 -0
  16. package/dist-cjs/pagination/Interfaces.js +2 -0
  17. package/dist-cjs/pagination/ListEnabledControlsPaginator.js +36 -0
  18. package/dist-cjs/pagination/index.js +5 -0
  19. package/dist-cjs/protocols/Aws_restJson1.js +468 -0
  20. package/dist-cjs/runtimeConfig.browser.js +45 -0
  21. package/dist-cjs/runtimeConfig.js +52 -0
  22. package/dist-cjs/runtimeConfig.native.js +16 -0
  23. package/dist-cjs/runtimeConfig.shared.js +17 -0
  24. package/dist-es/ControlTower.js +70 -0
  25. package/dist-es/ControlTowerClient.js +39 -0
  26. package/dist-es/commands/DisableControlCommand.js +39 -0
  27. package/dist-es/commands/EnableControlCommand.js +39 -0
  28. package/dist-es/commands/GetControlOperationCommand.js +39 -0
  29. package/dist-es/commands/ListEnabledControlsCommand.js +39 -0
  30. package/dist-es/commands/index.js +4 -0
  31. package/dist-es/endpoints.js +165 -0
  32. package/dist-es/index.js +6 -0
  33. package/dist-es/models/ControlTowerServiceException.js +12 -0
  34. package/dist-es/models/index.js +1 -0
  35. package/dist-es/models/models_0.js +114 -0
  36. package/dist-es/pagination/Interfaces.js +1 -0
  37. package/dist-es/pagination/ListEnabledControlsPaginator.js +75 -0
  38. package/dist-es/pagination/index.js +2 -0
  39. package/dist-es/protocols/Aws_restJson1.js +589 -0
  40. package/dist-es/runtimeConfig.browser.js +26 -0
  41. package/dist-es/runtimeConfig.js +30 -0
  42. package/dist-es/runtimeConfig.native.js +8 -0
  43. package/dist-es/runtimeConfig.shared.js +13 -0
  44. package/dist-types/ControlTower.d.ts +112 -0
  45. package/dist-types/ControlTowerClient.d.ts +218 -0
  46. package/dist-types/commands/DisableControlCommand.d.ts +37 -0
  47. package/dist-types/commands/EnableControlCommand.d.ts +37 -0
  48. package/dist-types/commands/GetControlOperationCommand.d.ts +37 -0
  49. package/dist-types/commands/ListEnabledControlsCommand.d.ts +36 -0
  50. package/dist-types/commands/index.d.ts +4 -0
  51. package/dist-types/endpoints.d.ts +2 -0
  52. package/dist-types/index.d.ts +6 -0
  53. package/dist-types/models/ControlTowerServiceException.d.ts +10 -0
  54. package/dist-types/models/index.d.ts +1 -0
  55. package/dist-types/models/models_0.d.ts +255 -0
  56. package/dist-types/pagination/Interfaces.d.ts +6 -0
  57. package/dist-types/pagination/ListEnabledControlsPaginator.d.ts +4 -0
  58. package/dist-types/pagination/index.d.ts +2 -0
  59. package/dist-types/protocols/Aws_restJson1.d.ts +14 -0
  60. package/dist-types/runtimeConfig.browser.d.ts +40 -0
  61. package/dist-types/runtimeConfig.d.ts +40 -0
  62. package/dist-types/runtimeConfig.native.d.ts +39 -0
  63. package/dist-types/runtimeConfig.shared.d.ts +13 -0
  64. package/dist-types/ts3.4/ControlTower.d.ts +25 -0
  65. package/dist-types/ts3.4/ControlTowerClient.d.ts +77 -0
  66. package/dist-types/ts3.4/commands/DisableControlCommand.d.ts +17 -0
  67. package/dist-types/ts3.4/commands/EnableControlCommand.d.ts +17 -0
  68. package/dist-types/ts3.4/commands/GetControlOperationCommand.d.ts +17 -0
  69. package/dist-types/ts3.4/commands/ListEnabledControlsCommand.d.ts +17 -0
  70. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  71. package/dist-types/ts3.4/endpoints.d.ts +2 -0
  72. package/dist-types/ts3.4/index.d.ts +6 -0
  73. package/dist-types/ts3.4/models/ControlTowerServiceException.d.ts +6 -0
  74. package/dist-types/ts3.4/models/index.d.ts +1 -0
  75. package/dist-types/ts3.4/models/models_0.d.ts +150 -0
  76. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  77. package/dist-types/ts3.4/pagination/ListEnabledControlsPaginator.d.ts +4 -0
  78. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  79. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +14 -0
  80. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +38 -0
  81. package/dist-types/ts3.4/runtimeConfig.d.ts +38 -0
  82. package/dist-types/ts3.4/runtimeConfig.native.d.ts +37 -0
  83. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +11 -0
  84. package/package.json +99 -0
@@ -0,0 +1,13 @@
1
+ import { parseUrl } from "@aws-sdk/url-parser";
2
+ import { defaultRegionInfoProvider } from "./endpoints";
3
+ export var getRuntimeConfig = function (config) {
4
+ var _a, _b, _c, _d, _e;
5
+ return ({
6
+ apiVersion: "2018-05-10",
7
+ disableHostPrefix: (_a = config === null || config === void 0 ? void 0 : config.disableHostPrefix) !== null && _a !== void 0 ? _a : false,
8
+ logger: (_b = config === null || config === void 0 ? void 0 : config.logger) !== null && _b !== void 0 ? _b : {},
9
+ regionInfoProvider: (_c = config === null || config === void 0 ? void 0 : config.regionInfoProvider) !== null && _c !== void 0 ? _c : defaultRegionInfoProvider,
10
+ serviceId: (_d = config === null || config === void 0 ? void 0 : config.serviceId) !== null && _d !== void 0 ? _d : "ControlTower",
11
+ urlParser: (_e = config === null || config === void 0 ? void 0 : config.urlParser) !== null && _e !== void 0 ? _e : parseUrl,
12
+ });
13
+ };
@@ -0,0 +1,112 @@
1
+ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
2
+ import { DisableControlCommandInput, DisableControlCommandOutput } from "./commands/DisableControlCommand";
3
+ import { EnableControlCommandInput, EnableControlCommandOutput } from "./commands/EnableControlCommand";
4
+ import { GetControlOperationCommandInput, GetControlOperationCommandOutput } from "./commands/GetControlOperationCommand";
5
+ import { ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput } from "./commands/ListEnabledControlsCommand";
6
+ import { ControlTowerClient } from "./ControlTowerClient";
7
+ /**
8
+ * <p>These interfaces allow you to apply the AWS library of pre-defined <i>controls</i> to your
9
+ * organizational units, programmatically. In this context, controls are the same as AWS Control Tower guardrails.</p>
10
+ * <p>To call these APIs, you'll need to know:</p>
11
+ * <ul>
12
+ * <li>
13
+ * <p>the <code>ControlARN</code> for the control--that is, the
14
+ * guardrail--you are targeting,</p>
15
+ * </li>
16
+ * <li>
17
+ * <p>and the ARN associated with the target organizational unit (OU).</p>
18
+ * </li>
19
+ * </ul>
20
+ * <p>
21
+ * <b>To get the <code>ControlARN</code> for your AWS Control Tower guardrail:</b>
22
+ * </p>
23
+ * <p>The <code>ControlARN</code> contains the control name which is specified in each guardrail. For a list of control names for <i>Strongly recommended</i> and <i>Elective</i> guardrails, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html">Resource identifiers for APIs and guardrails</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/automating-tasks.html">Automating tasks section</a> of the AWS Control Tower User Guide. Remember that <i>Mandatory</i> guardrails cannot be added or removed.</p>
24
+ * <note>
25
+ * <p>
26
+ * <b>ARN format:</b>
27
+ * <code>arn:aws:controltower:{REGION}::control/{CONTROL_NAME}</code>
28
+ * </p>
29
+ * <p>
30
+ * <b>Example:</b>
31
+ * </p>
32
+ * <p>
33
+ * <code>arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED</code>
34
+ * </p>
35
+ * </note>
36
+ * <p>
37
+ * <b>To get the ARN for an OU:</b>
38
+ * </p>
39
+ * <p>In the AWS Organizations console, you can find the ARN for the OU on the <b>Organizational unit details</b> page associated with that OU.</p>
40
+ * <note>
41
+ * <p>
42
+ * <b>OU ARN format:</b>
43
+ * </p>
44
+ * <p>
45
+ * <code>arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}</code>
46
+ * </p>
47
+ * </note>
48
+ * <p class="title">
49
+ * <b>Details and examples</b>
50
+ * </p>
51
+ * <ul>
52
+ * <li>
53
+ * <p>
54
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html">List of resource identifiers for APIs and guardrails</a>
55
+ * </p>
56
+ * </li>
57
+ * <li>
58
+ * <p>
59
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/guardrail-api-examples-short.html">Guardrail API examples (CLI)</a>
60
+ * </p>
61
+ * </li>
62
+ * <li>
63
+ * <p>
64
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html">Enable controls with AWS CloudFormation</a>
65
+ * </p>
66
+ * </li>
67
+ * <li>
68
+ * <p>
69
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html">Creating AWS Control Tower resources with AWS CloudFormation</a>
70
+ * </p>
71
+ * </li>
72
+ * </ul>
73
+ * <p>To view the open source resource repository on GitHub, see <a href="https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-controltower">aws-cloudformation/aws-cloudformation-resource-providers-controltower</a>
74
+ * </p>
75
+ * <p>
76
+ * <b>Recording API Requests</b>
77
+ * </p>
78
+ * <p>AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the AWS Control Tower service received, who made the request and when, and so on. For more about AWS Control Tower and its support for CloudTrail, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging AWS Control Tower Actions with AWS CloudTrail</a> in the AWS Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.</p>
79
+ */
80
+ export declare class ControlTower extends ControlTowerClient {
81
+ /**
82
+ * <p>This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified
83
+ * organizational unit and the accounts it contains. The resources will vary according to the
84
+ * control that you specify.</p>
85
+ */
86
+ disableControl(args: DisableControlCommandInput, options?: __HttpHandlerOptions): Promise<DisableControlCommandOutput>;
87
+ disableControl(args: DisableControlCommandInput, cb: (err: any, data?: DisableControlCommandOutput) => void): void;
88
+ disableControl(args: DisableControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableControlCommandOutput) => void): void;
89
+ /**
90
+ * <p>This API call activates a control. It starts an asynchronous operation that creates AWS resources on the specified
91
+ * organizational unit and the accounts it contains. The resources created will vary according to
92
+ * the control that you specify.</p>
93
+ */
94
+ enableControl(args: EnableControlCommandInput, options?: __HttpHandlerOptions): Promise<EnableControlCommandOutput>;
95
+ enableControl(args: EnableControlCommandInput, cb: (err: any, data?: EnableControlCommandOutput) => void): void;
96
+ enableControl(args: EnableControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableControlCommandOutput) => void): void;
97
+ /**
98
+ * <p>Returns the status of a particular <code>EnableControl</code> or
99
+ * <code>DisableControl</code> operation. Displays a message in case of error.
100
+ * Details for an operation are available for 90 days.</p>
101
+ */
102
+ getControlOperation(args: GetControlOperationCommandInput, options?: __HttpHandlerOptions): Promise<GetControlOperationCommandOutput>;
103
+ getControlOperation(args: GetControlOperationCommandInput, cb: (err: any, data?: GetControlOperationCommandOutput) => void): void;
104
+ getControlOperation(args: GetControlOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetControlOperationCommandOutput) => void): void;
105
+ /**
106
+ * <p>Lists the controls enabled by AWS Control Tower on the specified organizational unit and
107
+ * the accounts it contains.</p>
108
+ */
109
+ listEnabledControls(args: ListEnabledControlsCommandInput, options?: __HttpHandlerOptions): Promise<ListEnabledControlsCommandOutput>;
110
+ listEnabledControls(args: ListEnabledControlsCommandInput, cb: (err: any, data?: ListEnabledControlsCommandOutput) => void): void;
111
+ listEnabledControls(args: ListEnabledControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnabledControlsCommandOutput) => void): void;
112
+ }
@@ -0,0 +1,218 @@
1
+ import { EndpointsInputConfig, EndpointsResolvedConfig, RegionInputConfig, RegionResolvedConfig } from "@aws-sdk/config-resolver";
2
+ import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
3
+ import { RetryInputConfig, RetryResolvedConfig } from "@aws-sdk/middleware-retry";
4
+ import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
5
+ import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
6
+ import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
7
+ import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
8
+ import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
9
+ import { DisableControlCommandInput, DisableControlCommandOutput } from "./commands/DisableControlCommand";
10
+ import { EnableControlCommandInput, EnableControlCommandOutput } from "./commands/EnableControlCommand";
11
+ import { GetControlOperationCommandInput, GetControlOperationCommandOutput } from "./commands/GetControlOperationCommand";
12
+ import { ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput } from "./commands/ListEnabledControlsCommand";
13
+ export declare type ServiceInputTypes = DisableControlCommandInput | EnableControlCommandInput | GetControlOperationCommandInput | ListEnabledControlsCommandInput;
14
+ export declare type ServiceOutputTypes = DisableControlCommandOutput | EnableControlCommandOutput | GetControlOperationCommandOutput | ListEnabledControlsCommandOutput;
15
+ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
16
+ /**
17
+ * The HTTP handler to use. Fetch in browser and Https in Nodejs.
18
+ */
19
+ requestHandler?: __HttpHandler;
20
+ /**
21
+ * A constructor for a class implementing the {@link __Hash} interface
22
+ * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
23
+ * @internal
24
+ */
25
+ sha256?: __HashConstructor;
26
+ /**
27
+ * The function that will be used to convert strings into HTTP endpoints.
28
+ * @internal
29
+ */
30
+ urlParser?: __UrlParser;
31
+ /**
32
+ * A function that can calculate the length of a request body.
33
+ * @internal
34
+ */
35
+ bodyLengthChecker?: __BodyLengthCalculator;
36
+ /**
37
+ * A function that converts a stream into an array of bytes.
38
+ * @internal
39
+ */
40
+ streamCollector?: __StreamCollector;
41
+ /**
42
+ * The function that will be used to convert a base64-encoded string to a byte array.
43
+ * @internal
44
+ */
45
+ base64Decoder?: __Decoder;
46
+ /**
47
+ * The function that will be used to convert binary data to a base64-encoded string.
48
+ * @internal
49
+ */
50
+ base64Encoder?: __Encoder;
51
+ /**
52
+ * The function that will be used to convert a UTF8-encoded string to a byte array.
53
+ * @internal
54
+ */
55
+ utf8Decoder?: __Decoder;
56
+ /**
57
+ * The function that will be used to convert binary data to a UTF-8 encoded string.
58
+ * @internal
59
+ */
60
+ utf8Encoder?: __Encoder;
61
+ /**
62
+ * The runtime environment.
63
+ * @internal
64
+ */
65
+ runtime?: string;
66
+ /**
67
+ * Disable dyanamically changing the endpoint of the client based on the hostPrefix
68
+ * trait of an operation.
69
+ */
70
+ disableHostPrefix?: boolean;
71
+ /**
72
+ * Value for how many times a request will be made at most in case of retry.
73
+ */
74
+ maxAttempts?: number | __Provider<number>;
75
+ /**
76
+ * Specifies which retry algorithm to use.
77
+ */
78
+ retryMode?: string | __Provider<string>;
79
+ /**
80
+ * Optional logger for logging debug/info/warn/error.
81
+ */
82
+ logger?: __Logger;
83
+ /**
84
+ * Enables IPv6/IPv4 dualstack endpoint.
85
+ */
86
+ useDualstackEndpoint?: boolean | __Provider<boolean>;
87
+ /**
88
+ * Enables FIPS compatible endpoints.
89
+ */
90
+ useFipsEndpoint?: boolean | __Provider<boolean>;
91
+ /**
92
+ * Unique service identifier.
93
+ * @internal
94
+ */
95
+ serviceId?: string;
96
+ /**
97
+ * The AWS region to which this client will send requests
98
+ */
99
+ region?: string | __Provider<string>;
100
+ /**
101
+ * Default credentials provider; Not available in browser runtime.
102
+ * @internal
103
+ */
104
+ credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
105
+ /**
106
+ * Fetch related hostname, signing name or signing region with given region.
107
+ * @internal
108
+ */
109
+ regionInfoProvider?: RegionInfoProvider;
110
+ /**
111
+ * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
112
+ * @internal
113
+ */
114
+ defaultUserAgentProvider?: Provider<__UserAgent>;
115
+ /**
116
+ * The {@link DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
117
+ */
118
+ defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
119
+ }
120
+ declare type ControlTowerClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
121
+ /**
122
+ * The configuration interface of ControlTowerClient class constructor that set the region, credentials and other options.
123
+ */
124
+ export interface ControlTowerClientConfig extends ControlTowerClientConfigType {
125
+ }
126
+ declare type ControlTowerClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig;
127
+ /**
128
+ * The resolved configuration interface of ControlTowerClient class. This is resolved and normalized from the {@link ControlTowerClientConfig | constructor configuration interface}.
129
+ */
130
+ export interface ControlTowerClientResolvedConfig extends ControlTowerClientResolvedConfigType {
131
+ }
132
+ /**
133
+ * <p>These interfaces allow you to apply the AWS library of pre-defined <i>controls</i> to your
134
+ * organizational units, programmatically. In this context, controls are the same as AWS Control Tower guardrails.</p>
135
+ * <p>To call these APIs, you'll need to know:</p>
136
+ * <ul>
137
+ * <li>
138
+ * <p>the <code>ControlARN</code> for the control--that is, the
139
+ * guardrail--you are targeting,</p>
140
+ * </li>
141
+ * <li>
142
+ * <p>and the ARN associated with the target organizational unit (OU).</p>
143
+ * </li>
144
+ * </ul>
145
+ * <p>
146
+ * <b>To get the <code>ControlARN</code> for your AWS Control Tower guardrail:</b>
147
+ * </p>
148
+ * <p>The <code>ControlARN</code> contains the control name which is specified in each guardrail. For a list of control names for <i>Strongly recommended</i> and <i>Elective</i> guardrails, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html">Resource identifiers for APIs and guardrails</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/automating-tasks.html">Automating tasks section</a> of the AWS Control Tower User Guide. Remember that <i>Mandatory</i> guardrails cannot be added or removed.</p>
149
+ * <note>
150
+ * <p>
151
+ * <b>ARN format:</b>
152
+ * <code>arn:aws:controltower:{REGION}::control/{CONTROL_NAME}</code>
153
+ * </p>
154
+ * <p>
155
+ * <b>Example:</b>
156
+ * </p>
157
+ * <p>
158
+ * <code>arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED</code>
159
+ * </p>
160
+ * </note>
161
+ * <p>
162
+ * <b>To get the ARN for an OU:</b>
163
+ * </p>
164
+ * <p>In the AWS Organizations console, you can find the ARN for the OU on the <b>Organizational unit details</b> page associated with that OU.</p>
165
+ * <note>
166
+ * <p>
167
+ * <b>OU ARN format:</b>
168
+ * </p>
169
+ * <p>
170
+ * <code>arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}</code>
171
+ * </p>
172
+ * </note>
173
+ * <p class="title">
174
+ * <b>Details and examples</b>
175
+ * </p>
176
+ * <ul>
177
+ * <li>
178
+ * <p>
179
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html">List of resource identifiers for APIs and guardrails</a>
180
+ * </p>
181
+ * </li>
182
+ * <li>
183
+ * <p>
184
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/guardrail-api-examples-short.html">Guardrail API examples (CLI)</a>
185
+ * </p>
186
+ * </li>
187
+ * <li>
188
+ * <p>
189
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html">Enable controls with AWS CloudFormation</a>
190
+ * </p>
191
+ * </li>
192
+ * <li>
193
+ * <p>
194
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html">Creating AWS Control Tower resources with AWS CloudFormation</a>
195
+ * </p>
196
+ * </li>
197
+ * </ul>
198
+ * <p>To view the open source resource repository on GitHub, see <a href="https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-controltower">aws-cloudformation/aws-cloudformation-resource-providers-controltower</a>
199
+ * </p>
200
+ * <p>
201
+ * <b>Recording API Requests</b>
202
+ * </p>
203
+ * <p>AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the AWS Control Tower service received, who made the request and when, and so on. For more about AWS Control Tower and its support for CloudTrail, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging AWS Control Tower Actions with AWS CloudTrail</a> in the AWS Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.</p>
204
+ */
205
+ export declare class ControlTowerClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ControlTowerClientResolvedConfig> {
206
+ /**
207
+ * The resolved configuration of ControlTowerClient class. This is resolved and normalized from the {@link ControlTowerClientConfig | constructor configuration interface}.
208
+ */
209
+ readonly config: ControlTowerClientResolvedConfig;
210
+ constructor(configuration: ControlTowerClientConfig);
211
+ /**
212
+ * Destroy underlying resources, like sockets. It's usually not necessary to do this.
213
+ * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
214
+ * Otherwise, sockets might stay open for quite a long time before the server terminates them.
215
+ */
216
+ destroy(): void;
217
+ }
218
+ export {};
@@ -0,0 +1,37 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
4
+ import { DisableControlInput, DisableControlOutput } from "../models/models_0";
5
+ export interface DisableControlCommandInput extends DisableControlInput {
6
+ }
7
+ export interface DisableControlCommandOutput extends DisableControlOutput, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified
11
+ * organizational unit and the accounts it contains. The resources will vary according to the
12
+ * control that you specify.</p>
13
+ * @example
14
+ * Use a bare-bones client and the command you need to make an API call.
15
+ * ```javascript
16
+ * import { ControlTowerClient, DisableControlCommand } from "@aws-sdk/client-controltower"; // ES Modules import
17
+ * // const { ControlTowerClient, DisableControlCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
18
+ * const client = new ControlTowerClient(config);
19
+ * const command = new DisableControlCommand(input);
20
+ * const response = await client.send(command);
21
+ * ```
22
+ *
23
+ * @see {@link DisableControlCommandInput} for command's `input` shape.
24
+ * @see {@link DisableControlCommandOutput} for command's `response` shape.
25
+ * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
26
+ *
27
+ */
28
+ export declare class DisableControlCommand extends $Command<DisableControlCommandInput, DisableControlCommandOutput, ControlTowerClientResolvedConfig> {
29
+ readonly input: DisableControlCommandInput;
30
+ constructor(input: DisableControlCommandInput);
31
+ /**
32
+ * @internal
33
+ */
34
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableControlCommandInput, DisableControlCommandOutput>;
35
+ private serialize;
36
+ private deserialize;
37
+ }
@@ -0,0 +1,37 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
4
+ import { EnableControlInput, EnableControlOutput } from "../models/models_0";
5
+ export interface EnableControlCommandInput extends EnableControlInput {
6
+ }
7
+ export interface EnableControlCommandOutput extends EnableControlOutput, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>This API call activates a control. It starts an asynchronous operation that creates AWS resources on the specified
11
+ * organizational unit and the accounts it contains. The resources created will vary according to
12
+ * the control that you specify.</p>
13
+ * @example
14
+ * Use a bare-bones client and the command you need to make an API call.
15
+ * ```javascript
16
+ * import { ControlTowerClient, EnableControlCommand } from "@aws-sdk/client-controltower"; // ES Modules import
17
+ * // const { ControlTowerClient, EnableControlCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
18
+ * const client = new ControlTowerClient(config);
19
+ * const command = new EnableControlCommand(input);
20
+ * const response = await client.send(command);
21
+ * ```
22
+ *
23
+ * @see {@link EnableControlCommandInput} for command's `input` shape.
24
+ * @see {@link EnableControlCommandOutput} for command's `response` shape.
25
+ * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
26
+ *
27
+ */
28
+ export declare class EnableControlCommand extends $Command<EnableControlCommandInput, EnableControlCommandOutput, ControlTowerClientResolvedConfig> {
29
+ readonly input: EnableControlCommandInput;
30
+ constructor(input: EnableControlCommandInput);
31
+ /**
32
+ * @internal
33
+ */
34
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableControlCommandInput, EnableControlCommandOutput>;
35
+ private serialize;
36
+ private deserialize;
37
+ }
@@ -0,0 +1,37 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
4
+ import { GetControlOperationInput, GetControlOperationOutput } from "../models/models_0";
5
+ export interface GetControlOperationCommandInput extends GetControlOperationInput {
6
+ }
7
+ export interface GetControlOperationCommandOutput extends GetControlOperationOutput, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Returns the status of a particular <code>EnableControl</code> or
11
+ * <code>DisableControl</code> operation. Displays a message in case of error.
12
+ * Details for an operation are available for 90 days.</p>
13
+ * @example
14
+ * Use a bare-bones client and the command you need to make an API call.
15
+ * ```javascript
16
+ * import { ControlTowerClient, GetControlOperationCommand } from "@aws-sdk/client-controltower"; // ES Modules import
17
+ * // const { ControlTowerClient, GetControlOperationCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
18
+ * const client = new ControlTowerClient(config);
19
+ * const command = new GetControlOperationCommand(input);
20
+ * const response = await client.send(command);
21
+ * ```
22
+ *
23
+ * @see {@link GetControlOperationCommandInput} for command's `input` shape.
24
+ * @see {@link GetControlOperationCommandOutput} for command's `response` shape.
25
+ * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
26
+ *
27
+ */
28
+ export declare class GetControlOperationCommand extends $Command<GetControlOperationCommandInput, GetControlOperationCommandOutput, ControlTowerClientResolvedConfig> {
29
+ readonly input: GetControlOperationCommandInput;
30
+ constructor(input: GetControlOperationCommandInput);
31
+ /**
32
+ * @internal
33
+ */
34
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetControlOperationCommandInput, GetControlOperationCommandOutput>;
35
+ private serialize;
36
+ private deserialize;
37
+ }
@@ -0,0 +1,36 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
4
+ import { ListEnabledControlsInput, ListEnabledControlsOutput } from "../models/models_0";
5
+ export interface ListEnabledControlsCommandInput extends ListEnabledControlsInput {
6
+ }
7
+ export interface ListEnabledControlsCommandOutput extends ListEnabledControlsOutput, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Lists the controls enabled by AWS Control Tower on the specified organizational unit and
11
+ * the accounts it contains.</p>
12
+ * @example
13
+ * Use a bare-bones client and the command you need to make an API call.
14
+ * ```javascript
15
+ * import { ControlTowerClient, ListEnabledControlsCommand } from "@aws-sdk/client-controltower"; // ES Modules import
16
+ * // const { ControlTowerClient, ListEnabledControlsCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
17
+ * const client = new ControlTowerClient(config);
18
+ * const command = new ListEnabledControlsCommand(input);
19
+ * const response = await client.send(command);
20
+ * ```
21
+ *
22
+ * @see {@link ListEnabledControlsCommandInput} for command's `input` shape.
23
+ * @see {@link ListEnabledControlsCommandOutput} for command's `response` shape.
24
+ * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
25
+ *
26
+ */
27
+ export declare class ListEnabledControlsCommand extends $Command<ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput, ControlTowerClientResolvedConfig> {
28
+ readonly input: ListEnabledControlsCommandInput;
29
+ constructor(input: ListEnabledControlsCommandInput);
30
+ /**
31
+ * @internal
32
+ */
33
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput>;
34
+ private serialize;
35
+ private deserialize;
36
+ }
@@ -0,0 +1,4 @@
1
+ export * from "./DisableControlCommand";
2
+ export * from "./EnableControlCommand";
3
+ export * from "./GetControlOperationCommand";
4
+ export * from "./ListEnabledControlsCommand";
@@ -0,0 +1,2 @@
1
+ import { RegionInfoProvider } from "@aws-sdk/types";
2
+ export declare const defaultRegionInfoProvider: RegionInfoProvider;
@@ -0,0 +1,6 @@
1
+ export * from "./ControlTower";
2
+ export * from "./ControlTowerClient";
3
+ export * from "./commands";
4
+ export * from "./models";
5
+ export * from "./pagination";
6
+ export { ControlTowerServiceException } from "./models/ControlTowerServiceException";
@@ -0,0 +1,10 @@
1
+ import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
+ /**
3
+ * Base exception class for all service exceptions from ControlTower service.
4
+ */
5
+ export declare class ControlTowerServiceException extends __ServiceException {
6
+ /**
7
+ * @internal
8
+ */
9
+ constructor(options: __ServiceExceptionOptions);
10
+ }
@@ -0,0 +1 @@
1
+ export * from "./models_0";