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_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.
464 465 466 467 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 464 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.
494 495 496 497 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 494 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.
526 527 528 529 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 526 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 .
578 579 580 581 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 578 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.
636 637 638 639 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 636 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 .
708 709 710 711 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 708 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.
741 742 743 744 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 741 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.
778 779 780 781 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 778 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 .
818 819 820 821 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 818 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.
855 856 857 858 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 855 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 .
897 898 899 900 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 897 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.
930 931 932 933 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 930 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 60 days.
963 964 965 966 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 963 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1002 1003 1004 1005 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1002 def list_baselines(params = {}, = {}) req = build_request(:list_baselines, 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1055 1056 1057 1058 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1055 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.
1114 1115 1116 1117 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1114 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.
1156 1157 1158 1159 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1156 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 .
1191 1192 1193 1194 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1191 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.
1222 1223 1224 1225 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1222 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.
1252 1253 1254 1255 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1252 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 .
1285 1286 1287 1288 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1285 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 .
1316 1317 1318 1319 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1316 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.
1360 1361 1362 1363 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1360 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
1418 1419 1420 1421 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1418 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.
1468 1469 1470 1471 |
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1468 def update_landing_zone(params = {}, = {}) req = build_request(:update_landing_zone, params) req.send_request() end |