aws-sdk-controltower 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 656afaf8c5c144be8d64e745b21bde53176c5a31d4cb5fdc86f1adfd0d07a54e
-  data.tar.gz: ac3426716f8713846010e49d090e4d9e05759dfac54a373299888db86f138d25
+  metadata.gz: 7b8b94f2824024c02292d30f1e2eb564a14762985403603c01d3d99c96a13146
+  data.tar.gz: a66ae665b98bbd27624208db4b5db45065b58c93a0ccbf3172eb6444b356f9bb
 SHA512:
-  metadata.gz: 984feebc5038acb05c96dfd17291a828c99c5d0b9254fe9b60caa0a7b433a46a96e2c6b688347dc29bc8ce26a395cf3adeacf7be157336ef4b32b39013b5590c
-  data.tar.gz: adc2e84fea6f2c19069c975f8f142252bfbe4051b59b84daa0f068292db5727d20434116be975f530c68d8464b81fd941f77fb4428e4c17898fc9775d3911e53
+  metadata.gz: 0f1a9cf26f7bc7570ea6bd0fce0697e4419498fa0c62d7d851cb64f5794b41417d867f1376cee1ed573d869971d1bead2cd42950cd99835d84fbbe6515f99249
+  data.tar.gz: 6380f2a84b6badc6be00ea6f88f2c0a480d94f78aec1f13b3259b3c61fd441af3245768269ecad65574e81dfa5a5c8952a3899bb37ab9ab932109d8e03bc2572

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.18.0 (2024-02-14)
+------------------
+
+* Feature - Adds support for new Baseline and EnabledBaseline APIs for automating multi-account governance.
+
 1.17.0 (2024-01-26)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.17.0
+1.18.0

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

@@ -393,9 +393,8 @@ module Aws::ControlTower
     # parameters specified in the manifest JSON file.
     #
     # @option params [required, Hash,Array,String,Numeric,Boolean] :manifest
-    #   The manifest JSON file is a text file that describes your Amazon Web
-    #   Services resources. For examples, review [Launch your landing
-    #   zone][1].
+    #   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
@@ -404,7 +403,7 @@ module Aws::ControlTower
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch
+    #   [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.
@@ -472,11 +471,43 @@ module Aws::ControlTower
       req.send_request(options)
     end
 
+    # Disable an `EnabledBaseline` resource on the specified Target. This
+    # API starts an asynchronous operation to remove all resources deployed
+    # as part of the baseline enablement. The resource will vary depending
+    # on the enabled baseline.
+    #
+    # @option params [required, String] :enabled_baseline_identifier
+    #   Identifier of the `EnabledBaseline` resource to be deactivated, in ARN
+    #   format.
+    #
+    # @return [Types::DisableBaselineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DisableBaselineOutput#operation_identifier #operation_identifier} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.disable_baseline({
+    #     enabled_baseline_identifier: "Arn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.operation_identifier #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DisableBaseline AWS API Documentation
+    #
+    # @overload disable_baseline(params = {})
+    # @param [Hash] params ({})
+    def disable_baseline(params = {}, options = {})
+      req = build_request(:disable_baseline, params)
+      req.send_request(options)
+    end
+
     # This API call turns off a control. It starts an asynchronous operation
-    # 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].
+    # 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 Amazon Web
+    # Services Control Tower User Guide* ][1].
     #
     #
     #
@@ -484,9 +515,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 **landing zone
-    #   Region deny** control. For information on how to find the
-    #   `controlIdentifier`, see [the overview page][1].
+    #   controls are permitted, with the exception of the **Region deny**
+    #   control. For information on how to find the `controlIdentifier`, see
+    #   [the overview page][1].
     #
     #
     #
@@ -524,6 +555,64 @@ module Aws::ControlTower
       req.send_request(options)
     end
 
