aws-sdk-controltower 1.12.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 364d73ffc9e515a45806de599a150a080fa9bfb5b6145824b439cc783385e6f6
-  data.tar.gz: 43e15e9676f50e108378703502788745df33a189143bc3a55c7fdd18e0d5bc86
+  metadata.gz: 573d52fdb4d2e41257388f874ba6fbdcd130dfd04fbec74df7a95d5d2c1e19d7
+  data.tar.gz: 2f24b76751109439a2cee72646bdb8b98a07091d26ad09c3976f37de179ae3a1
 SHA512:
-  metadata.gz: 532f26dc1214d70849ee3d05d33cc0f1f810b9e787846fd40dee3b77b28cbdf425cc19353cf83f229f9408be0c0ceed46db4591a082b4deedb24a77d4bd880c0
-  data.tar.gz: ea295c3b4d8858f143cc37cc406776ed5954d080a215e1db42885f088a1148198dc233bab3227dcb42ee46c103140aab8d555541d11c09995d3be61b1f16d6f8
+  metadata.gz: 29ffd45b639cddbbf4ba47dd4041cc3bec4e8c2dbeed630650d0c90f4a8ec941d05bfb96fb4e986b2f8e7fd115930166ec06ebaab89cf4681ca7bc39ad19a5ee
+  data.tar.gz: a7eac3ddc681b61a3a608654012ab2da9dae7f73c52d793907a8ebce36e1be8d75bfed3cc0fd66c8dc487ca880b9a444cc7e2bd53aadcab522627139b7a129ff

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.14.0 (2023-11-27)
+------------------
+
+* 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.
+
+1.13.0 (2023-11-27)
+------------------
+
+* Feature - Add APIs to create and manage a landing zone.
+
 1.12.0 (2023-11-22)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.12.0
+1.14.0

data/lib/aws-sdk-controltower/client.rb

@@ -388,11 +388,94 @@ module Aws::ControlTower
 
     # @!group API Operations
 
+    # Creates a new landing zone. This API call starts an asynchronous
+    # operation that creates and configures a landing zone, based on the
+    # parameters specified in the manifest JSON file.
+    #
+    # @option params [required, Hash,Array,String,Numeric,Boolean] :manifest
+    #   The manifest.yaml file is a text file that describes your Amazon Web
+    #   Services resources. For examples, review [The manifest file][1].
+    #
+    #   Document type used to carry open content
+    #   (Hash,Array,String,Numeric,Boolean). A document type value is
+    #   serialized using the same format as its surroundings and requires no
+    #   additional encoding or escaping.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file
+    #
+    # @option params [Hash<String,String>] :tags
+    #   Tags to be applied to the landing zone.
+    #
+    # @option params [required, String] :version
+    #   The landing zone version, for example, 3.0.
+    #
+    # @return [Types::CreateLandingZoneOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateLandingZoneOutput#arn #arn} => String
+    #   * {Types::CreateLandingZoneOutput#operation_identifier #operation_identifier} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_landing_zone({
+    #     manifest: { # required
+    #     },
+    #     tags: {
+    #       "TagKey" => "TagValue",
+    #     },
+    #     version: "LandingZoneVersion", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.arn #=> String
+    #   resp.operation_identifier #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/CreateLandingZone AWS API Documentation
+    #
+    # @overload create_landing_zone(params = {})
+    # @param [Hash] params ({})
+    def create_landing_zone(params = {}, options = {})
+      req = build_request(:create_landing_zone, params)
+      req.send_request(options)
+    end
+
+    # Decommissions a landing zone. This API call starts an asynchronous
+    # operation that deletes Amazon Web Services Control Tower resources
+    # deployed in accounts managed by Amazon Web Services Control Tower.
+    #
+    # @option params [required, String] :landing_zone_identifier
+    #   The unique identifier of the landing zone.
+    #
+    # @return [Types::DeleteLandingZoneOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DeleteLandingZoneOutput#operation_identifier #operation_identifier} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_landing_zone({
+    #     landing_zone_identifier: "String", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.operation_identifier #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DeleteLandingZone AWS API Documentation
+    #
+    # @overload delete_landing_zone(params = {})
+    # @param [Hash] params ({})
+    def delete_landing_zone(params = {}, options = {})
+      req = build_request(:delete_landing_zone, params)
+      req.send_request(options)
+    end
+
     # This API call turns off a control. It starts an asynchronous operation
-    # that deletes AWS resources on the specified organizational unit and
-    # the accounts it contains. The resources will vary according to the
-    # control that you specify. For usage examples, see [ *the AWS Control
-    # Tower User Guide* ][1].
+    # that deletes Amazon Web Services resources on the specified
+    # organizational unit and the accounts it contains. The resources will
+    # vary according to the control that you specify. For usage examples,
+    # see [ *the Amazon Web Services Control Tower User Guide* ][1].
     #
     #
     #
