aws-sdk-controltower 1.13.0 → 1.14.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '01068a7d69e7cfce4651d37296c14de38dc9bbb891cfe5c1c35f4d2aa32f1fff'
4
- data.tar.gz: e4df49d011371aabf701df509be82704c56c698257af82a7ef24664e11b4ce50
3
+ metadata.gz: 573d52fdb4d2e41257388f874ba6fbdcd130dfd04fbec74df7a95d5d2c1e19d7
4
+ data.tar.gz: 2f24b76751109439a2cee72646bdb8b98a07091d26ad09c3976f37de179ae3a1
5
5
  SHA512:
6
- metadata.gz: 499bf6a89d21c53a832d3d69d3e21048520c79e05f00d5d1097dcf35477ab1b394bff23dfc294565364c8bb7a4dfadeb16bd6a4bdd0cb3b6a60f57435b26b7d3
7
- data.tar.gz: ef6b264490f8ca513de8630629860f32ad25340d90519440d84f71cbee2954274fc332cf4e2b59b176c22abc6680a718006e52b2cfccbe16551b5dfd76c1a7c1
6
+ metadata.gz: 29ffd45b639cddbbf4ba47dd4041cc3bec4e8c2dbeed630650d0c90f4a8ec941d05bfb96fb4e986b2f8e7fd115930166ec06ebaab89cf4681ca7bc39ad19a5ee
7
+ data.tar.gz: a7eac3ddc681b61a3a608654012ab2da9dae7f73c52d793907a8ebce36e1be8d75bfed3cc0fd66c8dc487ca880b9a444cc7e2bd53aadcab522627139b7a129ff
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.14.0 (2023-11-27)
5
+ ------------------
6
+
7
+ * Feature - This release adds the following support: 1. The EnableControl API can configure controls that are configurable. 2. The GetEnabledControl API shows the configured parameters on an enabled control. 3. The new UpdateEnabledControl API can change parameters on an enabled control.
8
+
4
9
  1.13.0 (2023-11-27)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.13.0
1
+ 1.14.0
@@ -388,9 +388,9 @@ module Aws::ControlTower
388
388
 
389
389
  # @!group API Operations
390
390
 
391
- # Creates a new landing zone. This starts an asynchronous operation that
392
- # creates and configures a landing zone based on the parameters
393
- # specified in the manifest JSON file.
391
+ # Creates a new landing zone. This API call starts an asynchronous
392
+ # operation that creates and configures a landing zone, based on the
393
+ # parameters specified in the manifest JSON file.
394
394
  #
395
395
  # @option params [required, Hash,Array,String,Numeric,Boolean] :manifest
396
396
  # The manifest.yaml file is a text file that describes your Amazon Web
@@ -409,7 +409,7 @@ module Aws::ControlTower
409
409
  # Tags to be applied to the landing zone.
410
410
  #
411
411
  # @option params [required, String] :version
412
- # The landing zone version.
412
+ # The landing zone version, for example, 3.0.
413
413
  #
414
414
  # @return [Types::CreateLandingZoneOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
415
415
  #
@@ -441,9 +441,9 @@ module Aws::ControlTower
441
441
  req.send_request(options)
442
442
  end
443
443
 
444
- # This decommissions a landing zone. This starts an asynchronous
444
+ # Decommissions a landing zone. This API call starts an asynchronous
445
445
  # operation that deletes Amazon Web Services Control Tower resources
446
- # deployed in Amazon Web Services Control Tower managed accounts.
446
+ # deployed in accounts managed by Amazon Web Services Control Tower.
447
447
  #
448
448
  # @option params [required, String] :landing_zone_identifier
449
449
  # The unique identifier of the landing zone.
@@ -483,9 +483,9 @@ module Aws::ControlTower
483
483
  #
484
484
  # @option params [required, String] :control_identifier
485
485
  # The ARN of the control. Only **Strongly recommended** and **Elective**
486
- # controls are permitted, with the exception of the **Region deny**
487
- # control. For information on how to find the `controlIdentifier`, see
488
- # [the overview page][1].
486
+ # controls are permitted, with the exception of the **landing zone
487
+ # Region deny** control. For information on how to find the
488
+ # `controlIdentifier`, see [the overview page][1].
489
489
  #
490
490
  #
491
491
  #
@@ -536,14 +536,17 @@ module Aws::ControlTower
536
536
  #
537
537
  # @option params [required, String] :control_identifier
538
538
  # The ARN of the control. Only **Strongly recommended** and **Elective**