+    # Enable (apply) a `Baseline` to a Target. This API starts an
+    # asynchronous operation to deploy resources specified by the `Baseline`
+    # to the specified Target.
+    #
+    # @option params [required, String] :baseline_identifier
+    #   The ARN of the baseline to be enabled.
+    #
+    # @option params [required, String] :baseline_version
+    #   The specific version to be enabled of the specified baseline.
+    #
+    # @option params [Array<Types::EnabledBaselineParameter>] :parameters
+    #   A list of `key-value` objects that specify enablement parameters,
+    #   where `key` is a string and `value` is a document of any type.
+    #
+    # @option params [Hash<String,String>] :tags
+    #   Tags associated with input to `EnableBaseline`.
+    #
+    # @option params [required, String] :target_identifier
+    #   The ARN of the target on which the baseline will be enabled. Only OUs
+    #   are supported as targets.
+    #
+    # @return [Types::EnableBaselineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::EnableBaselineOutput#arn #arn} => String
+    #   * {Types::EnableBaselineOutput#operation_identifier #operation_identifier} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.enable_baseline({
+    #     baseline_identifier: "Arn", # required
+    #     baseline_version: "BaselineVersion", # required
+    #     parameters: [
+    #       {
+    #         key: "String", # required
+    #         value: { # required
+    #         },
+    #       },
+    #     ],
+    #     tags: {
+    #       "TagKey" => "TagValue",
+    #     },
+    #     target_identifier: "Arn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.arn #=> String
+    #   resp.operation_identifier #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnableBaseline AWS API Documentation
+    #
+    # @overload enable_baseline(params = {})
+    # @param [Hash] params ({})
+    def enable_baseline(params = {}, options = {})
+      req = build_request(:enable_baseline, params)
+      req.send_request(options)
+    end
+
     # This API call activates a control. It starts an asynchronous operation
     # that creates Amazon Web Services resources on the specified
     # organizational unit and the accounts it contains. The resources
@@ -537,16 +626,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 **landing zone
-    #   Region deny** control. For information on how to find the
-    #   `controlIdentifier`, see [the overview page][1].
+    #   controls are permitted, with the exception of the **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
+    #   A list of input parameter values, which are specified to configure the
+    #   control when you enable it.
     #
     # @option params [Hash<String,String>] :tags
     #   Tags to be applied to the `EnabledControl` resource.
@@ -595,6 +685,76 @@ module Aws::ControlTower
       req.send_request(options)
     end
 
