Class: Aws::ControlTower::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::ControlTower::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::ControlTower::EndpointParameters

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



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.

Examples:

Request syntax with placeholder values


resp = client.create_landing_zone({
  manifest: { # required
  },
  tags: {
    "TagKey" => "TagValue",
  },
  version: "LandingZoneVersion", # required
})

Response structure


resp.arn #=> String
resp.operation_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :manifest (required, Hash, Array, String, Numeric, Boolean) —

    The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.

    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.

  • :tags (Hash<String,String>) —

    Tags to be applied to the landing zone.

  • :version (required, String) —

    The landing zone version, for example, 3.0.

Returns:

See Also:



465
466
467
468
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 465

def create_landing_zone(params = {}, options = {})
  req = build_request(:create_landing_zone, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_landing_zone({
  landing_zone_identifier: "String", # required
})

Response structure


resp.operation_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :landing_zone_identifier (required, String) —

    The unique identifier of the landing zone.

Returns:

See Also:



495
496
497
498
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 495

def delete_landing_zone(params = {}, options = {})
  req = build_request(:delete_landing_zone, params)
  req.send_request(options)
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 .

Examples:

Request syntax with placeholder values


resp = client.disable_baseline({
  enabled_baseline_identifier: "Arn", # required
})

Response structure


resp.operation_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :enabled_baseline_identifier (required, String) —

    Identifier of the EnabledBaseline resource to be deactivated, in ARN format.

Returns:

See Also:



532
533
534
535
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 532

def disable_baseline(params = {}, options = {})
  req = build_request(:disable_baseline, params)
  req.send_request(options)
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 .

Examples:

Request syntax with placeholder values


resp = client.disable_control({
  control_identifier: "ControlIdentifier", # required
  target_identifier: "TargetIdentifier", # required
})

Response structure


resp.operation_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :control_identifier (required, String) —

    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.

  • :target_identifier (required, String) —

    The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

Returns:

See Also:



584
585
586
587
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 584

def disable_control(params = {}, options = {})
  req = build_request(:disable_control, params)
  req.send_request(options)
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 .

Examples:

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
})

Response structure


resp.arn #=> String
resp.operation_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :baseline_identifier (required, String) —

    The ARN of the baseline to be enabled.

  • :baseline_version (required, String) —

    The specific version to be enabled of the specified baseline.

  • :parameters (Array<Types::EnabledBaselineParameter>) —

    A list of key-value objects that specify enablement parameters, where key is a string and value is a document of any type.

  • :tags (Hash<String,String>) —

    Tags associated with input to EnableBaseline.

  • :target_identifier (required, String) —

    The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets.

Returns:

See Also:



647
648
649
650
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 647

def enable_baseline(params = {}, options = {})
  req = build_request(:enable_baseline, params)
  req.send_request(options)
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 .

Examples:

Request syntax with placeholder values