539
- # controls are permitted, with the exception of the **Region deny**
540
- # control. For information on how to find the `controlIdentifier`, see
541
- # [the overview page][1].
539
+ # controls are permitted, with the exception of the **landing zone
540
+ # Region deny** control. For information on how to find the
541
+ # `controlIdentifier`, see [the overview page][1].
542
542
  #
543
543
  #
544
544
  #
545
545
  # [1]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html
546
546
  #
547
+ # @option params [Array<Types::EnabledControlParameter>] :parameters
548
+ # An array of `EnabledControlParameter` objects
549
+ #
547
550
  # @option params [Hash<String,String>] :tags
548
551
  # Tags to be applied to the `EnabledControl` resource.
549
552
  #
@@ -564,6 +567,13 @@ module Aws::ControlTower
564
567
  #
565
568
  # resp = client.enable_control({
566
569
  # control_identifier: "ControlIdentifier", # required
570
+ # parameters: [
571
+ # {
572
+ # key: "String", # required
573
+ # value: { # required
574
+ # },
575
+ # },
576
+ # ],
567
577
  # tags: {
568
578
  # "TagKey" => "TagValue",
569
579
  # },
@@ -610,7 +620,7 @@ module Aws::ControlTower
610
620
  # @example Response structure
611
621
  #
612
622
  # resp.control_operation.end_time #=> Time
613
- # resp.control_operation.operation_type #=> String, one of "ENABLE_CONTROL", "DISABLE_CONTROL"
623
+ # resp.control_operation.operation_type #=> String, one of "ENABLE_CONTROL", "DISABLE_CONTROL", "UPDATE_ENABLED_CONTROL"
614
624
  # resp.control_operation.start_time #=> Time
615
625
  # resp.control_operation.status #=> String, one of "SUCCEEDED", "FAILED", "IN_PROGRESS"
616
626
  # resp.control_operation.status_message #=> String
@@ -649,6 +659,8 @@ module Aws::ControlTower
649
659
  # resp.enabled_control_details.arn #=> String
650
660
  # resp.enabled_control_details.control_identifier #=> String
651
661
  # resp.enabled_control_details.drift_status_summary.drift_status #=> String, one of "DRIFTED", "IN_SYNC", "NOT_CHECKING", "UNKNOWN"
662
+ # resp.enabled_control_details.parameters #=> Array
663
+ # resp.enabled_control_details.parameters[0].key #=> String
652
664
  # resp.enabled_control_details.status_summary.last_operation_identifier #=> String
653
665
  # resp.enabled_control_details.status_summary.status #=> String, one of "SUCCEEDED", "FAILED", "UNDER_CHANGE"
654
666
  # resp.enabled_control_details.target_identifier #=> String
@@ -698,7 +710,7 @@ module Aws::ControlTower
698
710
  end
699
711
 
700
712
  # Returns the status of the specified landing zone operation. Details
701
- # for an operation are available for X days.
713
+ # for an operation are available for 60 days.
702
714
  #
703
715
  # @option params [required, String] :operation_identifier
704
716
  # A unique identifier assigned to a landing zone operation.
@@ -793,10 +805,10 @@ module Aws::ControlTower
793
805
  # managed account. This API also creates an ARN for existing accounts
794
806
  # that do not yet have a landing zone ARN.
795
807
  #
796
- # The return limit is one landing zone ARN.
808
+ # Returns one landing zone ARN.
797
809
  #
798
810
  # @option params [Integer] :max_results
799
- # The maximum number of returned landing zone ARNs.
811
+ # The maximum number of returned landing zone ARNs, which is one.
800
812
  #
801
813
  # @option params [String] :next_token
802
814
  # The token to continue the list from a previous API call with the same
@@ -960,17 +972,75 @@ module Aws::ControlTower
960
972
  req.send_request(options)
961
973
  end
962
974
 
