Class: Aws::ControlTower::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ControlTower::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb
Overview
An API client for ControlTower. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ControlTower::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_landing_zone(params = {}) ⇒ Types::CreateLandingZoneOutput
Creates a new landing zone.
-
#delete_landing_zone(params = {}) ⇒ Types::DeleteLandingZoneOutput
Decommissions a landing zone.
-
#disable_baseline(params = {}) ⇒ Types::DisableBaselineOutput
Disable an
EnabledBaseline
resource on the specified Target. -
#disable_control(params = {}) ⇒ Types::DisableControlOutput
This API call turns off a control.
-
#enable_baseline(params = {}) ⇒ Types::EnableBaselineOutput
Enable (apply) a
Baseline
to a Target. -
#enable_control(params = {}) ⇒ Types::EnableControlOutput
This API call activates a control.
-
#get_baseline(params = {}) ⇒ Types::GetBaselineOutput
Retrieve details about an existing
Baseline
resource by specifying its identifier. -
#get_baseline_operation(params = {}) ⇒ Types::GetBaselineOperationOutput
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs:
EnableBaseline
,DisableBaseline
,UpdateEnabledBaseline
,ResetEnabledBaseline
. -
#get_control_operation(params = {}) ⇒ Types::GetControlOperationOutput
Returns the status of a particular
EnableControl
orDisableControl
operation. -
#get_enabled_baseline(params = {}) ⇒ Types::GetEnabledBaselineOutput
Retrieve details of an
EnabledBaseline
resource by specifying its identifier. -
#get_enabled_control(params = {}) ⇒ Types::GetEnabledControlOutput
Retrieves details about an enabled control.
-
#get_landing_zone(params = {}) ⇒ Types::GetLandingZoneOutput
Returns details about the landing zone.
-
#get_landing_zone_operation(params = {}) ⇒ Types::GetLandingZoneOperationOutput
Returns the status of the specified landing zone operation.
-
#list_baselines(params = {}) ⇒ Types::ListBaselinesOutput
Returns a summary list of all available baselines.
-
#list_control_operations(params = {}) ⇒ Types::ListControlOperationsOutput
Provides a list of operations in progress or queued.
-
#list_enabled_baselines(params = {}) ⇒ Types::ListEnabledBaselinesOutput
Returns a list of summaries describing
EnabledBaseline
resources. -
#list_enabled_controls(params = {}) ⇒ Types::ListEnabledControlsOutput
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.
-
#list_landing_zones(params = {}) ⇒ Types::ListLandingZonesOutput
Returns the landing zone ARN for the landing zone deployed in your managed account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Returns a list of tags associated with the resource.
-
#reset_enabled_baseline(params = {}) ⇒ Types::ResetEnabledBaselineOutput
Re-enables an
EnabledBaseline
resource. -
#reset_landing_zone(params = {}) ⇒ Types::ResetLandingZoneOutput
This API call resets a landing zone.
-
#tag_resource(params = {}) ⇒ Struct
Applies tags to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
-
#update_enabled_baseline(params = {}) ⇒ Types::UpdateEnabledBaselineOutput
Updates an
EnabledBaseline
resource's applied parameters or version. -
#update_enabled_control(params = {}) ⇒ Types::UpdateEnabledControlOutput
Updates the configuration of an already enabled control.
-
#update_landing_zone(params = {}) ⇒ Types::UpdateLandingZoneOutput
This API call updates the landing zone.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#create_landing_zone(params = {}) ⇒ Types::CreateLandingZoneOutput
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.
465 466 467 468 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 465 def create_landing_zone(params = {}, = {}) req = build_request(:create_landing_zone, params) req.send_request() end |
#delete_landing_zone(params = {}) ⇒ Types::DeleteLandingZoneOutput
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.
495 496 497 498 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 495 def delete_landing_zone(params = {}, = {}) req = build_request(:delete_landing_zone, params) req.send_request() end |
#disable_baseline(params = {}) ⇒ Types::DisableBaselineOutput
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. For usage examples, see the Amazon Web
Services Control Tower User Guide .
532 533 534 535 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 532 def disable_baseline(params = {}, = {}) req = build_request(:disable_baseline, params) req.send_request() end |
#disable_control(params = {}) ⇒ Types::DisableControlOutput
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 Amazon Web Services Control Tower User Guide .
584 585 586 587 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 584 def disable_control(params = {}, = {}) req = build_request(:disable_control, params) req.send_request() end |
#enable_baseline(params = {}) ⇒ Types::EnableBaselineOutput
Enable (apply) a Baseline
to a Target. This API starts an
asynchronous operation to deploy resources specified by the Baseline
to the specified Target. For usage examples, see the Amazon Web
Services Control Tower User Guide .
647 648 649 650 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 647 def enable_baseline(params = {}, = {}) req = build_request(:enable_baseline, params) req.send_request() end |
#enable_control(params = {}) ⇒ Types::EnableControlOutput
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 created will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
719 720 721 722 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 719 def enable_control(params = {}, = {}) req = build_request(:enable_control, params) req.send_request() end |
#get_baseline(params = {}) ⇒ Types::GetBaselineOutput
Retrieve details about an existing Baseline
resource by specifying
its identifier. For usage examples, see the Amazon Web Services
Control Tower User Guide .
757 758 759 760 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 757 def get_baseline(params = {}, = {}) req = build_request(:get_baseline, params) req.send_request() end |
#get_baseline_operation(params = {}) ⇒ Types::GetBaselineOperationOutput
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. For usage examples, see the
Amazon Web Services Control Tower User Guide .
799 800 801 802 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 799 def get_baseline_operation(params = {}, = {}) req = build_request(:get_baseline_operation, params) req.send_request() end |
#get_control_operation(params = {}) ⇒ Types::GetControlOperationOutput
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
Amazon Web Services Control Tower User Guide .
843 844 845 846 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 843 def get_control_operation(params = {}, = {}) req = build_request(:get_control_operation, params) req.send_request() end |
#get_enabled_baseline(params = {}) ⇒ Types::GetEnabledBaselineOutput
Retrieve details of an EnabledBaseline
resource by specifying its
identifier.
880 881 882 883 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 880 def get_enabled_baseline(params = {}, = {}) req = build_request(:get_enabled_baseline, params) req.send_request() end |
#get_enabled_control(params = {}) ⇒ Types::GetEnabledControlOutput
Retrieves details about an enabled control. For usage examples, see the Amazon Web Services Control Tower User Guide .
922 923 924 925 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 922 def get_enabled_control(params = {}, = {}) req = build_request(:get_enabled_control, params) req.send_request() end |
#get_landing_zone(params = {}) ⇒ Types::GetLandingZoneOutput
Returns details about the landing zone. Displays a message in case of error.
955 956 957 958 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 955 def get_landing_zone(params = {}, = {}) req = build_request(:get_landing_zone, params) req.send_request() end |
#get_landing_zone_operation(params = {}) ⇒ Types::GetLandingZoneOperationOutput
Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.
988 989 990 991 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 988 def get_landing_zone_operation(params = {}, = {}) req = build_request(:get_landing_zone_operation, params) req.send_request() end |
#list_baselines(params = {}) ⇒ Types::ListBaselinesOutput
Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1032 1033 1034 1035 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1032 def list_baselines(params = {}, = {}) req = build_request(:list_baselines, params) req.send_request() end |
#list_control_operations(params = {}) ⇒ Types::ListControlOperationsOutput
Provides a list of operations in progress or queued.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1088 1089 1090 1091 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1088 def list_control_operations(params = {}, = {}) req = build_request(:list_control_operations, params) req.send_request() end |
#list_enabled_baselines(params = {}) ⇒ Types::ListEnabledBaselinesOutput
Returns a list of summaries describing EnabledBaseline
resources.
You can filter the list by the corresponding Baseline
or Target
of
the EnabledBaseline
resources. For usage examples, see the Amazon
Web Services Control Tower User Guide .
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1146 1147 1148 1149 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1146 def list_enabled_baselines(params = {}, = {}) req = build_request(:list_enabled_baselines, params) req.send_request() end |
#list_enabled_controls(params = {}) ⇒ Types::ListEnabledControlsOutput
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 .
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1214 1215 1216 1217 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1214 def list_enabled_controls(params = {}, = {}) req = build_request(:list_enabled_controls, params) req.send_request() end |
#list_landing_zones(params = {}) ⇒ Types::ListLandingZonesOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1256 1257 1258 1259 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1256 def list_landing_zones(params = {}, = {}) req = build_request(:list_landing_zones, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Returns a list of tags associated with the resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
1291 1292 1293 1294 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1291 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#reset_enabled_baseline(params = {}) ⇒ Types::ResetEnabledBaselineOutput
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. For usage examples, see the Amazon Web Services
Control Tower User Guide .
1327 1328 1329 1330 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1327 def reset_enabled_baseline(params = {}, = {}) req = build_request(:reset_enabled_baseline, params) req.send_request() end |
#reset_landing_zone(params = {}) ⇒ Types::ResetLandingZoneOutput
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.
1357 1358 1359 1360 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1357 def reset_landing_zone(params = {}, = {}) req = build_request(:reset_landing_zone, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Applies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
1390 1391 1392 1393 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1390 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
1421 1422 1423 1424 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1421 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_enabled_baseline(params = {}) ⇒ Types::UpdateEnabledBaselineOutput
Updates an EnabledBaseline
resource's applied parameters or
version. For usage examples, see the Amazon Web Services Control
Tower User Guide .
1470 1471 1472 1473 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1470 def update_enabled_baseline(params = {}, = {}) req = build_request(:update_enabled_baseline, params) req.send_request() end |
#update_enabled_control(params = {}) ⇒ Types::UpdateEnabledControlOutput
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
1528 1529 1530 1531 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1528 def update_enabled_control(params = {}, = {}) req = build_request(:update_enabled_control, params) req.send_request() end |
#update_landing_zone(params = {}) ⇒ Types::UpdateLandingZoneOutput
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.
1579 1580 1581 1582 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1579 def update_landing_zone(params = {}, = {}) req = build_request(:update_landing_zone, params) req.send_request() end |