resp = client.enable_control({
  control_identifier: "ControlIdentifier", # required
  parameters: [
    {
      key: "String", # required
      value: { # required
      },
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
  target_identifier: "TargetIdentifier", # required
})

Response structure


resp.arn #=> String
resp.operation_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :control_identifier (required, String) —

    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.

  • :parameters (Array<Types::EnabledControlParameter>) —

    A list of input parameter values, which are specified to configure the control when you enable it.

  • :tags (Hash<String,String>) —

    Tags to be applied to the EnabledControl resource.

  • :target_identifier (required, String) —

    The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

Returns:

See Also:



719
720
721
722
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 719

def enable_control(params = {}, options = {})
  req = build_request(:enable_control, params)
  req.send_request(options)
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 .

Examples:

Request syntax with placeholder values


resp = client.get_baseline({
  baseline_identifier: "BaselineArn", # required
})

Response structure


resp.arn #=> String
resp.description #=> String
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :baseline_identifier (required, String) —

    The ARN of the Baseline resource to be retrieved.

Returns:

See Also:



757
758
759
760
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 757

def get_baseline(params = {}, options = {})
  req = build_request(:get_baseline, params)
  req.send_request(options)
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 .

Examples:

Request syntax with placeholder values


resp = client.get_baseline_operation({
  operation_identifier: "OperationIdentifier", # required
})

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :operation_identifier (required, String) —

    The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset).

Returns:

See Also:



799
800
801
802
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 799

def get_baseline_operation(params = {}, options = {})
  req = build_request(:get_baseline_operation, params)
  req.send_request(options)
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 .

Examples:

Request syntax with placeholder values


resp = client.get_control_operation({
  operation_identifier: "OperationIdentifier", # required
})

Response structure


resp.control_operation.control_identifier #=> String
resp.control_operation.enabled_control_identifier #=> String
resp.control_operation.end_time #=> Time
resp.control_operation.operation_identifier #=> String
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
resp.control_operation.target_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :operation_identifier (required, String) —

    The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.

Returns:

See Also:



843
844
845
846
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 843

def get_control_operation(params = {}, options = {})
  req = build_request(:get_control_operation, params)
  req.send_request(options)
end

#get_enabled_baseline(params = {}) ⇒ Types::GetEnabledBaselineOutput

Retrieve details of an EnabledBaseline resource by specifying its identifier.

Examples:

Request syntax with placeholder values


resp = client.get_enabled_baseline({
  enabled_baseline_identifier: "Arn", # required
})

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :enabled_baseline_identifier (required, String) —

    Identifier of the EnabledBaseline resource to be retrieved, in ARN format.

Returns:

See Also:



880
881
882
883
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 880

def get_enabled_baseline(params = {}, options = {})
  req = build_request(:get_enabled_baseline, params)
  req.send_request(options)
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 .

Examples:

Request syntax with placeholder values


resp = client.get_enabled_control({
  enabled_control_identifier: "Arn", # required
})

Response structure


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
resp.enabled_control_details.target_regions #=> Array
resp.enabled_control_details.target_regions[0].name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :enabled_control_identifier (required, String) —

    The controlIdentifier of the enabled control.

Returns:

See Also:



922
923
924
925
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 922

def get_enabled_control(params = {}, options = {})
  req = build_request(:get_enabled_control, params)
  req.send_request(options)
end

#get_landing_zone(params = {}) ⇒ Types::GetLandingZoneOutput

Returns details about the landing zone. Displays a message in case of error.

Examples:

Request syntax with placeholder values


resp = client.get_landing_zone({
  landing_zone_identifier: "String", # required
})

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :landing_zone_identifier (required, String) —

    The unique identifier of the landing zone.

Returns:

See Also:



955
956
957
958
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 955

def get_landing_zone(params = {}, options = {})
  req = build_request(:get_landing_zone, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_landing_zone_operation({
  operation_identifier: "OperationIdentifier", # required
})

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :operation_identifier (required, String) —

    A unique identifier assigned to a landing zone operation.

Returns:

See Also:



988
989
990
991
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 988

def get_landing_zone_operation(params = {}, options = {})
  req = build_request(:get_landing_zone_operation, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_baselines({
  max_results: 1,
  next_token: "String",
})

Response structure


resp.baselines #=> Array
resp.baselines[0].arn #=> String
resp.baselines[0].description #=> String
resp.baselines[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to be shown.

  • :next_token (String) —

    A pagination token.

Returns:

See Also:



1032
1033
1034
1035
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1032

def list_baselines(params = {}, options = {})
  req = build_request(:list_baselines, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_control_operations({
  filter: {
    control_identifiers: ["ControlIdentifier"],
    control_operation_types: ["ENABLE_CONTROL"], # accepts ENABLE_CONTROL, DISABLE_CONTROL, UPDATE_ENABLED_CONTROL
    enabled_control_identifiers: ["Arn"],
    statuses: ["SUCCEEDED"], # accepts SUCCEEDED, FAILED, IN_PROGRESS
    target_identifiers: ["TargetIdentifier"],
  },
  max_results: 1,
  next_token: "ListControlOperationsNextToken",
})

Response structure


resp.control_operations #=> Array
resp.control_operations[0].control_identifier #=> String
resp.control_operations[0].enabled_control_identifier #=> String
resp.control_operations[0].end_time #=> Time
resp.control_operations[0].operation_identifier #=> String
resp.control_operations[0].operation_type #=> String, one of "ENABLE_CONTROL", "DISABLE_CONTROL", "UPDATE_ENABLED_CONTROL"
resp.control_operations[0].start_time #=> Time
resp.control_operations[0].status #=> String, one of "SUCCEEDED", "FAILED", "IN_PROGRESS"
resp.control_operations[0].status_message #=> String
resp.control_operations[0].target_identifier #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::ControlOperationFilter) —

    An input filter for the ListControlOperations API that lets you select the types of control operations to view.

  • :max_results (Integer) —

    The maximum number of results to be shown.

  • :next_token (String) —

    A pagination token.

Returns:

See Also:



1088
1089
1090
1091
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1088

def list_control_operations(params = {}, options = {})
  req = build_request(:list_control_operations, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_enabled_baselines({
  filter: {
    baseline_identifiers: ["Arn"],
    target_identifiers: ["Arn"],
  },
  max_results: 1,
  next_token: "ListEnabledBaselinesNextToken",
})

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::EnabledBaselineFilter) —

    A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.

  • :max_results (Integer) —

    The maximum number of results to be shown.

  • :next_token (String) —

    A pagination token.

Returns:

See Also:



1146
1147
1148
1149
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1146

def list_enabled_baselines(params = {}, options = {})
  req = build_request(:list_enabled_baselines, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_enabled_controls({
  filter: {
    control_identifiers: ["ControlIdentifier"],
    drift_statuses: ["DRIFTED"], # accepts DRIFTED, IN_SYNC, NOT_CHECKING, UNKNOWN
    statuses: ["SUCCEEDED"], # accepts SUCCEEDED, FAILED, UNDER_CHANGE
  },
  max_results: 1,
  next_token: "String",
  target_identifier: "TargetIdentifier",
})

Response structure


resp.enabled_controls #=> Array
resp.enabled_controls[0].arn #=> String
resp.enabled_controls[0].control_identifier #=> String
resp.enabled_controls[0].drift_status_summary.drift_status #=> String, one of "DRIFTED", "IN_SYNC", "NOT_CHECKING", "UNKNOWN"
resp.enabled_controls[0].status_summary.last_operation_identifier #=> String
resp.enabled_controls[0].status_summary.status #=> String, one of "SUCCEEDED", "FAILED", "UNDER_CHANGE"
resp.enabled_controls[0].target_identifier #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Types::EnabledControlFilter) —

    An input filter for the ListCEnabledControls API that lets you select the types of control operations to view.

  • :max_results (Integer) —

    How many results to return per API call.

  • :next_token (String) —

    The token to continue the list from a previous API call with the same parameters.

  • :target_identifier (String) —

    The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

Returns:

See Also:



1214
1215
1216
1217
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1214

def list_enabled_controls(params = {}, options = {})
  req = build_request(:list_enabled_controls, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_landing_zones({
  max_results: 1,
  next_token: "String",
})

Response structure


resp.landing_zones #=> Array
resp.landing_zones[0].arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of returned landing zone ARNs, which is one.

  • :next_token (String) —

    The token to continue the list from a previous API call with the same parameters.

Returns:

See Also:



1256
1257
1258
1259
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1256

def list_landing_zones(params = {}, options = {})
  req = build_request(:list_landing_zones, params)
  req.send_request(options)
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 .

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

Returns:

See Also:



1291
1292
1293
1294
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1291

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
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 .

Examples:

Request syntax with placeholder values


resp = client.reset_enabled_baseline({
  enabled_baseline_identifier: "Arn", # required
})

Response structure


resp.operation_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :enabled_baseline_identifier (required, String) —

    Specifies the ID of the EnabledBaseline resource to be re-enabled, in ARN format.

Returns:

See Also:



1327
1328
1329
1330
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1327

def reset_enabled_baseline(params = {}, options = {})
  req = build_request(:reset_enabled_baseline, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.reset_landing_zone({
  landing_zone_identifier: "String", # required
})

Response structure


resp.operation_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :landing_zone_identifier (required, String) —

    The unique identifier of the landing zone.

Returns:

See Also:



1357
1358
1359
1360
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1357

def reset_landing_zone(params = {}, options = {})
  req = build_request(:reset_landing_zone, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Applies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to be tagged.

  • :tags (required, Hash<String,String>) —

    Tags to be applied to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1390
1391
1392
1393
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1390

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

  • :tag_keys (required, Array<String>) —

    Tag keys to be removed from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1421
1422
1423
1424
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1421

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
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 .

Examples:

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
      },
    },
  ],
})

Response structure


resp.operation_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :baseline_version (required, String) —

    Specifies the new Baseline version, to which the EnabledBaseline should be updated.

  • :enabled_baseline_identifier (required, String) —

    Specifies the EnabledBaseline resource to be updated.

  • :parameters (Array<Types::EnabledBaselineParameter>) —

    Parameters to apply when making an update.

Returns:

See Also:



1470
1471
1472
1473
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1470

def update_enabled_baseline(params = {}, options = {})
  req = build_request(:update_enabled_baseline, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.update_enabled_control({
  enabled_control_identifier: "Arn", # required
  parameters: [ # required
    {
      key: "String", # required
      value: { # required
      },
    },
  ],
})

Response structure


resp.operation_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :enabled_control_identifier (required, String) —

    The ARN of the enabled control that will be updated.

  • :parameters (required, Array<Types::EnabledControlParameter>) —

    A key/value pair, where Key is of type String and Value is of type Document.

Returns:

See Also:



1528
1529
1530
1531
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1528

def update_enabled_control(params = {}, options = {})
  req = build_request(:update_enabled_control, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.update_landing_zone({
  landing_zone_identifier: "String", # required
  manifest: { # required
  },
  version: "LandingZoneVersion", # required
})

Response structure


resp.operation_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :landing_zone_identifier (required, String) —

    The unique identifier of the landing zone.

  • :manifest (required, Hash, Array, String, Numeric, Boolean) —

    The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.

    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.

  • :version (required, String) —

    The landing zone version, for example, 3.2.

Returns:

See Also:



1579
1580
1581
1582
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1579

def update_landing_zone(params = {}, options = {})
  req = build_request(:update_landing_zone, params)
  req.send_request(options)
end