975
+ # Updates the configuration of an already enabled control.
976
+ #
977
+ # If the enabled control shows an `EnablementStatus` of SUCCEEDED,
978
+ # supply parameters that are different from the currently configured
979
+ # parameters. Otherwise, Amazon Web Services Control Tower will not
980
+ # accept the request.
981
+ #
982
+ # If the enabled control shows an `EnablementStatus` of FAILED, Amazon
983
+ # Web Services Control Tower will update the control to match any valid
984
+ # parameters that you supply.
985
+ #
986
+ # If the `DriftSummary` status for the control shows as DRIFTED, you
987
+ # cannot call this API. Instead, you can update the control by calling
988
+ # `DisableControl` and again calling `EnableControl`, or you can run an
989
+ # extending governance operation. For usage examples, see [ *the Amazon
990
+ # Web Services Control Tower User Guide* ][1]
991
+ #
992
+ #
993
+ #
994
+ # [1]: https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html
995
+ #
996
+ # @option params [required, String] :enabled_control_identifier
997
+ # The ARN of the enabled control that will be updated.
998
+ #
999
+ # @option params [required, Array<Types::EnabledControlParameter>] :parameters
1000
+ # A key/value pair, where `Key` is of type `String` and `Value` is of
1001
+ # type `Document`.
1002
+ #
1003
+ # @return [Types::UpdateEnabledControlOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1004
+ #
1005
+ # * {Types::UpdateEnabledControlOutput#operation_identifier #operation_identifier} => String
1006
+ #
1007
+ # @example Request syntax with placeholder values
1008
+ #
1009
+ # resp = client.update_enabled_control({
1010
+ # enabled_control_identifier: "Arn", # required
1011
+ # parameters: [ # required
1012
+ # {
1013
+ # key: "String", # required
1014
+ # value: { # required
1015
+ # },
1016
+ # },
1017
+ # ],
1018
+ # })
1019
+ #
1020
+ # @example Response structure
1021
+ #
1022
+ # resp.operation_identifier #=> String
1023
+ #
1024
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UpdateEnabledControl AWS API Documentation
1025
+ #
1026
+ # @overload update_enabled_control(params = {})
1027
+ # @param [Hash] params ({})
1028
+ def update_enabled_control(params = {}, options = {})
1029
+ req = build_request(:update_enabled_control, params)
1030
+ req.send_request(options)
1031
+ end
1032
+
963
1033
  # This API call updates the landing zone. It starts an asynchronous
964
1034
  # operation that updates the landing zone based on the new landing zone
965
- # version or the updated parameters specified in the updated manifest
966
- # file.
1035
+ # version, or on the changed parameters specified in the updated
1036
+ # manifest file.
967
1037
  #
968
1038
  # @option params [required, String] :landing_zone_identifier
969
1039
  # The unique identifier of the landing zone.
970
1040
  #
971
1041
  # @option params [required, Hash,Array,String,Numeric,Boolean] :manifest
972
- # The manifest.yaml file is a text file that describes your Amazon Web
973
- # Services resources. For examples, review [The manifest file][1]
1042
+ # The `manifest.yaml` file is a text file that describes your Amazon Web
1043
+ # Services resources. For examples, review [The manifest file][1].
974
1044
  #
975
1045
  # Document type used to carry open content
976
1046
  # (Hash,Array,String,Numeric,Boolean). A document type value is
@@ -982,7 +1052,7 @@ module Aws::ControlTower
982
1052
  # [1]: https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file
983
1053
  #
984
1054
  # @option params [required, String] :version
985
- # The landing zone version.
1055
+ # The landing zone version, for example, 3.2.
986
1056
  #
987
1057
  # @return [Types::UpdateLandingZoneOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
988
1058
  #
@@ -1023,7 +1093,7 @@ module Aws::ControlTower
1023
1093
  params: params,
1024
1094
  config: config)
1025
1095
  context[:gem_name] = 'aws-sdk-controltower'
1026
- context[:gem_version] = '1.13.0'
1096
+ context[:gem_version] = '1.14.0'
1027
1097
  Seahorse::Client::Request.new(handlers, context)
1028
1098
  end
1029
1099
 
@@ -26,11 +26,16 @@ module Aws::ControlTower
26
26
  DeleteLandingZoneOutput = Shapes::StructureShape.new(name: 'DeleteLandingZoneOutput')
27
27
  DisableControlInput = Shapes::StructureShape.new(name: 'DisableControlInput')
28
28
  DisableControlOutput = Shapes::StructureShape.new(name: 'DisableControlOutput')
29
+ Document = Shapes::DocumentShape.new(name: 'Document', document: true)
29
30
  DriftStatus = Shapes::StringShape.new(name: 'DriftStatus')
30
31
  DriftStatusSummary = Shapes::StructureShape.new(name: 'DriftStatusSummary')
31
32
  EnableControlInput = Shapes::StructureShape.new(name: 'EnableControlInput')
32
33
  EnableControlOutput = Shapes::StructureShape.new(name: 'EnableControlOutput')
33
34
  EnabledControlDetails = Shapes::StructureShape.new(name: 'EnabledControlDetails')