@@ -400,9 +483,9 @@ module Aws::ControlTower
     #
     # @option params [required, String] :control_identifier
     #   The ARN of the control. Only **Strongly recommended** and **Elective**
-    #   controls are permitted, with the exception of the **Region deny**
-    #   control. For information on how to find the `controlIdentifier`, see
-    #   [the overview page][1].
+    #   controls are permitted, with the exception of the **landing zone
+    #   Region deny** control. For information on how to find the
+    #   `controlIdentifier`, see [the overview page][1].
     #
     #
     #
@@ -441,10 +524,11 @@ module Aws::ControlTower
     end
 
     # This API call activates a control. It starts an asynchronous operation
-    # that creates AWS resources on the specified organizational unit and
-    # the accounts it contains. The resources created will vary according to
-    # the control that you specify. For usage examples, see [ *the AWS
-    # Control Tower User Guide* ][1].
+    # that creates Amazon Web Services resources on the specified
+    # organizational unit and the accounts it contains. The resources
+    # created will vary according to the control that you specify. For usage
+    # examples, see [ *the Amazon Web Services Control Tower User Guide*
+    # ][1].
     #
     #
     #
@@ -452,14 +536,17 @@ module Aws::ControlTower
     #
     # @option params [required, String] :control_identifier
     #   The ARN of the control. Only **Strongly recommended** and **Elective**
-    #   controls are permitted, with the exception of the **Region deny**
-    #   control. For information on how to find the `controlIdentifier`, see
-    #   [the overview page][1].
+    #   controls are permitted, with the exception of the **landing zone
+    #   Region deny** control. For information on how to find the
+    #   `controlIdentifier`, see [the overview page][1].
     #
     #
     #
     #   [1]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html
     #
+    # @option params [Array<Types::EnabledControlParameter>] :parameters
+    #   An array of `EnabledControlParameter` objects
+    #
     # @option params [Hash<String,String>] :tags
     #   Tags to be applied to the `EnabledControl` resource.
     #
@@ -480,6 +567,13 @@ module Aws::ControlTower
     #
     #   resp = client.enable_control({
     #     control_identifier: "ControlIdentifier", # required
+    #     parameters: [
+    #       {
+    #         key: "String", # required
+    #         value: { # required
+    #         },
+    #       },
+    #     ],
     #     tags: {
     #       "TagKey" => "TagValue",
     #     },
@@ -503,7 +597,7 @@ module Aws::ControlTower
     # Returns the status of a particular `EnableControl` or `DisableControl`
     # operation. Displays a message in case of error. Details for an
     # operation are available for 90 days. For usage examples, see [ *the
-    # AWS Control Tower User Guide* ][1].
+    # Amazon Web Services Control Tower User Guide* ][1].
     #
     #
     #
@@ -526,7 +620,7 @@ module Aws::ControlTower
     # @example Response structure
     #
     #   resp.control_operation.end_time #=> Time
-    #   resp.control_operation.operation_type #=> String, one of "ENABLE_CONTROL", "DISABLE_CONTROL"
+    #   resp.control_operation.operation_type #=> String, one of "ENABLE_CONTROL", "DISABLE_CONTROL", "UPDATE_ENABLED_CONTROL"
     #   resp.control_operation.start_time #=> Time
     #   resp.control_operation.status #=> String, one of "SUCCEEDED", "FAILED", "IN_PROGRESS"
     #   resp.control_operation.status_message #=> String
@@ -541,7 +635,7 @@ module Aws::ControlTower
     end
 
     # Retrieves details about an enabled control. For usage examples, see [
-    # *the AWS Control Tower User Guide* ][1].
+    # *the Amazon Web Services Control Tower User Guide* ][1].
     #
     #
     #
@@ -565,6 +659,8 @@ module Aws::ControlTower
     #   resp.enabled_control_details.arn #=> String
     #   resp.enabled_control_details.control_identifier #=> String
     #   resp.enabled_control_details.drift_status_summary.drift_status #=> String, one of "DRIFTED", "IN_SYNC", "NOT_CHECKING", "UNKNOWN"
+    #   resp.enabled_control_details.parameters #=> Array
+    #   resp.enabled_control_details.parameters[0].key #=> String
     #   resp.enabled_control_details.status_summary.last_operation_identifier #=> String
     #   resp.enabled_control_details.status_summary.status #=> String, one of "SUCCEEDED", "FAILED", "UNDER_CHANGE"
     #   resp.enabled_control_details.target_identifier #=> String