+    # Retrieve details about an existing `Baseline` resource by specifying
+    # its identifier.
+    #
+    # @option params [required, String] :baseline_identifier
+    #   The ARN of the `Baseline` resource to be retrieved.
+    #
+    # @return [Types::GetBaselineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetBaselineOutput#arn #arn} => String
+    #   * {Types::GetBaselineOutput#description #description} => String
+    #   * {Types::GetBaselineOutput#name #name} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_baseline({
+    #     baseline_identifier: "BaselineArn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.arn #=> String
+    #   resp.description #=> String
+    #   resp.name #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetBaseline AWS API Documentation
+    #
+    # @overload get_baseline(params = {})
+    # @param [Hash] params ({})
+    def get_baseline(params = {}, options = {})
+      req = build_request(:get_baseline, params)
+      req.send_request(options)
+    end
+
+    # Returns the details of an asynchronous baseline operation, as
+    # initiated by any of these APIs: `EnableBaseline`, `DisableBaseline`,
+    # `UpdateEnabledBaseline`, `ResetEnabledBaseline`. A status message is
+    # displayed in case of operation failure.
+    #
+    # @option params [required, String] :operation_identifier
+    #   The operation ID returned from mutating asynchronous APIs (Enable,
+    #   Disable, Update, Reset).
+    #
+    # @return [Types::GetBaselineOperationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetBaselineOperationOutput#baseline_operation #baseline_operation} => Types::BaselineOperation
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_baseline_operation({
+    #     operation_identifier: "OperationIdentifier", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.baseline_operation.end_time #=> Time
+    #   resp.baseline_operation.operation_identifier #=> String
+    #   resp.baseline_operation.operation_type #=> String, one of "ENABLE_BASELINE", "DISABLE_BASELINE", "UPDATE_ENABLED_BASELINE", "RESET_ENABLED_BASELINE"
+    #   resp.baseline_operation.start_time #=> Time
+    #   resp.baseline_operation.status #=> String, one of "SUCCEEDED", "FAILED", "IN_PROGRESS"
+    #   resp.baseline_operation.status_message #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetBaselineOperation AWS API Documentation
+    #
+    # @overload get_baseline_operation(params = {})
+    # @param [Hash] params ({})
+    def get_baseline_operation(params = {}, options = {})
+      req = build_request(:get_baseline_operation, params)
+      req.send_request(options)
+    end
+
     # 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
@@ -635,6 +795,43 @@ module Aws::ControlTower
       req.send_request(options)
     end
 
+    # Retrieve details of an `EnabledBaseline` resource by specifying its
+    # identifier.
+    #
+    # @option params [required, String] :enabled_baseline_identifier
+    #   Identifier of the `EnabledBaseline` resource to be retrieved, in ARN
+    #   format.
+    #
+    # @return [Types::GetEnabledBaselineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetEnabledBaselineOutput#enabled_baseline_details #enabled_baseline_details} => Types::EnabledBaselineDetails
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_enabled_baseline({
+    #     enabled_baseline_identifier: "Arn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.enabled_baseline_details.arn #=> String
+    #   resp.enabled_baseline_details.baseline_identifier #=> String
+    #   resp.enabled_baseline_details.baseline_version #=> String
+    #   resp.enabled_baseline_details.parameters #=> Array
+    #   resp.enabled_baseline_details.parameters[0].key #=> String
+    #   resp.enabled_baseline_details.status_summary.last_operation_identifier #=> String
+    #   resp.enabled_baseline_details.status_summary.status #=> String, one of "SUCCEEDED", "FAILED", "UNDER_CHANGE"
+    #   resp.enabled_baseline_details.target_identifier #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetEnabledBaseline AWS API Documentation
+    #
+    # @overload get_enabled_baseline(params = {})
+    # @param [Hash] params ({})
+    def get_enabled_baseline(params = {}, options = {})
+      req = build_request(:get_enabled_baseline, params)
+      req.send_request(options)
+    end
+
     # Retrieves details about an enabled control. For usage examples, see [
     # *the Amazon Web Services Control Tower User Guide* ][1].
     #
@@ -743,6 +940,98 @@ module Aws::ControlTower
       req.send_request(options)
     end
 
+    # Returns a summary list of all available baselines.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to be shown.
+    #
+    # @option params [String] :next_token
+    #   A pagination token.
+    #
+    # @return [Types::ListBaselinesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListBaselinesOutput#baselines #baselines} => Array&lt;Types::BaselineSummary&gt;
+    #   * {Types::ListBaselinesOutput#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_baselines({
+    #     max_results: 1,
+    #     next_token: "String",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.baselines #=> Array
+    #   resp.baselines[0].arn #=> String
+    #   resp.baselines[0].description #=> String
+    #   resp.baselines[0].name #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListBaselines AWS API Documentation
+    #
+    # @overload list_baselines(params = {})
+    # @param [Hash] params ({})
+    def list_baselines(params = {}, options = {})
+      req = build_request(:list_baselines, params)
+      req.send_request(options)
+    end
+
+    # Returns a list of summaries describing `EnabledBaseline` resources.
+    # You can filter the list by the corresponding `Baseline` or `Target` of
+    # the `EnabledBaseline` resources.
+    #
+    # @option params [Types::EnabledBaselineFilter] :filter
+    #   A filter applied on the `ListEnabledBaseline` operation. Allowed
+    #   filters are `baselineIdentifiers` and `targetIdentifiers`. The filter
+    #   can be applied for either, or both.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to be shown.
+    #
+    # @option params [String] :next_token
+    #   A pagination token.
+    #
+    # @return [Types::ListEnabledBaselinesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListEnabledBaselinesOutput#enabled_baselines #enabled_baselines} => Array&lt;Types::EnabledBaselineSummary&gt;
+    #   * {Types::ListEnabledBaselinesOutput#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_enabled_baselines({
+    #     filter: {
+    #       baseline_identifiers: ["Arn"],
+    #       target_identifiers: ["Arn"],
+    #     },
+    #     max_results: 1,
+    #     next_token: "ListEnabledBaselinesNextToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.enabled_baselines #=> Array
+    #   resp.enabled_baselines[0].arn #=> String
+    #   resp.enabled_baselines[0].baseline_identifier #=> String
+    #   resp.enabled_baselines[0].baseline_version #=> String
+    #   resp.enabled_baselines[0].status_summary.last_operation_identifier #=> String
+    #   resp.enabled_baselines[0].status_summary.status #=> String, one of "SUCCEEDED", "FAILED", "UNDER_CHANGE"
+    #   resp.enabled_baselines[0].target_identifier #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListEnabledBaselines AWS API Documentation
+    #
+    # @overload list_enabled_baselines(params = {})
+    # @param [Hash] params ({})
+    def list_enabled_baselines(params = {}, options = {})
+      req = build_request(:list_enabled_baselines, 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*
@@ -879,6 +1168,37 @@ module Aws::ControlTower
       req.send_request(options)
     end
 
+    # Re-enables an `EnabledBaseline` resource. For example, this API can
+    # re-apply the existing `Baseline` after a new member account is moved
+    # to the target OU.
+    #
+    # @option params [required, String] :enabled_baseline_identifier
+    #   Specifies the ID of the `EnabledBaseline` resource to be re-enabled,
+    #   in ARN format.
+    #
+    # @return [Types::ResetEnabledBaselineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ResetEnabledBaselineOutput#operation_identifier #operation_identifier} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.reset_enabled_baseline({
+    #     enabled_baseline_identifier: "Arn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.operation_identifier #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ResetEnabledBaseline AWS API Documentation
+    #
+    # @overload reset_enabled_baseline(params = {})
+    # @param [Hash] params ({})
+    def reset_enabled_baseline(params = {}, options = {})
+      req = build_request(:reset_enabled_baseline, params)
+      req.send_request(options)
+    end
+
     # 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.
@@ -973,6 +1293,50 @@ module Aws::ControlTower
       req.send_request(options)
     end
 
+    # Updates an `EnabledBaseline` resource's applied parameters or
+    # version.
+    #
+    # @option params [required, String] :baseline_version
+    #   Specifies the new `Baseline` version, to which the `EnabledBaseline`
+    #   should be updated.
+    #
+    # @option params [required, String] :enabled_baseline_identifier
+    #   Specifies the `EnabledBaseline` resource to be updated.
+    #
+    # @option params [Array<Types::EnabledBaselineParameter>] :parameters
+    #   Parameters to apply when making an update.
+    #
+    # @return [Types::UpdateEnabledBaselineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdateEnabledBaselineOutput#operation_identifier #operation_identifier} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_enabled_baseline({
+    #     baseline_version: "BaselineVersion", # required
+    #     enabled_baseline_identifier: "Arn", # required
+    #     parameters: [
+    #       {
+    #         key: "String", # required
+    #         value: { # required
+    #         },
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.operation_identifier #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UpdateEnabledBaseline AWS API Documentation
+    #
+    # @overload update_enabled_baseline(params = {})
+    # @param [Hash] params ({})
+    def update_enabled_baseline(params = {}, options = {})
+      req = build_request(:update_enabled_baseline, params)
+      req.send_request(options)
+    end
+
     # Updates the configuration of an already enabled control.
     #
     # If the enabled control shows an `EnablementStatus` of SUCCEEDED,
@@ -1040,9 +1404,8 @@ module Aws::ControlTower
     #   The unique identifier of the landing zone.
     #
     # @option params [required, Hash,Array,String,Numeric,Boolean] :manifest
-    #   The manifest JSON file is a text file that describes your Amazon Web
-    #   Services resources. For examples, review [Launch your landing
-    #   zone][1].
+    #   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
@@ -1051,7 +1414,7 @@ module Aws::ControlTower
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch
+    #   [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.
@@ -1095,7 +1458,7 @@ module Aws::ControlTower
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-controltower'
-      context[:gem_version] = '1.17.0'
+      context[:gem_version] = '1.18.0'
       Seahorse::Client::Request.new(handlers, context)
     end