35
+ EnabledControlParameter = Shapes::StructureShape.new(name: 'EnabledControlParameter')
36
+ EnabledControlParameterSummaries = Shapes::ListShape.new(name: 'EnabledControlParameterSummaries')
37
+ EnabledControlParameterSummary = Shapes::StructureShape.new(name: 'EnabledControlParameterSummary')
38
+ EnabledControlParameters = Shapes::ListShape.new(name: 'EnabledControlParameters')
34
39
  EnabledControlSummary = Shapes::StructureShape.new(name: 'EnabledControlSummary')
35
40
  EnabledControls = Shapes::ListShape.new(name: 'EnabledControls')
36
41
  EnablementStatus = Shapes::StringShape.new(name: 'EnablementStatus')
@@ -85,6 +90,8 @@ module Aws::ControlTower
85
90
  Timestamp = Shapes::TimestampShape.new(name: 'Timestamp', timestampFormat: "iso8601")
86
91
  UntagResourceInput = Shapes::StructureShape.new(name: 'UntagResourceInput')
87
92
  UntagResourceOutput = Shapes::StructureShape.new(name: 'UntagResourceOutput')
93
+ UpdateEnabledControlInput = Shapes::StructureShape.new(name: 'UpdateEnabledControlInput')
94
+ UpdateEnabledControlOutput = Shapes::StructureShape.new(name: 'UpdateEnabledControlOutput')
88
95
  UpdateLandingZoneInput = Shapes::StructureShape.new(name: 'UpdateLandingZoneInput')
89
96
  UpdateLandingZoneOutput = Shapes::StructureShape.new(name: 'UpdateLandingZoneOutput')
90
97
  ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
@@ -128,6 +135,7 @@ module Aws::ControlTower
128
135
  DriftStatusSummary.struct_class = Types::DriftStatusSummary
129
136
 
130
137
  EnableControlInput.add_member(:control_identifier, Shapes::ShapeRef.new(shape: ControlIdentifier, required: true, location_name: "controlIdentifier"))
138
+ EnableControlInput.add_member(:parameters, Shapes::ShapeRef.new(shape: EnabledControlParameters, location_name: "parameters"))
131
139
  EnableControlInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags"))
132
140
  EnableControlInput.add_member(:target_identifier, Shapes::ShapeRef.new(shape: TargetIdentifier, required: true, location_name: "targetIdentifier"))
133
141
  EnableControlInput.struct_class = Types::EnableControlInput
@@ -139,11 +147,24 @@ module Aws::ControlTower
139
147
  EnabledControlDetails.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "arn"))
140
148
  EnabledControlDetails.add_member(:control_identifier, Shapes::ShapeRef.new(shape: ControlIdentifier, location_name: "controlIdentifier"))
141
149
  EnabledControlDetails.add_member(:drift_status_summary, Shapes::ShapeRef.new(shape: DriftStatusSummary, location_name: "driftStatusSummary"))
150
+ EnabledControlDetails.add_member(:parameters, Shapes::ShapeRef.new(shape: EnabledControlParameterSummaries, location_name: "parameters"))
142
151
  EnabledControlDetails.add_member(:status_summary, Shapes::ShapeRef.new(shape: EnablementStatusSummary, location_name: "statusSummary"))
143
152
  EnabledControlDetails.add_member(:target_identifier, Shapes::ShapeRef.new(shape: TargetIdentifier, location_name: "targetIdentifier"))
144
153
  EnabledControlDetails.add_member(:target_regions, Shapes::ShapeRef.new(shape: TargetRegions, location_name: "targetRegions"))
145
154
  EnabledControlDetails.struct_class = Types::EnabledControlDetails
146
155
 
156
+ EnabledControlParameter.add_member(:key, Shapes::ShapeRef.new(shape: String, required: true, location_name: "key"))
157
+ EnabledControlParameter.add_member(:value, Shapes::ShapeRef.new(shape: Document, required: true, location_name: "value"))
158
+ EnabledControlParameter.struct_class = Types::EnabledControlParameter
159
+
160
+ EnabledControlParameterSummaries.member = Shapes::ShapeRef.new(shape: EnabledControlParameterSummary)
161
+
162
+ EnabledControlParameterSummary.add_member(:key, Shapes::ShapeRef.new(shape: String, required: true, location_name: "key"))
163
+ EnabledControlParameterSummary.add_member(:value, Shapes::ShapeRef.new(shape: Document, required: true, location_name: "value"))
164
+ EnabledControlParameterSummary.struct_class = Types::EnabledControlParameterSummary
165
+
166
+ EnabledControlParameters.member = Shapes::ShapeRef.new(shape: EnabledControlParameter)
167
+
147
168
  EnabledControlSummary.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "arn"))
