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_zone_operations(params = {}) ⇒ Types::ListLandingZoneOperationsOutput
Lists all landing zone operations from the past 90 days.
-
#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.
444 445 446 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 444 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.
499 500 501 502 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 499 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.
529 530 531 532 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 529 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 .
566 567 568 569 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 566 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 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 Controls Reference Guide .
618 619 620 621 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 618 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 .
681 682 683 684 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 681 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 Controls Reference Guide .
752 753 754 755 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 752 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 .
790 791 792 793 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 790 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 .
832 833 834 835 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 832 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
Controls Reference Guide .
876 877 878 879 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 876 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.
913 914 915 916 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 913 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 Controls Reference Guide .
955 956 957 958 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 955 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.
988 989 990 991 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 988 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.
1022 1023 1024 1025 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1022 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.
1066 1067 1068 1069 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1066 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. For usage examples, see ListControlOperation examples.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1127 1128 1129 1130 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1127 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.
1185 1186 1187 1188 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1185 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 Controls Reference Guide .
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1252 1253 1254 1255 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1252 def list_enabled_controls(params = {}, = {}) req = build_request(:list_enabled_controls, params) req.send_request() end |
#list_landing_zone_operations(params = {}) ⇒ Types::ListLandingZoneOperationsOutput
Lists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1301 1302 1303 1304 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1301 def list_landing_zone_operations(params = {}, = {}) req = build_request(:list_landing_zone_operations, 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.
1343 1344 1345 1346 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1343 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 Controls Reference Guide .
1377 1378 1379 1380 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1377 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 .
1413 1414 1415 1416 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1413 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 the original configuration, which you specified in the manifest file. Nothing in the manifest file's original landing zone configuration is changed during the reset process, by default. This API is not the same as a rollback of a landing zone version, which is not a supported operation.
1447 1448 1449 1450 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1447 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 Controls Reference Guide .
1480 1481 1482 1483 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1480 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 Controls Reference Guide .
1511 1512 1513 1514 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1511 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 .
1560 1561 1562 1563 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1560 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 updates 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
Controls Reference Guide .
1618 1619 1620 1621 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1618 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.
1671 1672 1673 1674 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1671 def update_landing_zone(params = {}, = {}) req = build_request(:update_landing_zone, params) req.send_request() end |