@@ -580,9 +676,76 @@ module Aws::ControlTower
       req.send_request(options)
     end
 
-    # Lists the controls enabled by AWS Control Tower on the specified
-    # organizational unit and the accounts it contains. For usage examples,
-    # see [ *the AWS Control Tower User Guide* ][1].
+    # Returns details about the landing zone. Displays a message in case of
+    # error.
+    #
+    # @option params [required, String] :landing_zone_identifier
+    #   The unique identifier of the landing zone.
+    #
+    # @return [Types::GetLandingZoneOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetLandingZoneOutput#landing_zone #landing_zone} => Types::LandingZoneDetail
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_landing_zone({
+    #     landing_zone_identifier: "String", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.landing_zone.arn #=> String
+    #   resp.landing_zone.drift_status.status #=> String, one of "DRIFTED", "IN_SYNC"
+    #   resp.landing_zone.latest_available_version #=> String
+    #   resp.landing_zone.status #=> String, one of "ACTIVE", "PROCESSING", "FAILED"
+    #   resp.landing_zone.version #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetLandingZone AWS API Documentation
+    #
+    # @overload get_landing_zone(params = {})
+    # @param [Hash] params ({})
+    def get_landing_zone(params = {}, options = {})
+      req = build_request(:get_landing_zone, params)
+      req.send_request(options)
+    end
+
+    # Returns the status of the specified landing zone operation. Details
+    # for an operation are available for 60 days.
+    #
+    # @option params [required, String] :operation_identifier
+    #   A unique identifier assigned to a landing zone operation.
+    #
+    # @return [Types::GetLandingZoneOperationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetLandingZoneOperationOutput#operation_details #operation_details} => Types::LandingZoneOperationDetail
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_landing_zone_operation({
+    #     operation_identifier: "OperationIdentifier", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.operation_details.end_time #=> Time
+    #   resp.operation_details.operation_type #=> String, one of "DELETE", "CREATE", "UPDATE", "RESET"
+    #   resp.operation_details.start_time #=> Time
+    #   resp.operation_details.status #=> String, one of "SUCCEEDED", "FAILED", "IN_PROGRESS"
+    #   resp.operation_details.status_message #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetLandingZoneOperation AWS API Documentation
+    #
+    # @overload get_landing_zone_operation(params = {})
+    # @param [Hash] params ({})
+    def get_landing_zone_operation(params = {}, options = {})
+      req = build_request(:get_landing_zone_operation, params)
+      req.send_request(options)
+    end
+
+    # Lists the controls enabled by Amazon Web Services Control Tower on the
+    # specified organizational unit and the accounts it contains. For usage
+    # examples, see [ *the Amazon Web Services Control Tower User Guide*
+    # ][1].
     #
     #
     #
@@ -638,8 +801,51 @@ module Aws::ControlTower
       req.send_request(options)
     end
 
+    # Returns the landing zone ARN for the landing zone deployed in your
+    # managed account. This API also creates an ARN for existing accounts
+    # that do not yet have a landing zone ARN.
+    #
+    # Returns one landing zone ARN.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of returned landing zone ARNs, which is one.
+    #
+    # @option params [String] :next_token
+    #   The token to continue the list from a previous API call with the same
+    #   parameters.
+    #
+    # @return [Types::ListLandingZonesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListLandingZonesOutput#landing_zones #landing_zones} => Array&lt;Types::LandingZoneSummary&gt;
+    #   * {Types::ListLandingZonesOutput#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_landing_zones({
+    #     max_results: 1,
+    #     next_token: "String",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.landing_zones #=> Array
+    #   resp.landing_zones[0].arn #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListLandingZones AWS API Documentation
+    #
+    # @overload list_landing_zones(params = {})
+    # @param [Hash] params ({})
+    def list_landing_zones(params = {}, options = {})
+      req = build_request(:list_landing_zones, params)
+      req.send_request(options)
+    end
+
     # Returns a list of tags associated with the resource. For usage
-    # examples, see [ *the AWS Control Tower User Guide* ][1].
+    # examples, see [ *the Amazon Web Services Control Tower User Guide*
+    # ][1].
     #
     #
     #
@@ -672,8 +878,38 @@ module Aws::ControlTower
       req.send_request(options)
     end
 
-    # Applies tags to a resource. For usage examples, see [ *the AWS Control
-    # Tower User Guide* ][1].
+    # This API call resets a landing zone. It starts an asynchronous
+    # operation that resets the landing zone to the parameters specified in
+    # its original configuration.
+    #
+    # @option params [required, String] :landing_zone_identifier
+    #   The unique identifier of the landing zone.
+    #
+    # @return [Types::ResetLandingZoneOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ResetLandingZoneOutput#operation_identifier #operation_identifier} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.reset_landing_zone({
+    #     landing_zone_identifier: "String", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.operation_identifier #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ResetLandingZone AWS API Documentation
+    #
+    # @overload reset_landing_zone(params = {})
+    # @param [Hash] params ({})
+    def reset_landing_zone(params = {}, options = {})
+      req = build_request(:reset_landing_zone, params)
+      req.send_request(options)
+    end
+
+    # Applies tags to a resource. For usage examples, see [ *the Amazon Web
+    # Services Control Tower User Guide* ][1].
     #
     #
     #
@@ -705,8 +941,8 @@ module Aws::ControlTower
       req.send_request(options)
     end
 
-    # Removes tags from a resource. For usage examples, see [ *the AWS
-    # Control Tower User Guide* ][1].
+    # Removes tags from a resource. For usage examples, see [ *the Amazon
+    # Web Services Control Tower User Guide* ][1].
     #
     #
     #
@@ -736,6 +972,114 @@ module Aws::ControlTower
       req.send_request(options)
     end
 
+    # Updates the configuration of an already enabled control.
+    #
+    # If the enabled control shows an `EnablementStatus` of SUCCEEDED,
+    # supply parameters that are different from the currently configured
+    # parameters. Otherwise, Amazon Web Services Control Tower will not
+    # accept the request.
+    #
+    # If the enabled control shows an `EnablementStatus` of FAILED, Amazon
+    # Web Services Control Tower will update the control to match any valid
+    # parameters that you supply.
+    #
+    # If the `DriftSummary` status for the control shows as DRIFTED, you
+    # cannot call this API. Instead, you can update the control by calling
+    # `DisableControl` and again calling `EnableControl`, or you can run an
+    # extending governance operation. For usage examples, see [ *the Amazon
+    # Web Services Control Tower User Guide* ][1]
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html
+    #
+    # @option params [required, String] :enabled_control_identifier
+    #   The ARN of the enabled control that will be updated.
+    #
+    # @option params [required, Array<Types::EnabledControlParameter>] :parameters
+    #   A key/value pair, where `Key` is of type `String` and `Value` is of
+    #   type `Document`.
+    #
+    # @return [Types::UpdateEnabledControlOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdateEnabledControlOutput#operation_identifier #operation_identifier} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_enabled_control({
+    #     enabled_control_identifier: "Arn", # required
+    #     parameters: [ # required
+    #       {
+    #         key: "String", # required
+    #         value: { # required
+    #         },
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.operation_identifier #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UpdateEnabledControl AWS API Documentation
+    #
+    # @overload update_enabled_control(params = {})
+    # @param [Hash] params ({})
+    def update_enabled_control(params = {}, options = {})
+      req = build_request(:update_enabled_control, params)
+      req.send_request(options)
+    end
+
+    # This API call updates the landing zone. It starts an asynchronous
+    # operation that updates the landing zone based on the new landing zone
+    # version, or on the changed parameters specified in the updated
+    # manifest file.
+    #
+    # @option params [required, String] :landing_zone_identifier
+    #   The unique identifier of the landing zone.
+    #
+    # @option params [required, Hash,Array,String,Numeric,Boolean] :manifest
+    #   The `manifest.yaml` file is a text file that describes your Amazon Web
+    #   Services resources. For examples, review [The manifest file][1].
+    #
+    #   Document type used to carry open content
+    #   (Hash,Array,String,Numeric,Boolean). A document type value is
+    #   serialized using the same format as its surroundings and requires no
+    #   additional encoding or escaping.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file
+    #
+    # @option params [required, String] :version
+    #   The landing zone version, for example, 3.2.
+    #
+    # @return [Types::UpdateLandingZoneOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdateLandingZoneOutput#operation_identifier #operation_identifier} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_landing_zone({
+    #     landing_zone_identifier: "String", # required
+    #     manifest: { # required
+    #     },
+    #     version: "LandingZoneVersion", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.operation_identifier #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UpdateLandingZone AWS API Documentation
+    #
+    # @overload update_landing_zone(params = {})
+    # @param [Hash] params ({})
+    def update_landing_zone(params = {}, options = {})
+      req = build_request(:update_landing_zone, params)
+      req.send_request(options)
+    end
+
     # @!endgroup
 
     # @param params ({})
@@ -749,7 +1093,7 @@ module Aws::ControlTower
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-controltower'
-      context[:gem_version] = '1.12.0'
+      context[:gem_version] = '1.14.0'
       Seahorse::Client::Request.new(handlers, context)
     end