148
169
  EnabledControlSummary.add_member(:control_identifier, Shapes::ShapeRef.new(shape: ControlIdentifier, location_name: "controlIdentifier"))
149
170
  EnabledControlSummary.add_member(:drift_status_summary, Shapes::ShapeRef.new(shape: DriftStatusSummary, location_name: "driftStatusSummary"))
@@ -270,6 +291,13 @@ module Aws::ControlTower
270
291
 
271
292
  UntagResourceOutput.struct_class = Types::UntagResourceOutput
272
293
 
294
+ UpdateEnabledControlInput.add_member(:enabled_control_identifier, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "enabledControlIdentifier"))
295
+ UpdateEnabledControlInput.add_member(:parameters, Shapes::ShapeRef.new(shape: EnabledControlParameters, required: true, location_name: "parameters"))
296
+ UpdateEnabledControlInput.struct_class = Types::UpdateEnabledControlInput
297
+
298
+ UpdateEnabledControlOutput.add_member(:operation_identifier, Shapes::ShapeRef.new(shape: OperationIdentifier, required: true, location_name: "operationIdentifier"))
299
+ UpdateEnabledControlOutput.struct_class = Types::UpdateEnabledControlOutput
300
+
273
301
  UpdateLandingZoneInput.add_member(:landing_zone_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "landingZoneIdentifier"))
274
302
  UpdateLandingZoneInput.add_member(:manifest, Shapes::ShapeRef.new(shape: Manifest, required: true, location_name: "manifest"))
275
303
  UpdateLandingZoneInput.add_member(:version, Shapes::ShapeRef.new(shape: LandingZoneVersion, required: true, location_name: "version"))
@@ -492,6 +520,21 @@ module Aws::ControlTower
492
520
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
493
521
  end)
494
522
 
