aws-sdk-controltower 1.51.0 → 1.52.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-controltower/client.rb +160 -122
- data/lib/aws-sdk-controltower/client_api.rb +90 -59
- data/lib/aws-sdk-controltower/errors.rb +5 -5
- data/lib/aws-sdk-controltower/types.rb +408 -281
- data/lib/aws-sdk-controltower/waiters.rb +15 -0
- data/lib/aws-sdk-controltower.rb +2 -1
- data/sig/client.rbs +47 -40
- data/sig/errors.rbs +1 -1
- data/sig/types.rbs +83 -56
- metadata +2 -1
|
@@ -26,10 +26,6 @@ module Aws::ControlTower
|
|
|
26
26
|
# An object of shape `BaselineOperation`, returning details about the
|
|
27
27
|
# specified `Baseline` operation ID.
|
|
28
28
|
#
|
|
29
|
-
# @!attribute [rw] end_time
|
|
30
|
-
# The end time of the operation (if applicable), in ISO 8601 format.
|
|
31
|
-
# @return [Time]
|
|
32
|
-
#
|
|
33
29
|
# @!attribute [rw] operation_identifier
|
|
34
30
|
# The identifier of the specified operation.
|
|
35
31
|
# @return [String]
|
|
@@ -40,15 +36,19 @@ module Aws::ControlTower
|
|
|
40
36
|
# `RESET_ENABLED_BASELINE`.
|
|
41
37
|
# @return [String]
|
|
42
38
|
#
|
|
43
|
-
# @!attribute [rw] start_time
|
|
44
|
-
# The start time of the operation, in ISO 8601 format.
|
|
45
|
-
# @return [Time]
|
|
46
|
-
#
|
|
47
39
|
# @!attribute [rw] status
|
|
48
40
|
# An enumerated type (`enum`) with possible values of `SUCCEEDED`,
|
|
49
41
|
# `FAILED`, or `IN_PROGRESS`.
|
|
50
42
|
# @return [String]
|
|
51
43
|
#
|
|
44
|
+
# @!attribute [rw] start_time
|
|
45
|
+
# The start time of the operation, in ISO 8601 format.
|
|
46
|
+
# @return [Time]
|
|
47
|
+
#
|
|
48
|
+
# @!attribute [rw] end_time
|
|
49
|
+
# The end time of the operation (if applicable), in ISO 8601 format.
|
|
50
|
+
# @return [Time]
|
|
51
|
+
#
|
|
52
52
|
# @!attribute [rw] status_message
|
|
53
53
|
# A status message that gives more information about the operation's
|
|
54
54
|
# status, if applicable.
|
|
@@ -57,11 +57,11 @@ module Aws::ControlTower
|
|
|
57
57
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/BaselineOperation AWS API Documentation
|
|
58
58
|
#
|
|
59
59
|
class BaselineOperation < Struct.new(
|
|
60
|
-
:end_time,
|
|
61
60
|
:operation_identifier,
|
|
62
61
|
:operation_type,
|
|
63
|
-
:start_time,
|
|
64
62
|
:status,
|
|
63
|
+
:start_time,
|
|
64
|
+
:end_time,
|
|
65
65
|
:status_message)
|
|
66
66
|
SENSITIVE = []
|
|
67
67
|
include Aws::Structure
|
|
@@ -73,20 +73,20 @@ module Aws::ControlTower
|
|
|
73
73
|
# The full ARN of a Baseline.
|
|
74
74
|
# @return [String]
|
|
75
75
|
#
|
|
76
|
-
# @!attribute [rw] description
|
|
77
|
-
# A summary description of a Baseline.
|
|
78
|
-
# @return [String]
|
|
79
|
-
#
|
|
80
76
|
# @!attribute [rw] name
|
|
81
77
|
# The human-readable name of a Baseline.
|
|
82
78
|
# @return [String]
|
|
83
79
|
#
|
|
80
|
+
# @!attribute [rw] description
|
|
81
|
+
# A summary description of a Baseline.
|
|
82
|
+
# @return [String]
|
|
83
|
+
#
|
|
84
84
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/BaselineSummary AWS API Documentation
|
|
85
85
|
#
|
|
86
86
|
class BaselineSummary < Struct.new(
|
|
87
87
|
:arn,
|
|
88
|
-
:
|
|
89
|
-
:
|
|
88
|
+
:name,
|
|
89
|
+
:description)
|
|
90
90
|
SENSITIVE = []
|
|
91
91
|
include Aws::Structure
|
|
92
92
|
end
|
|
@@ -106,22 +106,6 @@ module Aws::ControlTower
|
|
|
106
106
|
|
|
107
107
|
# An operation performed by the control.
|
|
108
108
|
#
|
|
109
|
-
# @!attribute [rw] control_identifier
|
|
110
|
-
# The `controlIdentifier` of the control for the operation.
|
|
111
|
-
# @return [String]
|
|
112
|
-
#
|
|
113
|
-
# @!attribute [rw] enabled_control_identifier
|
|
114
|
-
# The `controlIdentifier` of the enabled control.
|
|
115
|
-
# @return [String]
|
|
116
|
-
#
|
|
117
|
-
# @!attribute [rw] end_time
|
|
118
|
-
# The time that the operation finished.
|
|
119
|
-
# @return [Time]
|
|
120
|
-
#
|
|
121
|
-
# @!attribute [rw] operation_identifier
|
|
122
|
-
# The identifier of the specified operation.
|
|
123
|
-
# @return [String]
|
|
124
|
-
#
|
|
125
109
|
# @!attribute [rw] operation_type
|
|
126
110
|
# One of `ENABLE_CONTROL` or `DISABLE_CONTROL`.
|
|
127
111
|
# @return [String]
|
|
@@ -130,6 +114,10 @@ module Aws::ControlTower
|
|
|
130
114
|
# The time that the operation began.
|
|
131
115
|
# @return [Time]
|
|
132
116
|
#
|
|
117
|
+
# @!attribute [rw] end_time
|
|
118
|
+
# The time that the operation finished.
|
|
119
|
+
# @return [Time]
|
|
120
|
+
#
|
|
133
121
|
# @!attribute [rw] status
|
|
134
122
|
# One of `IN_PROGRESS`, `SUCEEDED`, or `FAILED`.
|
|
135
123
|
# @return [String]
|
|
@@ -139,22 +127,34 @@ module Aws::ControlTower
|
|
|
139
127
|
# explaining why the operation failed.
|
|
140
128
|
# @return [String]
|
|
141
129
|
#
|
|
130
|
+
# @!attribute [rw] operation_identifier
|
|
131
|
+
# The identifier of the specified operation.
|
|
132
|
+
# @return [String]
|
|
133
|
+
#
|
|
134
|
+
# @!attribute [rw] control_identifier
|
|
135
|
+
# The `controlIdentifier` of the control for the operation.
|
|
136
|
+
# @return [String]
|
|
137
|
+
#
|
|
142
138
|
# @!attribute [rw] target_identifier
|
|
143
139
|
# The target upon which the control operation is working.
|
|
144
140
|
# @return [String]
|
|
145
141
|
#
|
|
142
|
+
# @!attribute [rw] enabled_control_identifier
|
|
143
|
+
# The `controlIdentifier` of the enabled control.
|
|
144
|
+
# @return [String]
|
|
145
|
+
#
|
|
146
146
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ControlOperation AWS API Documentation
|
|
147
147
|
#
|
|
148
148
|
class ControlOperation < Struct.new(
|
|
149
|
-
:control_identifier,
|
|
150
|
-
:enabled_control_identifier,
|
|
151
|
-
:end_time,
|
|
152
|
-
:operation_identifier,
|
|
153
149
|
:operation_type,
|
|
154
150
|
:start_time,
|
|
151
|
+
:end_time,
|
|
155
152
|
:status,
|
|
156
153
|
:status_message,
|
|
157
|
-
:
|
|
154
|
+
:operation_identifier,
|
|
155
|
+
:control_identifier,
|
|
156
|
+
:target_identifier,
|
|
157
|
+
:enabled_control_identifier)
|
|
158
158
|
SENSITIVE = []
|
|
159
159
|
include Aws::Structure
|
|
160
160
|
end
|
|
@@ -166,8 +166,8 @@ module Aws::ControlTower
|
|
|
166
166
|
# The set of `controlIdentifier` returned by the filter.
|
|
167
167
|
# @return [Array<String>]
|
|
168
168
|
#
|
|
169
|
-
# @!attribute [rw]
|
|
170
|
-
# The set of `
|
|
169
|
+
# @!attribute [rw] target_identifiers
|
|
170
|
+
# The set of `targetIdentifier` objects returned by the filter.
|
|
171
171
|
# @return [Array<String>]
|
|
172
172
|
#
|
|
173
173
|
# @!attribute [rw] enabled_control_identifiers
|
|
@@ -179,40 +179,24 @@ module Aws::ControlTower
|
|
|
179
179
|
# Lists the status of control operations.
|
|
180
180
|
# @return [Array<String>]
|
|
181
181
|
#
|
|
182
|
-
# @!attribute [rw]
|
|
183
|
-
# The set of `
|
|
182
|
+
# @!attribute [rw] control_operation_types
|
|
183
|
+
# The set of `ControlOperation` objects returned by the filter.
|
|
184
184
|
# @return [Array<String>]
|
|
185
185
|
#
|
|
186
186
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ControlOperationFilter AWS API Documentation
|
|
187
187
|
#
|
|
188
188
|
class ControlOperationFilter < Struct.new(
|
|
189
189
|
:control_identifiers,
|
|
190
|
-
:
|
|
190
|
+
:target_identifiers,
|
|
191
191
|
:enabled_control_identifiers,
|
|
192
192
|
:statuses,
|
|
193
|
-
:
|
|
193
|
+
:control_operation_types)
|
|
194
194
|
SENSITIVE = []
|
|
195
195
|
include Aws::Structure
|
|
196
196
|
end
|
|
197
197
|
|
|
198
198
|
# A summary of information about the specified control operation.
|
|
199
199
|
#
|
|
200
|
-
# @!attribute [rw] control_identifier
|
|
201
|
-
# The `controlIdentifier` of a control.
|
|
202
|
-
# @return [String]
|
|
203
|
-
#
|
|
204
|
-
# @!attribute [rw] enabled_control_identifier
|
|
205
|
-
# The `controlIdentifier` of an enabled control.
|
|
206
|
-
# @return [String]
|
|
207
|
-
#
|
|
208
|
-
# @!attribute [rw] end_time
|
|
209
|
-
# The time at which the control operation was completed.
|
|
210
|
-
# @return [Time]
|
|
211
|
-
#
|
|
212
|
-
# @!attribute [rw] operation_identifier
|
|
213
|
-
# The unique identifier of a control operation.
|
|
214
|
-
# @return [String]
|
|
215
|
-
#
|
|
216
200
|
# @!attribute [rw] operation_type
|
|
217
201
|
# The type of operation.
|
|
218
202
|
# @return [String]
|
|
@@ -221,6 +205,10 @@ module Aws::ControlTower
|
|
|
221
205
|
# The time at which a control operation began.
|
|
222
206
|
# @return [Time]
|
|
223
207
|
#
|
|
208
|
+
# @!attribute [rw] end_time
|
|
209
|
+
# The time at which the control operation was completed.
|
|
210
|
+
# @return [Time]
|
|
211
|
+
#
|
|
224
212
|
# @!attribute [rw] status
|
|
225
213
|
# The status of the specified control operation.
|
|
226
214
|
# @return [String]
|
|
@@ -229,26 +217,42 @@ module Aws::ControlTower
|
|
|
229
217
|
# A speficic message displayed as part of the control status.
|
|
230
218
|
# @return [String]
|
|
231
219
|
#
|
|
220
|
+
# @!attribute [rw] operation_identifier
|
|
221
|
+
# The unique identifier of a control operation.
|
|
222
|
+
# @return [String]
|
|
223
|
+
#
|
|
224
|
+
# @!attribute [rw] control_identifier
|
|
225
|
+
# The `controlIdentifier` of a control.
|
|
226
|
+
# @return [String]
|
|
227
|
+
#
|
|
232
228
|
# @!attribute [rw] target_identifier
|
|
233
229
|
# The unique identifier of the target of a control operation.
|
|
234
230
|
# @return [String]
|
|
235
231
|
#
|
|
232
|
+
# @!attribute [rw] enabled_control_identifier
|
|
233
|
+
# The `controlIdentifier` of an enabled control.
|
|
234
|
+
# @return [String]
|
|
235
|
+
#
|
|
236
236
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ControlOperationSummary AWS API Documentation
|
|
237
237
|
#
|
|
238
238
|
class ControlOperationSummary < Struct.new(
|
|
239
|
-
:control_identifier,
|
|
240
|
-
:enabled_control_identifier,
|
|
241
|
-
:end_time,
|
|
242
|
-
:operation_identifier,
|
|
243
239
|
:operation_type,
|
|
244
240
|
:start_time,
|
|
241
|
+
:end_time,
|
|
245
242
|
:status,
|
|
246
243
|
:status_message,
|
|
247
|
-
:
|
|
244
|
+
:operation_identifier,
|
|
245
|
+
:control_identifier,
|
|
246
|
+
:target_identifier,
|
|
247
|
+
:enabled_control_identifier)
|
|
248
248
|
SENSITIVE = []
|
|
249
249
|
include Aws::Structure
|
|
250
250
|
end
|
|
251
251
|
|
|
252
|
+
# @!attribute [rw] version
|
|
253
|
+
# The landing zone version, for example, 3.0.
|
|
254
|
+
# @return [String]
|
|
255
|
+
#
|
|
252
256
|
# @!attribute [rw] manifest
|
|
253
257
|
# The manifest JSON file is a text file that describes your Amazon Web
|
|
254
258
|
# Services resources. For examples, review [Launch your landing
|
|
@@ -259,20 +263,23 @@ module Aws::ControlTower
|
|
|
259
263
|
# [1]: https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch
|
|
260
264
|
# @return [Hash,Array,String,Numeric,Boolean]
|
|
261
265
|
#
|
|
266
|
+
# @!attribute [rw] remediation_types
|
|
267
|
+
# Specifies the types of remediation actions to apply when creating
|
|
268
|
+
# the landing zone, such as automatic drift correction or compliance
|
|
269
|
+
# enforcement.
|
|
270
|
+
# @return [Array<String>]
|
|
271
|
+
#
|
|
262
272
|
# @!attribute [rw] tags
|
|
263
273
|
# Tags to be applied to the landing zone.
|
|
264
274
|
# @return [Hash<String,String>]
|
|
265
275
|
#
|
|
266
|
-
# @!attribute [rw] version
|
|
267
|
-
# The landing zone version, for example, 3.0.
|
|
268
|
-
# @return [String]
|
|
269
|
-
#
|
|
270
276
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/CreateLandingZoneInput AWS API Documentation
|
|
271
277
|
#
|
|
272
278
|
class CreateLandingZoneInput < Struct.new(
|
|
279
|
+
:version,
|
|
273
280
|
:manifest,
|
|
274
|
-
:
|
|
275
|
-
:
|
|
281
|
+
:remediation_types,
|
|
282
|
+
:tags)
|
|
276
283
|
SENSITIVE = []
|
|
277
284
|
include Aws::Structure
|
|
278
285
|
end
|
|
@@ -369,11 +376,17 @@ module Aws::ControlTower
|
|
|
369
376
|
# [1]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html
|
|
370
377
|
# @return [String]
|
|
371
378
|
#
|
|
379
|
+
# @!attribute [rw] enabled_control_identifier
|
|
380
|
+
# The ARN of the enabled control to be disabled, which uniquely
|
|
381
|
+
# identifies the control instance on the target organizational unit.
|
|
382
|
+
# @return [String]
|
|
383
|
+
#
|
|
372
384
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DisableControlInput AWS API Documentation
|
|
373
385
|
#
|
|
374
386
|
class DisableControlInput < Struct.new(
|
|
375
387
|
:control_identifier,
|
|
376
|
-
:target_identifier
|
|
388
|
+
:target_identifier,
|
|
389
|
+
:enabled_control_identifier)
|
|
377
390
|
SENSITIVE = []
|
|
378
391
|
include Aws::Structure
|
|
379
392
|
end
|
|
@@ -420,18 +433,20 @@ module Aws::ControlTower
|
|
|
420
433
|
# the drift status for the enabled control.
|
|
421
434
|
# @return [String]
|
|
422
435
|
#
|
|
436
|
+
# @!attribute [rw] types
|
|
437
|
+
# An object that categorizes the different types of drift detected for
|
|
438
|
+
# the enabled control.
|
|
439
|
+
# @return [Types::EnabledControlDriftTypes]
|
|
440
|
+
#
|
|
423
441
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DriftStatusSummary AWS API Documentation
|
|
424
442
|
#
|
|
425
443
|
class DriftStatusSummary < Struct.new(
|
|
426
|
-
:drift_status
|
|
444
|
+
:drift_status,
|
|
445
|
+
:types)
|
|
427
446
|
SENSITIVE = []
|
|
428
447
|
include Aws::Structure
|
|
429
448
|
end
|
|
430
449
|
|
|
431
|
-
# @!attribute [rw] baseline_identifier
|
|
432
|
-
# The ARN of the baseline to be enabled.
|
|
433
|
-
# @return [String]
|
|
434
|
-
#
|
|
435
450
|
# @!attribute [rw] baseline_version
|
|
436
451
|
# The specific version to be enabled of the specified baseline.
|
|
437
452
|
# @return [String]
|
|
@@ -441,42 +456,46 @@ module Aws::ControlTower
|
|
|
441
456
|
# where `key` is a string and `value` is a document of any type.
|
|
442
457
|
# @return [Array<Types::EnabledBaselineParameter>]
|
|
443
458
|
#
|
|
444
|
-
# @!attribute [rw]
|
|
445
|
-
#
|
|
446
|
-
# @return [
|
|
459
|
+
# @!attribute [rw] baseline_identifier
|
|
460
|
+
# The ARN of the baseline to be enabled.
|
|
461
|
+
# @return [String]
|
|
447
462
|
#
|
|
448
463
|
# @!attribute [rw] target_identifier
|
|
449
464
|
# The ARN of the target on which the baseline will be enabled. Only
|
|
450
465
|
# OUs are supported as targets.
|
|
451
466
|
# @return [String]
|
|
452
467
|
#
|
|
468
|
+
# @!attribute [rw] tags
|
|
469
|
+
# Tags associated with input to `EnableBaseline`.
|
|
470
|
+
# @return [Hash<String,String>]
|
|
471
|
+
#
|
|
453
472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnableBaselineInput AWS API Documentation
|
|
454
473
|
#
|
|
455
474
|
class EnableBaselineInput < Struct.new(
|
|
456
|
-
:baseline_identifier,
|
|
457
475
|
:baseline_version,
|
|
458
476
|
:parameters,
|
|
459
|
-
:
|
|
460
|
-
:target_identifier
|
|
477
|
+
:baseline_identifier,
|
|
478
|
+
:target_identifier,
|
|
479
|
+
:tags)
|
|
461
480
|
SENSITIVE = []
|
|
462
481
|
include Aws::Structure
|
|
463
482
|
end
|
|
464
483
|
|
|
465
|
-
# @!attribute [rw] arn
|
|
466
|
-
# The ARN of the `EnabledBaseline` resource.
|
|
467
|
-
# @return [String]
|
|
468
|
-
#
|
|
469
484
|
# @!attribute [rw] operation_identifier
|
|
470
485
|
# The ID (in UUID format) of the asynchronous `EnableBaseline`
|
|
471
486
|
# operation. This `operationIdentifier` is used to track status
|
|
472
487
|
# through calls to the `GetBaselineOperation` API.
|
|
473
488
|
# @return [String]
|
|
474
489
|
#
|
|
490
|
+
# @!attribute [rw] arn
|
|
491
|
+
# The ARN of the `EnabledBaseline` resource.
|
|
492
|
+
# @return [String]
|
|
493
|
+
#
|
|
475
494
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnableBaselineOutput AWS API Documentation
|
|
476
495
|
#
|
|
477
496
|
class EnableBaselineOutput < Struct.new(
|
|
478
|
-
:
|
|
479
|
-
:
|
|
497
|
+
:operation_identifier,
|
|
498
|
+
:arn)
|
|
480
499
|
SENSITIVE = []
|
|
481
500
|
include Aws::Structure
|
|
482
501
|
end
|
|
@@ -492,15 +511,6 @@ module Aws::ControlTower
|
|
|
492
511
|
# [1]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html
|
|
493
512
|
# @return [String]
|
|
494
513
|
#
|
|
495
|
-
# @!attribute [rw] parameters
|
|
496
|
-
# A list of input parameter values, which are specified to configure
|
|
497
|
-
# the control when you enable it.
|
|
498
|
-
# @return [Array<Types::EnabledControlParameter>]
|
|
499
|
-
#
|
|
500
|
-
# @!attribute [rw] tags
|
|
501
|
-
# Tags to be applied to the `EnabledControl` resource.
|
|
502
|
-
# @return [Hash<String,String>]
|
|
503
|
-
#
|
|
504
514
|
# @!attribute [rw] target_identifier
|
|
505
515
|
# The ARN of the organizational unit. For information on how to find
|
|
506
516
|
# the `targetIdentifier`, see [the overview page][1].
|
|
@@ -510,31 +520,40 @@ module Aws::ControlTower
|
|
|
510
520
|
# [1]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html
|
|
511
521
|
# @return [String]
|
|
512
522
|
#
|
|
523
|
+
# @!attribute [rw] tags
|
|
524
|
+
# Tags to be applied to the `EnabledControl` resource.
|
|
525
|
+
# @return [Hash<String,String>]
|
|
526
|
+
#
|
|
527
|
+
# @!attribute [rw] parameters
|
|
528
|
+
# A list of input parameter values, which are specified to configure
|
|
529
|
+
# the control when you enable it.
|
|
530
|
+
# @return [Array<Types::EnabledControlParameter>]
|
|
531
|
+
#
|
|
513
532
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnableControlInput AWS API Documentation
|
|
514
533
|
#
|
|
515
534
|
class EnableControlInput < Struct.new(
|
|
516
535
|
:control_identifier,
|
|
517
|
-
:
|
|
536
|
+
:target_identifier,
|
|
518
537
|
:tags,
|
|
519
|
-
:
|
|
538
|
+
:parameters)
|
|
520
539
|
SENSITIVE = []
|
|
521
540
|
include Aws::Structure
|
|
522
541
|
end
|
|
523
542
|
|
|
524
|
-
# @!attribute [rw] arn
|
|
525
|
-
# The ARN of the `EnabledControl` resource.
|
|
526
|
-
# @return [String]
|
|
527
|
-
#
|
|
528
543
|
# @!attribute [rw] operation_identifier
|
|
529
544
|
# The ID of the asynchronous operation, which is used to track status.
|
|
530
545
|
# The operation is available for 90 days.
|
|
531
546
|
# @return [String]
|
|
532
547
|
#
|
|
548
|
+
# @!attribute [rw] arn
|
|
549
|
+
# The ARN of the `EnabledControl` resource.
|
|
550
|
+
# @return [String]
|
|
551
|
+
#
|
|
533
552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnableControlOutput AWS API Documentation
|
|
534
553
|
#
|
|
535
554
|
class EnableControlOutput < Struct.new(
|
|
536
|
-
:
|
|
537
|
-
:
|
|
555
|
+
:operation_identifier,
|
|
556
|
+
:arn)
|
|
538
557
|
SENSITIVE = []
|
|
539
558
|
include Aws::Structure
|
|
540
559
|
end
|
|
@@ -558,9 +577,9 @@ module Aws::ControlTower
|
|
|
558
577
|
# The drift status of the enabled baseline.
|
|
559
578
|
# @return [Types::EnabledBaselineDriftStatusSummary]
|
|
560
579
|
#
|
|
561
|
-
# @!attribute [rw]
|
|
562
|
-
#
|
|
563
|
-
# @return [
|
|
580
|
+
# @!attribute [rw] target_identifier
|
|
581
|
+
# The target on which to enable the `Baseline`.
|
|
582
|
+
# @return [String]
|
|
564
583
|
#
|
|
565
584
|
# @!attribute [rw] parent_identifier
|
|
566
585
|
# An ARN that represents the parent `EnabledBaseline` at the
|
|
@@ -574,9 +593,9 @@ module Aws::ControlTower
|
|
|
574
593
|
# resource.
|
|
575
594
|
# @return [Types::EnablementStatusSummary]
|
|
576
595
|
#
|
|
577
|
-
# @!attribute [rw]
|
|
578
|
-
#
|
|
579
|
-
# @return [
|
|
596
|
+
# @!attribute [rw] parameters
|
|
597
|
+
# Shows the parameters that are applied when enabling this `Baseline`.
|
|
598
|
+
# @return [Array<Types::EnabledBaselineParameterSummary>]
|
|
580
599
|
#
|
|
581
600
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnabledBaselineDetails AWS API Documentation
|
|
582
601
|
#
|
|
@@ -585,10 +604,10 @@ module Aws::ControlTower
|
|
|
585
604
|
:baseline_identifier,
|
|
586
605
|
:baseline_version,
|
|
587
606
|
:drift_status_summary,
|
|
588
|
-
:
|
|
607
|
+
:target_identifier,
|
|
589
608
|
:parent_identifier,
|
|
590
609
|
:status_summary,
|
|
591
|
-
:
|
|
610
|
+
:parameters)
|
|
592
611
|
SENSITIVE = []
|
|
593
612
|
include Aws::Structure
|
|
594
613
|
end
|
|
@@ -663,15 +682,15 @@ module Aws::ControlTower
|
|
|
663
682
|
# filters are `baselineIdentifiers` and `targetIdentifiers`. The filter
|
|
664
683
|
# can be applied for either, or both.
|
|
665
684
|
#
|
|
685
|
+
# @!attribute [rw] target_identifiers
|
|
686
|
+
# Identifiers for the targets of the `Baseline` filter operation.
|
|
687
|
+
# @return [Array<String>]
|
|
688
|
+
#
|
|
666
689
|
# @!attribute [rw] baseline_identifiers
|
|
667
690
|
# Identifiers for the `Baseline` objects returned as part of the
|
|
668
691
|
# filter operation.
|
|
669
692
|
# @return [Array<String>]
|
|
670
693
|
#
|
|
671
|
-
# @!attribute [rw] inheritance_drift_statuses
|
|
672
|
-
# A list of `EnabledBaselineDriftStatus` items for enabled baselines.
|
|
673
|
-
# @return [Array<String>]
|
|
674
|
-
#
|
|
675
694
|
# @!attribute [rw] parent_identifiers
|
|
676
695
|
# An optional filter that sets up a list of `parentIdentifiers` to
|
|
677
696
|
# filter the results of the `ListEnabledBaseline` output.
|
|
@@ -681,18 +700,18 @@ module Aws::ControlTower
|
|
|
681
700
|
# A list of `EnablementStatus` items.
|
|
682
701
|
# @return [Array<String>]
|
|
683
702
|
#
|
|
684
|
-
# @!attribute [rw]
|
|
685
|
-
#
|
|
703
|
+
# @!attribute [rw] inheritance_drift_statuses
|
|
704
|
+
# A list of `EnabledBaselineDriftStatus` items for enabled baselines.
|
|
686
705
|
# @return [Array<String>]
|
|
687
706
|
#
|
|
688
707
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnabledBaselineFilter AWS API Documentation
|
|
689
708
|
#
|
|
690
709
|
class EnabledBaselineFilter < Struct.new(
|
|
710
|
+
:target_identifiers,
|
|
691
711
|
:baseline_identifiers,
|
|
692
|
-
:inheritance_drift_statuses,
|
|
693
712
|
:parent_identifiers,
|
|
694
713
|
:statuses,
|
|
695
|
-
:
|
|
714
|
+
:inheritance_drift_statuses)
|
|
696
715
|
SENSITIVE = []
|
|
697
716
|
include Aws::Structure
|
|
698
717
|
end
|
|
@@ -772,6 +791,10 @@ module Aws::ControlTower
|
|
|
772
791
|
# The drift status of the enabled baseline.
|
|
773
792
|
# @return [Types::EnabledBaselineDriftStatusSummary]
|
|
774
793
|
#
|
|
794
|
+
# @!attribute [rw] target_identifier
|
|
795
|
+
# The target upon which the baseline is enabled.
|
|
796
|
+
# @return [String]
|
|
797
|
+
#
|
|
775
798
|
# @!attribute [rw] parent_identifier
|
|
776
799
|
# An ARN that represents an object returned by `ListEnabledBaseline`,
|
|
777
800
|
# to describe an enabled baseline.
|
|
@@ -782,10 +805,6 @@ module Aws::ControlTower
|
|
|
782
805
|
# resource.
|
|
783
806
|
# @return [Types::EnablementStatusSummary]
|
|
784
807
|
#
|
|
785
|
-
# @!attribute [rw] target_identifier
|
|
786
|
-
# The target upon which the baseline is enabled.
|
|
787
|
-
# @return [String]
|
|
788
|
-
#
|
|
789
808
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnabledBaselineSummary AWS API Documentation
|
|
790
809
|
#
|
|
791
810
|
class EnabledBaselineSummary < Struct.new(
|
|
@@ -793,9 +812,9 @@ module Aws::ControlTower
|
|
|
793
812
|
:baseline_identifier,
|
|
794
813
|
:baseline_version,
|
|
795
814
|
:drift_status_summary,
|
|
815
|
+
:target_identifier,
|
|
796
816
|
:parent_identifier,
|
|
797
|
-
:status_summary
|
|
798
|
-
:target_identifier)
|
|
817
|
+
:status_summary)
|
|
799
818
|
SENSITIVE = []
|
|
800
819
|
include Aws::Structure
|
|
801
820
|
end
|
|
@@ -815,18 +834,6 @@ module Aws::ControlTower
|
|
|
815
834
|
# [1]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html
|
|
816
835
|
# @return [String]
|
|
817
836
|
#
|
|
818
|
-
# @!attribute [rw] drift_status_summary
|
|
819
|
-
# The drift status of the enabled control.
|
|
820
|
-
# @return [Types::DriftStatusSummary]
|
|
821
|
-
#
|
|
822
|
-
# @!attribute [rw] parameters
|
|
823
|
-
# Array of `EnabledControlParameter` objects.
|
|
824
|
-
# @return [Array<Types::EnabledControlParameterSummary>]
|
|
825
|
-
#
|
|
826
|
-
# @!attribute [rw] status_summary
|
|
827
|
-
# The deployment summary of the enabled control.
|
|
828
|
-
# @return [Types::EnablementStatusSummary]
|
|
829
|
-
#
|
|
830
837
|
# @!attribute [rw] target_identifier
|
|
831
838
|
# The ARN of the organizational unit. For information on how to find
|
|
832
839
|
# the `targetIdentifier`, see [the overview page][1].
|
|
@@ -836,20 +843,60 @@ module Aws::ControlTower
|
|
|
836
843
|
# [1]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html
|
|
837
844
|
# @return [String]
|
|
838
845
|
#
|
|
846
|
+
# @!attribute [rw] status_summary
|
|
847
|
+
# The deployment summary of the enabled control.
|
|
848
|
+
# @return [Types::EnablementStatusSummary]
|
|
849
|
+
#
|
|
850
|
+
# @!attribute [rw] drift_status_summary
|
|
851
|
+
# The drift status of the enabled control.
|
|
852
|
+
# @return [Types::DriftStatusSummary]
|
|
853
|
+
#
|
|
854
|
+
# @!attribute [rw] parent_identifier
|
|
855
|
+
# The ARN of the parent enabled control from which this control
|
|
856
|
+
# inherits its configuration, if applicable.
|
|
857
|
+
# @return [String]
|
|
858
|
+
#
|
|
839
859
|
# @!attribute [rw] target_regions
|
|
840
860
|
# Target Amazon Web Services Regions for the enabled control.
|
|
841
861
|
# @return [Array<Types::Region>]
|
|
842
862
|
#
|
|
863
|
+
# @!attribute [rw] parameters
|
|
864
|
+
# Array of `EnabledControlParameter` objects.
|
|
865
|
+
# @return [Array<Types::EnabledControlParameterSummary>]
|
|
866
|
+
#
|
|
843
867
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnabledControlDetails AWS API Documentation
|
|
844
868
|
#
|
|
845
869
|
class EnabledControlDetails < Struct.new(
|
|
846
870
|
:arn,
|
|
847
871
|
:control_identifier,
|
|
848
|
-
:drift_status_summary,
|
|
849
|
-
:parameters,
|
|
850
|
-
:status_summary,
|
|
851
872
|
:target_identifier,
|
|
852
|
-
:
|
|
873
|
+
:status_summary,
|
|
874
|
+
:drift_status_summary,
|
|
875
|
+
:parent_identifier,
|
|
876
|
+
:target_regions,
|
|
877
|
+
:parameters)
|
|
878
|
+
SENSITIVE = []
|
|
879
|
+
include Aws::Structure
|
|
880
|
+
end
|
|
881
|
+
|
|
882
|
+
# Defines the various categories of drift that can occur for an enabled
|
|
883
|
+
# control resource.
|
|
884
|
+
#
|
|
885
|
+
# @!attribute [rw] inheritance
|
|
886
|
+
# Indicates drift related to inheritance configuration between parent
|
|
887
|
+
# and child controls.
|
|
888
|
+
# @return [Types::EnabledControlInheritanceDrift]
|
|
889
|
+
#
|
|
890
|
+
# @!attribute [rw] resource
|
|
891
|
+
# Indicates drift related to the underlying Amazon Web Services
|
|
892
|
+
# resources managed by the control.
|
|
893
|
+
# @return [Types::EnabledControlResourceDrift]
|
|
894
|
+
#
|
|
895
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnabledControlDriftTypes AWS API Documentation
|
|
896
|
+
#
|
|
897
|
+
class EnabledControlDriftTypes < Struct.new(
|
|
898
|
+
:inheritance,
|
|
899
|
+
:resource)
|
|
853
900
|
SENSITIVE = []
|
|
854
901
|
include Aws::Structure
|
|
855
902
|
end
|
|
@@ -862,20 +909,56 @@ module Aws::ControlTower
|
|
|
862
909
|
# The set of `controlIdentifier` returned by the filter.
|
|
863
910
|
# @return [Array<String>]
|
|
864
911
|
#
|
|
912
|
+
# @!attribute [rw] statuses
|
|
913
|
+
# A list of `EnablementStatus` items.
|
|
914
|
+
# @return [Array<String>]
|
|
915
|
+
#
|
|
865
916
|
# @!attribute [rw] drift_statuses
|
|
866
917
|
# A list of `DriftStatus` items.
|
|
867
918
|
# @return [Array<String>]
|
|
868
919
|
#
|
|
869
|
-
# @!attribute [rw]
|
|
870
|
-
#
|
|
920
|
+
# @!attribute [rw] parent_identifiers
|
|
921
|
+
# Filters enabled controls by their parent control identifiers,
|
|
922
|
+
# allowing you to find child controls of specific parent controls.
|
|
923
|
+
# @return [Array<String>]
|
|
924
|
+
#
|
|
925
|
+
# @!attribute [rw] inheritance_drift_statuses
|
|
926
|
+
# Filters enabled controls by their inheritance drift status, allowing
|
|
927
|
+
# you to find controls with specific inheritance-related drift
|
|
928
|
+
# conditions.
|
|
929
|
+
# @return [Array<String>]
|
|
930
|
+
#
|
|
931
|
+
# @!attribute [rw] resource_drift_statuses
|
|
932
|
+
# Filters enabled controls by their resource drift status, allowing
|
|
933
|
+
# you to find controls with specific resource-related drift
|
|
934
|
+
# conditions.
|
|
871
935
|
# @return [Array<String>]
|
|
872
936
|
#
|
|
873
937
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnabledControlFilter AWS API Documentation
|
|
874
938
|
#
|
|
875
939
|
class EnabledControlFilter < Struct.new(
|
|
876
940
|
:control_identifiers,
|
|
941
|
+
:statuses,
|
|
877
942
|
:drift_statuses,
|
|
878
|
-
:
|
|
943
|
+
:parent_identifiers,
|
|
944
|
+
:inheritance_drift_statuses,
|
|
945
|
+
:resource_drift_statuses)
|
|
946
|
+
SENSITIVE = []
|
|
947
|
+
include Aws::Structure
|
|
948
|
+
end
|
|
949
|
+
|
|
950
|
+
# Represents drift information related to control inheritance between
|
|
951
|
+
# organizational units.
|
|
952
|
+
#
|
|
953
|
+
# @!attribute [rw] status
|
|
954
|
+
# The status of inheritance drift for the enabled control, indicating
|
|
955
|
+
# whether inheritance configuration matches expectations.
|
|
956
|
+
# @return [String]
|
|
957
|
+
#
|
|
958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnabledControlInheritanceDrift AWS API Documentation
|
|
959
|
+
#
|
|
960
|
+
class EnabledControlInheritanceDrift < Struct.new(
|
|
961
|
+
:status)
|
|
879
962
|
SENSITIVE = []
|
|
880
963
|
include Aws::Structure
|
|
881
964
|
end
|
|
@@ -920,6 +1003,22 @@ module Aws::ControlTower
|
|
|
920
1003
|
include Aws::Structure
|
|
921
1004
|
end
|
|
922
1005
|
|
|
1006
|
+
# Represents drift information related to the underlying Amazon Web
|
|
1007
|
+
# Services resources managed by the control.
|
|
1008
|
+
#
|
|
1009
|
+
# @!attribute [rw] status
|
|
1010
|
+
# The status of resource drift for the enabled control, indicating
|
|
1011
|
+
# whether the underlying resources match the expected configuration.
|
|
1012
|
+
# @return [String]
|
|
1013
|
+
#
|
|
1014
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnabledControlResourceDrift AWS API Documentation
|
|
1015
|
+
#
|
|
1016
|
+
class EnabledControlResourceDrift < Struct.new(
|
|
1017
|
+
:status)
|
|
1018
|
+
SENSITIVE = []
|
|
1019
|
+
include Aws::Structure
|
|
1020
|
+
end
|
|
1021
|
+
|
|
923
1022
|
# Returns a summary of information about an enabled control.
|
|
924
1023
|
#
|
|
925
1024
|
# @!attribute [rw] arn
|
|
@@ -930,16 +1029,21 @@ module Aws::ControlTower
|
|
|
930
1029
|
# The `controlIdentifier` of the enabled control.
|
|
931
1030
|
# @return [String]
|
|
932
1031
|
#
|
|
933
|
-
# @!attribute [rw]
|
|
934
|
-
# The
|
|
935
|
-
# @return [
|
|
1032
|
+
# @!attribute [rw] target_identifier
|
|
1033
|
+
# The ARN of the organizational unit.
|
|
1034
|
+
# @return [String]
|
|
936
1035
|
#
|
|
937
1036
|
# @!attribute [rw] status_summary
|
|
938
1037
|
# A short description of the status of the enabled control.
|
|
939
1038
|
# @return [Types::EnablementStatusSummary]
|
|
940
1039
|
#
|
|
941
|
-
# @!attribute [rw]
|
|
942
|
-
# The
|
|
1040
|
+
# @!attribute [rw] drift_status_summary
|
|
1041
|
+
# The drift status of the enabled control.
|
|
1042
|
+
# @return [Types::DriftStatusSummary]
|
|
1043
|
+
#
|
|
1044
|
+
# @!attribute [rw] parent_identifier
|
|
1045
|
+
# The ARN of the parent enabled control from which this control
|
|
1046
|
+
# inherits its configuration, if applicable.
|
|
943
1047
|
# @return [String]
|
|
944
1048
|
#
|
|
945
1049
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnabledControlSummary AWS API Documentation
|
|
@@ -947,9 +1051,10 @@ module Aws::ControlTower
|
|
|
947
1051
|
class EnabledControlSummary < Struct.new(
|
|
948
1052
|
:arn,
|
|
949
1053
|
:control_identifier,
|
|
950
|
-
:
|
|
1054
|
+
:target_identifier,
|
|
951
1055
|
:status_summary,
|
|
952
|
-
:
|
|
1056
|
+
:drift_status_summary,
|
|
1057
|
+
:parent_identifier)
|
|
953
1058
|
SENSITIVE = []
|
|
954
1059
|
include Aws::Structure
|
|
955
1060
|
end
|
|
@@ -957,10 +1062,6 @@ module Aws::ControlTower
|
|
|
957
1062
|
# The deployment summary of an `EnabledControl` or `EnabledBaseline`
|
|
958
1063
|
# resource.
|
|
959
1064
|
#
|
|
960
|
-
# @!attribute [rw] last_operation_identifier
|
|
961
|
-
# The last operation identifier for the enabled resource.
|
|
962
|
-
# @return [String]
|
|
963
|
-
#
|
|
964
1065
|
# @!attribute [rw] status
|
|
965
1066
|
# The deployment status of the enabled resource.
|
|
966
1067
|
#
|
|
@@ -976,11 +1077,15 @@ module Aws::ControlTower
|
|
|
976
1077
|
# failed to deploy.
|
|
977
1078
|
# @return [String]
|
|
978
1079
|
#
|
|
1080
|
+
# @!attribute [rw] last_operation_identifier
|
|
1081
|
+
# The last operation identifier for the enabled resource.
|
|
1082
|
+
# @return [String]
|
|
1083
|
+
#
|
|
979
1084
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnablementStatusSummary AWS API Documentation
|
|
980
1085
|
#
|
|
981
1086
|
class EnablementStatusSummary < Struct.new(
|
|
982
|
-
:
|
|
983
|
-
:
|
|
1087
|
+
:status,
|
|
1088
|
+
:last_operation_identifier)
|
|
984
1089
|
SENSITIVE = []
|
|
985
1090
|
include Aws::Structure
|
|
986
1091
|
end
|
|
@@ -1027,20 +1132,20 @@ module Aws::ControlTower
|
|
|
1027
1132
|
# The baseline ARN.
|
|
1028
1133
|
# @return [String]
|
|
1029
1134
|
#
|
|
1030
|
-
# @!attribute [rw] description
|
|
1031
|
-
# A description of the baseline.
|
|
1032
|
-
# @return [String]
|
|
1033
|
-
#
|
|
1034
1135
|
# @!attribute [rw] name
|
|
1035
1136
|
# A user-friendly name for the baseline.
|
|
1036
1137
|
# @return [String]
|
|
1037
1138
|
#
|
|
1139
|
+
# @!attribute [rw] description
|
|
1140
|
+
# A description of the baseline.
|
|
1141
|
+
# @return [String]
|
|
1142
|
+
#
|
|
1038
1143
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetBaselineOutput AWS API Documentation
|
|
1039
1144
|
#
|
|
1040
1145
|
class GetBaselineOutput < Struct.new(
|
|
1041
1146
|
:arn,
|
|
1042
|
-
:
|
|
1043
|
-
:
|
|
1147
|
+
:name,
|
|
1148
|
+
:description)
|
|
1044
1149
|
SENSITIVE = []
|
|
1045
1150
|
include Aws::Structure
|
|
1046
1151
|
end
|
|
@@ -1182,16 +1287,8 @@ module Aws::ControlTower
|
|
|
1182
1287
|
|
|
1183
1288
|
# Information about the landing zone.
|
|
1184
1289
|
#
|
|
1185
|
-
# @!attribute [rw]
|
|
1186
|
-
# The
|
|
1187
|
-
# @return [String]
|
|
1188
|
-
#
|
|
1189
|
-
# @!attribute [rw] drift_status
|
|
1190
|
-
# The drift status of the landing zone.
|
|
1191
|
-
# @return [Types::LandingZoneDriftStatusSummary]
|
|
1192
|
-
#
|
|
1193
|
-
# @!attribute [rw] latest_available_version
|
|
1194
|
-
# The latest available version of the landing zone.
|
|
1290
|
+
# @!attribute [rw] version
|
|
1291
|
+
# The landing zone's current deployed version.
|
|
1195
1292
|
# @return [String]
|
|
1196
1293
|
#
|
|
1197
1294
|
# @!attribute [rw] manifest
|
|
@@ -1199,24 +1296,38 @@ module Aws::ControlTower
|
|
|
1199
1296
|
# zone configurations.
|
|
1200
1297
|
# @return [Hash,Array,String,Numeric,Boolean]
|
|
1201
1298
|
#
|
|
1299
|
+
# @!attribute [rw] remediation_types
|
|
1300
|
+
# The types of remediation actions configured for the landing zone,
|
|
1301
|
+
# such as automatic drift correction or compliance enforcement.
|
|
1302
|
+
# @return [Array<String>]
|
|
1303
|
+
#
|
|
1304
|
+
# @!attribute [rw] arn
|
|
1305
|
+
# The ARN of the landing zone.
|
|
1306
|
+
# @return [String]
|
|
1307
|
+
#
|
|
1202
1308
|
# @!attribute [rw] status
|
|
1203
1309
|
# The landing zone deployment status. One of `ACTIVE`, `PROCESSING`,
|
|
1204
1310
|
# `FAILED`.
|
|
1205
1311
|
# @return [String]
|
|
1206
1312
|
#
|
|
1207
|
-
# @!attribute [rw]
|
|
1208
|
-
# The
|
|
1313
|
+
# @!attribute [rw] latest_available_version
|
|
1314
|
+
# The latest available version of the landing zone.
|
|
1209
1315
|
# @return [String]
|
|
1210
1316
|
#
|
|
1317
|
+
# @!attribute [rw] drift_status
|
|
1318
|
+
# The drift status of the landing zone.
|
|
1319
|
+
# @return [Types::LandingZoneDriftStatusSummary]
|
|
1320
|
+
#
|
|
1211
1321
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/LandingZoneDetail AWS API Documentation
|
|
1212
1322
|
#
|
|
1213
1323
|
class LandingZoneDetail < Struct.new(
|
|
1214
|
-
:
|
|
1215
|
-
:drift_status,
|
|
1216
|
-
:latest_available_version,
|
|
1324
|
+
:version,
|
|
1217
1325
|
:manifest,
|
|
1326
|
+
:remediation_types,
|
|
1327
|
+
:arn,
|
|
1218
1328
|
:status,
|
|
1219
|
-
:
|
|
1329
|
+
:latest_available_version,
|
|
1330
|
+
:drift_status)
|
|
1220
1331
|
SENSITIVE = []
|
|
1221
1332
|
include Aws::Structure
|
|
1222
1333
|
end
|
|
@@ -1250,14 +1361,6 @@ module Aws::ControlTower
|
|
|
1250
1361
|
|
|
1251
1362
|
# Information about a landing zone operation.
|
|
1252
1363
|
#
|
|
1253
|
-
# @!attribute [rw] end_time
|
|
1254
|
-
# The landing zone operation end time.
|
|
1255
|
-
# @return [Time]
|
|
1256
|
-
#
|
|
1257
|
-
# @!attribute [rw] operation_identifier
|
|
1258
|
-
# The `operationIdentifier` of the landing zone operation.
|
|
1259
|
-
# @return [String]
|
|
1260
|
-
#
|
|
1261
1364
|
# @!attribute [rw] operation_type
|
|
1262
1365
|
# The landing zone operation type.
|
|
1263
1366
|
#
|
|
@@ -1272,9 +1375,9 @@ module Aws::ControlTower
|
|
|
1272
1375
|
# * `RESET`: The `ResetLandingZone` operation.
|
|
1273
1376
|
# @return [String]
|
|
1274
1377
|
#
|
|
1275
|
-
# @!attribute [rw]
|
|
1276
|
-
# The landing zone operation
|
|
1277
|
-
# @return [
|
|
1378
|
+
# @!attribute [rw] operation_identifier
|
|
1379
|
+
# The `operationIdentifier` of the landing zone operation.
|
|
1380
|
+
# @return [String]
|
|
1278
1381
|
#
|
|
1279
1382
|
# @!attribute [rw] status
|
|
1280
1383
|
# Valid values:
|
|
@@ -1286,6 +1389,14 @@ module Aws::ControlTower
|
|
|
1286
1389
|
# * `FAILED`: The landing zone operation failed.
|
|
1287
1390
|
# @return [String]
|
|
1288
1391
|
#
|
|
1392
|
+
# @!attribute [rw] start_time
|
|
1393
|
+
# The landing zone operation start time.
|
|
1394
|
+
# @return [Time]
|
|
1395
|
+
#
|
|
1396
|
+
# @!attribute [rw] end_time
|
|
1397
|
+
# The landing zone operation end time.
|
|
1398
|
+
# @return [Time]
|
|
1399
|
+
#
|
|
1289
1400
|
# @!attribute [rw] status_message
|
|
1290
1401
|
# If the operation result is FAILED, this string contains a message
|
|
1291
1402
|
# explaining why the operation failed.
|
|
@@ -1294,11 +1405,11 @@ module Aws::ControlTower
|
|
|
1294
1405
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/LandingZoneOperationDetail AWS API Documentation
|
|
1295
1406
|
#
|
|
1296
1407
|
class LandingZoneOperationDetail < Struct.new(
|
|
1297
|
-
:end_time,
|
|
1298
|
-
:operation_identifier,
|
|
1299
1408
|
:operation_type,
|
|
1300
|
-
:
|
|
1409
|
+
:operation_identifier,
|
|
1301
1410
|
:status,
|
|
1411
|
+
:start_time,
|
|
1412
|
+
:end_time,
|
|
1302
1413
|
:status_message)
|
|
1303
1414
|
SENSITIVE = []
|
|
1304
1415
|
include Aws::Structure
|
|
@@ -1307,34 +1418,34 @@ module Aws::ControlTower
|
|
|
1307
1418
|
# A filter object that lets you call `ListLandingZoneOperations` with a
|
|
1308
1419
|
# specific filter.
|
|
1309
1420
|
#
|
|
1421
|
+
# @!attribute [rw] types
|
|
1422
|
+
# The set of landing zone operation types selected by the filter.
|
|
1423
|
+
# @return [Array<String>]
|
|
1424
|
+
#
|
|
1310
1425
|
# @!attribute [rw] statuses
|
|
1311
1426
|
# The statuses of the set of landing zone operations selected by the
|
|
1312
1427
|
# filter.
|
|
1313
1428
|
# @return [Array<String>]
|
|
1314
1429
|
#
|
|
1315
|
-
# @!attribute [rw] types
|
|
1316
|
-
# The set of landing zone operation types selected by the filter.
|
|
1317
|
-
# @return [Array<String>]
|
|
1318
|
-
#
|
|
1319
1430
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/LandingZoneOperationFilter AWS API Documentation
|
|
1320
1431
|
#
|
|
1321
1432
|
class LandingZoneOperationFilter < Struct.new(
|
|
1322
|
-
:
|
|
1323
|
-
:
|
|
1433
|
+
:types,
|
|
1434
|
+
:statuses)
|
|
1324
1435
|
SENSITIVE = []
|
|
1325
1436
|
include Aws::Structure
|
|
1326
1437
|
end
|
|
1327
1438
|
|
|
1328
1439
|
# Returns a summary of information about a landing zone operation.
|
|
1329
1440
|
#
|
|
1330
|
-
# @!attribute [rw] operation_identifier
|
|
1331
|
-
# The `operationIdentifier` of the landing zone operation.
|
|
1332
|
-
# @return [String]
|
|
1333
|
-
#
|
|
1334
1441
|
# @!attribute [rw] operation_type
|
|
1335
1442
|
# The type of the landing zone operation.
|
|
1336
1443
|
# @return [String]
|
|
1337
1444
|
#
|
|
1445
|
+
# @!attribute [rw] operation_identifier
|
|
1446
|
+
# The `operationIdentifier` of the landing zone operation.
|
|
1447
|
+
# @return [String]
|
|
1448
|
+
#
|
|
1338
1449
|
# @!attribute [rw] status
|
|
1339
1450
|
# The status of the landing zone operation.
|
|
1340
1451
|
# @return [String]
|
|
@@ -1342,8 +1453,8 @@ module Aws::ControlTower
|
|
|
1342
1453
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/LandingZoneOperationSummary AWS API Documentation
|
|
1343
1454
|
#
|
|
1344
1455
|
class LandingZoneOperationSummary < Struct.new(
|
|
1345
|
-
:operation_identifier,
|
|
1346
1456
|
:operation_type,
|
|
1457
|
+
:operation_identifier,
|
|
1347
1458
|
:status)
|
|
1348
1459
|
SENSITIVE = []
|
|
1349
1460
|
include Aws::Structure
|
|
@@ -1363,19 +1474,19 @@ module Aws::ControlTower
|
|
|
1363
1474
|
include Aws::Structure
|
|
1364
1475
|
end
|
|
1365
1476
|
|
|
1366
|
-
# @!attribute [rw] max_results
|
|
1367
|
-
# The maximum number of results to be shown.
|
|
1368
|
-
# @return [Integer]
|
|
1369
|
-
#
|
|
1370
1477
|
# @!attribute [rw] next_token
|
|
1371
1478
|
# A pagination token.
|
|
1372
1479
|
# @return [String]
|
|
1373
1480
|
#
|
|
1481
|
+
# @!attribute [rw] max_results
|
|
1482
|
+
# The maximum number of results to be shown.
|
|
1483
|
+
# @return [Integer]
|
|
1484
|
+
#
|
|
1374
1485
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListBaselinesInput AWS API Documentation
|
|
1375
1486
|
#
|
|
1376
1487
|
class ListBaselinesInput < Struct.new(
|
|
1377
|
-
:
|
|
1378
|
-
:
|
|
1488
|
+
:next_token,
|
|
1489
|
+
:max_results)
|
|
1379
1490
|
SENSITIVE = []
|
|
1380
1491
|
include Aws::Structure
|
|
1381
1492
|
end
|
|
@@ -1402,20 +1513,20 @@ module Aws::ControlTower
|
|
|
1402
1513
|
# select the types of control operations to view.
|
|
1403
1514
|
# @return [Types::ControlOperationFilter]
|
|
1404
1515
|
#
|
|
1405
|
-
# @!attribute [rw] max_results
|
|
1406
|
-
# The maximum number of results to be shown.
|
|
1407
|
-
# @return [Integer]
|
|
1408
|
-
#
|
|
1409
1516
|
# @!attribute [rw] next_token
|
|
1410
1517
|
# A pagination token.
|
|
1411
1518
|
# @return [String]
|
|
1412
1519
|
#
|
|
1520
|
+
# @!attribute [rw] max_results
|
|
1521
|
+
# The maximum number of results to be shown.
|
|
1522
|
+
# @return [Integer]
|
|
1523
|
+
#
|
|
1413
1524
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListControlOperationsInput AWS API Documentation
|
|
1414
1525
|
#
|
|
1415
1526
|
class ListControlOperationsInput < Struct.new(
|
|
1416
1527
|
:filter,
|
|
1417
|
-
:
|
|
1418
|
-
:
|
|
1528
|
+
:next_token,
|
|
1529
|
+
:max_results)
|
|
1419
1530
|
SENSITIVE = []
|
|
1420
1531
|
include Aws::Structure
|
|
1421
1532
|
end
|
|
@@ -1443,26 +1554,26 @@ module Aws::ControlTower
|
|
|
1443
1554
|
# filter can be applied for either, or both.
|
|
1444
1555
|
# @return [Types::EnabledBaselineFilter]
|
|
1445
1556
|
#
|
|
1446
|
-
# @!attribute [rw]
|
|
1447
|
-
# A
|
|
1448
|
-
#
|
|
1449
|
-
# @return [Boolean]
|
|
1557
|
+
# @!attribute [rw] next_token
|
|
1558
|
+
# A pagination token.
|
|
1559
|
+
# @return [String]
|
|
1450
1560
|
#
|
|
1451
1561
|
# @!attribute [rw] max_results
|
|
1452
1562
|
# The maximum number of results to be shown.
|
|
1453
1563
|
# @return [Integer]
|
|
1454
1564
|
#
|
|
1455
|
-
# @!attribute [rw]
|
|
1456
|
-
# A
|
|
1457
|
-
#
|
|
1565
|
+
# @!attribute [rw] include_children
|
|
1566
|
+
# A value that can be set to include the child enabled baselines in
|
|
1567
|
+
# responses. The default value is false.
|
|
1568
|
+
# @return [Boolean]
|
|
1458
1569
|
#
|
|
1459
1570
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListEnabledBaselinesInput AWS API Documentation
|
|
1460
1571
|
#
|
|
1461
1572
|
class ListEnabledBaselinesInput < Struct.new(
|
|
1462
1573
|
:filter,
|
|
1463
|
-
:
|
|
1574
|
+
:next_token,
|
|
1464
1575
|
:max_results,
|
|
1465
|
-
:
|
|
1576
|
+
:include_children)
|
|
1466
1577
|
SENSITIVE = []
|
|
1467
1578
|
include Aws::Structure
|
|
1468
1579
|
end
|
|
@@ -1484,36 +1595,42 @@ module Aws::ControlTower
|
|
|
1484
1595
|
include Aws::Structure
|
|
1485
1596
|
end
|
|
1486
1597
|
|
|
1487
|
-
# @!attribute [rw]
|
|
1488
|
-
#
|
|
1489
|
-
#
|
|
1490
|
-
# @return [Types::EnabledControlFilter]
|
|
1598
|
+
# @!attribute [rw] target_identifier
|
|
1599
|
+
# The ARN of the organizational unit. For information on how to find
|
|
1600
|
+
# the `targetIdentifier`, see [the overview page][1].
|
|
1491
1601
|
#
|
|
1492
|
-
#
|
|
1493
|
-
#
|
|
1494
|
-
#
|
|
1602
|
+
#
|
|
1603
|
+
#
|
|
1604
|
+
# [1]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html
|
|
1605
|
+
# @return [String]
|
|
1495
1606
|
#
|
|
1496
1607
|
# @!attribute [rw] next_token
|
|
1497
1608
|
# The token to continue the list from a previous API call with the
|
|
1498
1609
|
# same parameters.
|
|
1499
1610
|
# @return [String]
|
|
1500
1611
|
#
|
|
1501
|
-
# @!attribute [rw]
|
|
1502
|
-
#
|
|
1503
|
-
#
|
|
1504
|
-
#
|
|
1612
|
+
# @!attribute [rw] max_results
|
|
1613
|
+
# How many results to return per API call.
|
|
1614
|
+
# @return [Integer]
|
|
1505
1615
|
#
|
|
1616
|
+
# @!attribute [rw] filter
|
|
1617
|
+
# An input filter for the `ListEnabledControls` API that lets you
|
|
1618
|
+
# select the types of control operations to view.
|
|
1619
|
+
# @return [Types::EnabledControlFilter]
|
|
1506
1620
|
#
|
|
1507
|
-
#
|
|
1508
|
-
#
|
|
1621
|
+
# @!attribute [rw] include_children
|
|
1622
|
+
# A boolean value that determines whether to include enabled controls
|
|
1623
|
+
# from child organizational units in the response.
|
|
1624
|
+
# @return [Boolean]
|
|
1509
1625
|
#
|
|
1510
1626
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListEnabledControlsInput AWS API Documentation
|
|
1511
1627
|
#
|
|
1512
1628
|
class ListEnabledControlsInput < Struct.new(
|
|
1513
|
-
:
|
|
1514
|
-
:max_results,
|
|
1629
|
+
:target_identifier,
|
|
1515
1630
|
:next_token,
|
|
1516
|
-
:
|
|
1631
|
+
:max_results,
|
|
1632
|
+
:filter,
|
|
1633
|
+
:include_children)
|
|
1517
1634
|
SENSITIVE = []
|
|
1518
1635
|
include Aws::Structure
|
|
1519
1636
|
end
|
|
@@ -1542,21 +1659,21 @@ module Aws::ControlTower
|
|
|
1542
1659
|
# you select the types of landing zone operations to view.
|
|
1543
1660
|
# @return [Types::LandingZoneOperationFilter]
|
|
1544
1661
|
#
|
|
1545
|
-
# @!attribute [rw] max_results
|
|
1546
|
-
# How many results to return per API call.
|
|
1547
|
-
# @return [Integer]
|
|
1548
|
-
#
|
|
1549
1662
|
# @!attribute [rw] next_token
|
|
1550
1663
|
# The token to continue the list from a previous API call with the
|
|
1551
1664
|
# same parameters.
|
|
1552
1665
|
# @return [String]
|
|
1553
1666
|
#
|
|
1667
|
+
# @!attribute [rw] max_results
|
|
1668
|
+
# How many results to return per API call.
|
|
1669
|
+
# @return [Integer]
|
|
1670
|
+
#
|
|
1554
1671
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListLandingZoneOperationsInput AWS API Documentation
|
|
1555
1672
|
#
|
|
1556
1673
|
class ListLandingZoneOperationsInput < Struct.new(
|
|
1557
1674
|
:filter,
|
|
1558
|
-
:
|
|
1559
|
-
:
|
|
1675
|
+
:next_token,
|
|
1676
|
+
:max_results)
|
|
1560
1677
|
SENSITIVE = []
|
|
1561
1678
|
include Aws::Structure
|
|
1562
1679
|
end
|
|
@@ -1579,20 +1696,20 @@ module Aws::ControlTower
|
|
|
1579
1696
|
include Aws::Structure
|
|
1580
1697
|
end
|
|
1581
1698
|
|
|
1582
|
-
# @!attribute [rw] max_results
|
|
1583
|
-
# The maximum number of returned landing zone ARNs, which is one.
|
|
1584
|
-
# @return [Integer]
|
|
1585
|
-
#
|
|
1586
1699
|
# @!attribute [rw] next_token
|
|
1587
1700
|
# The token to continue the list from a previous API call with the
|
|
1588
1701
|
# same parameters.
|
|
1589
1702
|
# @return [String]
|
|
1590
1703
|
#
|
|
1704
|
+
# @!attribute [rw] max_results
|
|
1705
|
+
# The maximum number of returned landing zone ARNs, which is one.
|
|
1706
|
+
# @return [Integer]
|
|
1707
|
+
#
|
|
1591
1708
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListLandingZonesInput AWS API Documentation
|
|
1592
1709
|
#
|
|
1593
1710
|
class ListLandingZonesInput < Struct.new(
|
|
1594
|
-
:
|
|
1595
|
-
:
|
|
1711
|
+
:next_token,
|
|
1712
|
+
:max_results)
|
|
1596
1713
|
SENSITIVE = []
|
|
1597
1714
|
include Aws::Structure
|
|
1598
1715
|
end
|
|
@@ -1753,8 +1870,12 @@ module Aws::ControlTower
|
|
|
1753
1870
|
include Aws::Structure
|
|
1754
1871
|
end
|
|
1755
1872
|
|
|
1756
|
-
# The request would cause a service quota to be exceeded.
|
|
1757
|
-
#
|
|
1873
|
+
# The request would cause a service quota to be exceeded. See [Service
|
|
1874
|
+
# quotas][1].
|
|
1875
|
+
#
|
|
1876
|
+
#
|
|
1877
|
+
#
|
|
1878
|
+
# [1]: https://docs.aws.amazon.com/controltower/latest/userguide/request-an-increase.html
|
|
1758
1879
|
#
|
|
1759
1880
|
# @!attribute [rw] message
|
|
1760
1881
|
# @return [String]
|
|
@@ -1793,6 +1914,10 @@ module Aws::ControlTower
|
|
|
1793
1914
|
# @!attribute [rw] message
|
|
1794
1915
|
# @return [String]
|
|
1795
1916
|
#
|
|
1917
|
+
# @!attribute [rw] service_code
|
|
1918
|
+
# The ID of the service that is associated with the error.
|
|
1919
|
+
# @return [String]
|
|
1920
|
+
#
|
|
1796
1921
|
# @!attribute [rw] quota_code
|
|
1797
1922
|
# The ID of the service quota that was exceeded.
|
|
1798
1923
|
# @return [String]
|
|
@@ -1801,17 +1926,13 @@ module Aws::ControlTower
|
|
|
1801
1926
|
# The number of seconds the caller should wait before retrying.
|
|
1802
1927
|
# @return [Integer]
|
|
1803
1928
|
#
|
|
1804
|
-
# @!attribute [rw] service_code
|
|
1805
|
-
# The ID of the service that is associated with the error.
|
|
1806
|
-
# @return [String]
|
|
1807
|
-
#
|
|
1808
1929
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ThrottlingException AWS API Documentation
|
|
1809
1930
|
#
|
|
1810
1931
|
class ThrottlingException < Struct.new(
|
|
1811
1932
|
:message,
|
|
1933
|
+
:service_code,
|
|
1812
1934
|
:quota_code,
|
|
1813
|
-
:retry_after_seconds
|
|
1814
|
-
:service_code)
|
|
1935
|
+
:retry_after_seconds)
|
|
1815
1936
|
SENSITIVE = []
|
|
1816
1937
|
include Aws::Structure
|
|
1817
1938
|
end
|
|
@@ -1842,20 +1963,20 @@ module Aws::ControlTower
|
|
|
1842
1963
|
# should be updated.
|
|
1843
1964
|
# @return [String]
|
|
1844
1965
|
#
|
|
1845
|
-
# @!attribute [rw] enabled_baseline_identifier
|
|
1846
|
-
# Specifies the `EnabledBaseline` resource to be updated.
|
|
1847
|
-
# @return [String]
|
|
1848
|
-
#
|
|
1849
1966
|
# @!attribute [rw] parameters
|
|
1850
1967
|
# Parameters to apply when making an update.
|
|
1851
1968
|
# @return [Array<Types::EnabledBaselineParameter>]
|
|
1852
1969
|
#
|
|
1970
|
+
# @!attribute [rw] enabled_baseline_identifier
|
|
1971
|
+
# Specifies the `EnabledBaseline` resource to be updated.
|
|
1972
|
+
# @return [String]
|
|
1973
|
+
#
|
|
1853
1974
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UpdateEnabledBaselineInput AWS API Documentation
|
|
1854
1975
|
#
|
|
1855
1976
|
class UpdateEnabledBaselineInput < Struct.new(
|
|
1856
1977
|
:baseline_version,
|
|
1857
|
-
:
|
|
1858
|
-
:
|
|
1978
|
+
:parameters,
|
|
1979
|
+
:enabled_baseline_identifier)
|
|
1859
1980
|
SENSITIVE = []
|
|
1860
1981
|
include Aws::Structure
|
|
1861
1982
|
end
|
|
@@ -1874,20 +1995,20 @@ module Aws::ControlTower
|
|
|
1874
1995
|
include Aws::Structure
|
|
1875
1996
|
end
|
|
1876
1997
|
|
|
1877
|
-
# @!attribute [rw] enabled_control_identifier
|
|
1878
|
-
# The ARN of the enabled control that will be updated.
|
|
1879
|
-
# @return [String]
|
|
1880
|
-
#
|
|
1881
1998
|
# @!attribute [rw] parameters
|
|
1882
1999
|
# A key/value pair, where `Key` is of type `String` and `Value` is of
|
|
1883
2000
|
# type `Document`.
|
|
1884
2001
|
# @return [Array<Types::EnabledControlParameter>]
|
|
1885
2002
|
#
|
|
2003
|
+
# @!attribute [rw] enabled_control_identifier
|
|
2004
|
+
# The ARN of the enabled control that will be updated.
|
|
2005
|
+
# @return [String]
|
|
2006
|
+
#
|
|
1886
2007
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UpdateEnabledControlInput AWS API Documentation
|
|
1887
2008
|
#
|
|
1888
2009
|
class UpdateEnabledControlInput < Struct.new(
|
|
1889
|
-
:
|
|
1890
|
-
:
|
|
2010
|
+
:parameters,
|
|
2011
|
+
:enabled_control_identifier)
|
|
1891
2012
|
SENSITIVE = []
|
|
1892
2013
|
include Aws::Structure
|
|
1893
2014
|
end
|
|
@@ -1904,8 +2025,8 @@ module Aws::ControlTower
|
|
|
1904
2025
|
include Aws::Structure
|
|
1905
2026
|
end
|
|
1906
2027
|
|
|
1907
|
-
# @!attribute [rw]
|
|
1908
|
-
# The
|
|
2028
|
+
# @!attribute [rw] version
|
|
2029
|
+
# The landing zone version, for example, 3.2.
|
|
1909
2030
|
# @return [String]
|
|
1910
2031
|
#
|
|
1911
2032
|
# @!attribute [rw] manifest
|
|
@@ -1920,16 +2041,22 @@ module Aws::ControlTower
|
|
|
1920
2041
|
# [1]: https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch
|
|
1921
2042
|
# @return [Hash,Array,String,Numeric,Boolean]
|
|
1922
2043
|
#
|
|
1923
|
-
# @!attribute [rw]
|
|
1924
|
-
#
|
|
2044
|
+
# @!attribute [rw] remediation_types
|
|
2045
|
+
# Specifies the types of remediation actions to apply when updating
|
|
2046
|
+
# the landing zone configuration.
|
|
2047
|
+
# @return [Array<String>]
|
|
2048
|
+
#
|
|
2049
|
+
# @!attribute [rw] landing_zone_identifier
|
|
2050
|
+
# The unique identifier of the landing zone.
|
|
1925
2051
|
# @return [String]
|
|
1926
2052
|
#
|
|
1927
2053
|
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UpdateLandingZoneInput AWS API Documentation
|
|
1928
2054
|
#
|
|
1929
2055
|
class UpdateLandingZoneInput < Struct.new(
|
|
1930
|
-
:
|
|
2056
|
+
:version,
|
|
1931
2057
|
:manifest,
|
|
1932
|
-
:
|
|
2058
|
+
:remediation_types,
|
|
2059
|
+
:landing_zone_identifier)
|
|
1933
2060
|
SENSITIVE = []
|
|
1934
2061
|
include Aws::Structure
|
|
1935
2062
|
end
|