523
+ api.add_operation(:update_enabled_control, Seahorse::Model::Operation.new.tap do |o|
524
+ o.name = "UpdateEnabledControl"
525
+ o.http_method = "POST"
526
+ o.http_request_uri = "/update-enabled-control"
527
+ o.input = Shapes::ShapeRef.new(shape: UpdateEnabledControlInput)
528
+ o.output = Shapes::ShapeRef.new(shape: UpdateEnabledControlOutput)
529
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
530
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
531
+ o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
532
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
533
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
534
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
535
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
536
+ end)
537
+
495
538
  api.add_operation(:update_landing_zone, Seahorse::Model::Operation.new.tap do |o|
496
539
  o.name = "UpdateLandingZone"
497
540
  o.http_method = "POST"
@@ -208,6 +208,20 @@ module Aws::ControlTower
208
208
  end
209
209
  end
210
210
 
211
+ class UpdateEnabledControl
212
+ def self.build(context)
213
+ unless context.config.regional_endpoint
214
+ endpoint = context.config.endpoint.to_s
215
+ end
216
+ Aws::ControlTower::EndpointParameters.new(
217
+ region: context.config.region,
218
+ use_dual_stack: context.config.use_dualstack_endpoint,
219
+ use_fips: context.config.use_fips_endpoint,
220
+ endpoint: endpoint,
221
+ )
222
+ end
223
+ end
224
+
211
225
  class UpdateLandingZone
212
226
  def self.build(context)
213
227
  unless context.config.regional_endpoint
@@ -84,6 +84,8 @@ module Aws::ControlTower
84
84
  Aws::ControlTower::Endpoints::TagResource.build(context)
85
85
  when :untag_resource
86
86
  Aws::ControlTower::Endpoints::UntagResource.build(context)
87
+ when :update_enabled_control
88
+ Aws::ControlTower::Endpoints::UpdateEnabledControl.build(context)
87
89
  when :update_landing_zone
88
90
  Aws::ControlTower::Endpoints::UpdateLandingZone.build(context)
89
91
  end
@@ -23,7 +23,7 @@ module Aws::ControlTower
23
23
  include Aws::Structure
24
24
  end
25
25
 
26
- # Updating or deleting a resource can cause an inconsistent state.
26
+ # Updating or deleting the resource can cause an inconsistent state.
27
27
  #
28
28
  # @!attribute [rw] message
29
29
  # @return [String]
@@ -85,7 +85,7 @@ module Aws::ControlTower
85
85
  # @return [Hash<String,String>]
86
86
  #
87
87
  # @!attribute [rw] version
88
- # The landing zone version.
88
+ # The landing zone version, for example, 3.0.
89
89
  # @return [String]
90
90
  #
91
91
  # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/CreateLandingZoneInput AWS API Documentation
@@ -99,7 +99,7 @@ module Aws::ControlTower
99
99
  end
100
100
 
101
101
  # @!attribute [rw] arn
102
- # The ARN of the landing zone.
102
+ # The ARN of the landing zone resource.
103
103
  # @return [String]
104
104
  #
105
105
  # @!attribute [rw] operation_identifier
@@ -130,9 +130,9 @@ module Aws::ControlTower
130
130
  end
131
131
 
132
132
  # @!attribute [rw] operation_identifier
133
- # A unique identifier assigned to a `DeleteLandingZone` operation. You
134
- # can use this identifier as an input of `GetLandingZoneOperation` to
135
- # check the operation's status.
133
+ # &gt;A unique identifier assigned to a `DeleteLandingZone` operation.
134
+ # You can use this identifier as an input parameter of
135
+ # `GetLandingZoneOperation` to check the operation's status.
136
136
  # @return [String]
137
137
  #
138
138
  # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DeleteLandingZoneOutput AWS API Documentation
@@ -146,8 +146,8 @@ module Aws::ControlTower
146
146
  # @!attribute [rw] control_identifier
147
147
  # The ARN of the control. Only **Strongly recommended** and
148
148
  # **Elective** controls are permitted, with the exception of the
149
- # **Region deny** control. For information on how to find the
150
- # `controlIdentifier`, see [the overview page][1].
149
+ # **landing zone Region deny** control. For information on how to find
150
+ # the `controlIdentifier`, see [the overview page][1].
151
151
  #
152
152
  #
153
153
  #
@@ -225,14 +225,18 @@ module Aws::ControlTower
225
225
  # @!attribute [rw] control_identifier
226
226
  # The ARN of the control. Only **Strongly recommended** and
227
227
  # **Elective** controls are permitted, with the exception of the
228
- # **Region deny** control. For information on how to find the
229
- # `controlIdentifier`, see [the overview page][1].
228
+ # **landing zone Region deny** control. For information on how to find
229
+ # the `controlIdentifier`, see [the overview page][1].
230
230
  #
231
231
  #
232
232
  #
233
233
  # [1]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html
234
234
  # @return [String]
235
235
  #
236
+ # @!attribute [rw] parameters
237
+ # An array of `EnabledControlParameter` objects
238
+ # @return [Array<Types::EnabledControlParameter>]
239
+ #
236
240
  # @!attribute [rw] tags
237
241
  # Tags to be applied to the `EnabledControl` resource.
238
242
  # @return [Hash<String,String>]
@@ -250,6 +254,7 @@ module Aws::ControlTower
250
254
  #
251
255
  class EnableControlInput < Struct.new(
252
256
  :control_identifier,
257
+ :parameters,
253
258
  :tags,
254
259
  :target_identifier)
255
260
  SENSITIVE = []
@@ -293,6 +298,10 @@ module Aws::ControlTower
293
298
  # The drift status of the enabled control.
294
299
  # @return [Types::DriftStatusSummary]
295
300
  #
301
+ # @!attribute [rw] parameters
302
+ # Array of `EnabledControlParameter` objects.
303
+ # @return [Array<Types::EnabledControlParameterSummary>]
304
+ #
296
305
  # @!attribute [rw] status_summary
297
306
  # The deployment summary of the enabled control.
298
307
  # @return [Types::EnablementStatusSummary]
@@ -316,6 +325,7 @@ module Aws::ControlTower
316
325
  :arn,
317
326
  :control_identifier,
318
327
  :drift_status_summary,
328
+ :parameters,
319
329
  :status_summary,
320
330
  :target_identifier,
321
331
  :target_regions)
@@ -323,6 +333,48 @@ module Aws::ControlTower
323
333
  include Aws::Structure
324
334
  end
325
335
 
336
+ # A set of parameters that configure the behavior of the enabled
337
+ # control. A key/value pair, where `Key` is of type `String` and `Value`
338
+ # is of type `Document`.
339
+ #
340
+ # @!attribute [rw] key
341
+ # The key of a key/value pair. It is of type `string`.
342
+ # @return [String]
343
+ #
344
+ # @!attribute [rw] value
345
+ # The value of a key/value pair. It can be of type `array` `string`,
346
+ # `number`, `object`, or `boolean`.
347
+ # @return [Hash,Array,String,Numeric,Boolean]
348
+ #
349
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnabledControlParameter AWS API Documentation
350
+ #
351
+ class EnabledControlParameter < Struct.new(
352
+ :key,
353
+ :value)
354
+ SENSITIVE = []
355
+ include Aws::Structure
356
+ end
357
+
358
+ # Returns a summary of information about the parameters of an enabled
359
+ # control.
360
+ #
361
+ # @!attribute [rw] key
362
+ # The key of a key/value pair.
363
+ # @return [String]
364
+ #
365
+ # @!attribute [rw] value
366
+ # The value of a key/value pair.
367
+ # @return [Hash,Array,String,Numeric,Boolean]
368
+ #
369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnabledControlParameterSummary AWS API Documentation
370
+ #
371
+ class EnabledControlParameterSummary < Struct.new(
372
+ :key,
373
+ :value)
374
+ SENSITIVE = []
375
+ include Aws::Structure
376
+ end
377
+
326
378
  # Returns a summary of information about an enabled control.
327
379
  #
328
380
  # @!attribute [rw] arn
@@ -459,7 +511,7 @@ module Aws::ControlTower
459
511
  end
460
512
 
461
513
  # @!attribute [rw] operation_details
462
- # The landing zone operation details.
514
+ # Details about a landing zone operation.
463
515
  # @return [Types::LandingZoneOperationDetail]
464
516
  #
465
517
  # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetLandingZoneOperationOutput AWS API Documentation
@@ -482,7 +534,7 @@ module Aws::ControlTower
482
534
  include Aws::Structure
483
535
  end
484
536
 
485
- # Unexpected error during processing of request.
537
+ # An unexpected error occurred during processing of a request.
486
538
  #
487
539
  # @!attribute [rw] message
488
540
  # @return [String]
@@ -510,20 +562,12 @@ module Aws::ControlTower
510
562
  # @return [String]
511
563
  #
512
564
  # @!attribute [rw] manifest
513
- # The landing zone manifest.yaml text file that specifies the landing
514
- # zone configurations.
565
+ # The landing zone `manifest.yaml` text file that specifies the
566
+ # landing zone configurations.
515
567
  # @return [Hash,Array,String,Numeric,Boolean]
516
568
  #
517
569
  # @!attribute [rw] status
518
570
  # The landing zone deployment status.
519
- #
520
- # Valid values:
521
- #
522
- # * `ACTIVE`: The landing zone is actively deployed.
523
- #
524
- # * `PROCESSING`: The landing zone is processing deployment.
525
- #
526
- # * `FAILED`: The landing zone failed deployment.
527
571
  # @return [String]
528
572
  #
529
573
  # @!attribute [rw] version
@@ -595,8 +639,6 @@ module Aws::ControlTower
595
639
  # @return [Time]
596
640
  #
597
641
  # @!attribute [rw] status
598
- # The landing zone operation status.
599
- #
600
642
  # Valid values:
601
643
  #
602
644
  # * `SUCCEEDED`: The landing zone operation succeeded.
@@ -672,7 +714,7 @@ module Aws::ControlTower
672
714
  #
673
715
  # @!attribute [rw] next_token
674
716
  # Retrieves the next page of results. If the string is empty, the
675
- # current response is the end of the results.
717
+ # response is the end of the results.
676
718
  # @return [String]
677
719
  #
678
720
  # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListEnabledControlsOutput AWS API Documentation
@@ -685,7 +727,7 @@ module Aws::ControlTower
685
727
  end
686
728
 
687
729
  # @!attribute [rw] max_results
688
- # The maximum number of returned landing zone ARNs.
730
+ # The maximum number of returned landing zone ARNs, which is one.
689
731
  # @return [Integer]
690
732
  #
691
733
  # @!attribute [rw] next_token
@@ -708,7 +750,7 @@ module Aws::ControlTower
708
750
  #
709
751
  # @!attribute [rw] next_token
710
752
  # Retrieves the next page of results. If the string is empty, the
711
- # current response is the end of the results.
753
+ # response is the end of the results.
712
754
  # @return [String]
713
755
  #
714
756
  # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListLandingZonesOutput AWS API Documentation
@@ -782,8 +824,8 @@ module Aws::ControlTower
782
824
 
783
825
  # @!attribute [rw] operation_identifier
784
826
  # A unique identifier assigned to a `ResetLandingZone` operation. You
785
- # can use this identifier as an input of `GetLandingZoneOperation` to
786
- # check the operation's status.
827
+ # can use this identifier as an input parameter of
828
+ # `GetLandingZoneOperation` to check the operation's status.
787
829
  # @return [String]
788
830
  #
789
831
  # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ResetLandingZoneOutput AWS API Documentation
@@ -794,7 +836,7 @@ module Aws::ControlTower
794
836
  include Aws::Structure
795
837
  end
796
838
 
797
- # Request references a resource which does not exist.
839
+ # The request references a resource that does not exist.
798
840
  #
799
841
  # @!attribute [rw] message
800
842
  # @return [String]
@@ -807,8 +849,8 @@ module Aws::ControlTower
807
849
  include Aws::Structure
808
850
  end
809
851
 
810
- # Request would cause a service quota to be exceeded. The limit is 10
811
- # concurrent operations.
852
+ # The request would cause a service quota to be exceeded. The limit is
853
+ # 10 concurrent operations.
812
854
  #
813
855
  # @!attribute [rw] message
814
856
  # @return [String]
@@ -842,7 +884,7 @@ module Aws::ControlTower
842
884
  #
843
885
  class TagResourceOutput < Aws::EmptyStructure; end
844
886
 
845
- # Request was denied due to request throttling.
887
+ # The request was denied due to request throttling.
846
888
  #
847
889
  # @!attribute [rw] message
848
890
  # @return [String]
@@ -852,7 +894,7 @@ module Aws::ControlTower
852
894
  # @return [String]
853
895
  #
854
896
  # @!attribute [rw] retry_after_seconds
855
- # The number of seconds the caller should wait before retrying.
897
+ # The number of seconds to wait before retrying.
856
898
  # @return [Integer]
857
899
  #
858
900
  # @!attribute [rw] service_code
@@ -891,13 +933,43 @@ module Aws::ControlTower
891
933
  #
892
934
  class UntagResourceOutput < Aws::EmptyStructure; end
893
935
 
936
+ # @!attribute [rw] enabled_control_identifier
937
+ # The ARN of the enabled control that will be updated.
938
+ # @return [String]
939
+ #
940
+ # @!attribute [rw] parameters
941
+ # A key/value pair, where `Key` is of type `String` and `Value` is of
942
+ # type `Document`.
943
+ # @return [Array<Types::EnabledControlParameter>]
944
+ #
945
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UpdateEnabledControlInput AWS API Documentation
946
+ #
947
+ class UpdateEnabledControlInput < Struct.new(
948
+ :enabled_control_identifier,
949
+ :parameters)
950
+ SENSITIVE = []
951
+ include Aws::Structure
952
+ end
953
+
954
+ # @!attribute [rw] operation_identifier
955
+ # The operation identifier for this `UpdateEnabledControl` operation.
956
+ # @return [String]
957
+ #
958
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UpdateEnabledControlOutput AWS API Documentation
959
+ #
960
+ class UpdateEnabledControlOutput < Struct.new(
961
+ :operation_identifier)
962
+ SENSITIVE = []
963
+ include Aws::Structure
964
+ end
965
+
894
966
  # @!attribute [rw] landing_zone_identifier
895
967
  # The unique identifier of the landing zone.
896
968
  # @return [String]
897
969
  #
898
970
  # @!attribute [rw] manifest
899
- # The manifest.yaml file is a text file that describes your Amazon Web
900
- # Services resources. For examples, review [The manifest file][1]
971
+ # The `manifest.yaml` file is a text file that describes your Amazon
972
+ # Web Services resources. For examples, review [The manifest file][1].
901
973
  #
902
974
  #
903
975
  #
@@ -905,7 +977,7 @@ module Aws::ControlTower
905
977
  # @return [Hash,Array,String,Numeric,Boolean]
906
978
  #
907
979
  # @!attribute [rw] version
908
- # The landing zone version.
980
+ # The landing zone version, for example, 3.2.
909
981
  # @return [String]
910
982
  #
911
983
  # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UpdateLandingZoneInput AWS API Documentation
@@ -932,7 +1004,7 @@ module Aws::ControlTower
932
1004
  include Aws::Structure
933
1005
  end
934
1006
 
935
- # The input fails to satisfy the constraints specified by an Amazon Web
1007
+ # The input does not satisfy the constraints specified by an Amazon Web
936
1008
  # Services service.
937
1009
  #
938
1010
  # @!attribute [rw] message
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-controltower/customizations'
52
52
  # @!group service
53
53
  module Aws::ControlTower
54
54
 
55
- GEM_VERSION = '1.13.0'
55
+ GEM_VERSION = '1.14.0'
56
56
 
57
57
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-controltower
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.13.0
4
+ version: 1.14.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services