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

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

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

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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::InstanceProfileCredentials 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)
  • :account_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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :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. Takes effect only when disable_clock_skew_correction is not set.

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

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

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :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_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :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.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :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)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or 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_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :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.



478
479
480
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 478

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({
  version: "LandingZoneVersion", # required
  remediation_types: ["INHERITANCE_DRIFT"], # accepts INHERITANCE_DRIFT
  tags: {
    "TagKey" => "TagValue",
  },
  manifest: {
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :version (required, String) —

    The landing zone version, for example, 3.0.

  • :remediation_types (Array<String>) —

    Specifies the types of remediation actions to apply when creating the landing zone, such as automatic drift correction or compliance enforcement.

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

    Tags to be applied to the landing zone.

  • :manifest (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.

Returns:

See Also:



539
540
541
542
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 539

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.

Decommissioning a landing zone is a process with significant consequences, and it cannot be undone. We strongly recommend that you perform this decommissioning process only if you intend to stop using your landing zone.

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:



574
575
576
577
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 574

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:



611
612
613
614
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 611

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 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 .

Examples:

Request syntax with placeholder values


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

Response structure


resp.operation_identifier #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :control_identifier (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 (String) —

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

  • :enabled_control_identifier (String) —

    The ARN of the enabled control to be disabled, which uniquely identifies the control instance on the target organizational unit.

Returns:

See Also:



668
669
670
671
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 668

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_version: "BaselineVersion", # required
  parameters: [
    {
      key: "String", # required
      value: { # required
      },
    },
  ],
  baseline_identifier: "Arn", # required
  target_identifier: "Arn", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :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.

  • :baseline_identifier (required, String) —

    The ARN of the baseline to be enabled.

  • :target_identifier (required, String) —

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

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

    Tags associated with input to EnableBaseline.

Returns:

See Also:



731
732
733
734
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 731

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 Controls Reference Guide .

Examples:

Request syntax with placeholder values


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

Response structure


resp.operation_identifier #=> String
resp.arn #=> 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.

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

    Tags to be applied to the EnabledControl resource.

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

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

Returns:

See Also:



802
803
804
805
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 802

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.name #=> String
resp.description #=> 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:



840
841
842
843
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 840

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.operation_identifier #=> String
resp.baseline_operation.operation_type #=> String, one of "ENABLE_BASELINE", "DISABLE_BASELINE", "UPDATE_ENABLED_BASELINE", "RESET_ENABLED_BASELINE"
resp.baseline_operation.status #=> String, one of "SUCCEEDED", "FAILED", "IN_PROGRESS"
resp.baseline_operation.start_time #=> Time
resp.baseline_operation.end_time #=> Time
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:



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

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 Controls Reference Guide .

Examples:

Request syntax with placeholder values


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

Response structure


resp.control_operation.operation_type #=> String, one of "ENABLE_CONTROL", "DISABLE_CONTROL", "UPDATE_ENABLED_CONTROL", "RESET_ENABLED_CONTROL"
resp.control_operation.start_time #=> Time
resp.control_operation.end_time #=> Time
resp.control_operation.status #=> String, one of "SUCCEEDED", "FAILED", "IN_PROGRESS"
resp.control_operation.status_message #=> String
resp.control_operation.operation_identifier #=> String
resp.control_operation.control_identifier #=> String
resp.control_operation.target_identifier #=> String
resp.control_operation.enabled_control_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:



926
927
928
929
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 926

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.drift_status_summary.types.inheritance.status #=> String, one of "IN_SYNC", "DRIFTED"
resp.enabled_baseline_details.target_identifier #=> String
resp.enabled_baseline_details.parent_identifier #=> String
resp.enabled_baseline_details.status_summary.status #=> String, one of "SUCCEEDED", "FAILED", "UNDER_CHANGE"
resp.enabled_baseline_details.status_summary.last_operation_identifier #=> String
resp.enabled_baseline_details.parameters #=> Array
resp.enabled_baseline_details.parameters[0].key #=> 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:



965
966
967
968
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 965

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 Controls Reference 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.target_identifier #=> String
resp.enabled_control_details.status_summary.status #=> String, one of "SUCCEEDED", "FAILED", "UNDER_CHANGE"
resp.enabled_control_details.status_summary.last_operation_identifier #=> String
resp.enabled_control_details.drift_status_summary.drift_status #=> String, one of "DRIFTED", "IN_SYNC", "NOT_CHECKING", "UNKNOWN"
resp.enabled_control_details.drift_status_summary.types.inheritance.status #=> String, one of "DRIFTED", "IN_SYNC", "NOT_CHECKING", "UNKNOWN"
resp.enabled_control_details.drift_status_summary.types.resource.status #=> String, one of "DRIFTED", "IN_SYNC", "NOT_CHECKING", "UNKNOWN"
resp.enabled_control_details.parent_identifier #=> String
resp.enabled_control_details.target_regions #=> Array
resp.enabled_control_details.target_regions[0].name #=> String
resp.enabled_control_details.parameters #=> Array
resp.enabled_control_details.parameters[0].key #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :enabled_control_identifier (required, String) —

    The controlIdentifier of the enabled control.

Returns:

See Also:



1010
1011
1012
1013
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1010

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.version #=> String
resp.landing_zone.remediation_types #=> Array
resp.landing_zone.remediation_types[0] #=> String, one of "INHERITANCE_DRIFT"
resp.landing_zone.arn #=> String
resp.landing_zone.status #=> String, one of "ACTIVE", "PROCESSING", "FAILED"
resp.landing_zone.latest_available_version #=> String
resp.landing_zone.drift_status.status #=> String, one of "DRIFTED", "IN_SYNC"

Parameters:

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

    ({})

Options Hash (params):

  • :landing_zone_identifier (required, String) —

    The unique identifier of the landing zone.

Returns:

See Also:



1045
1046
1047
1048
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1045

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.operation_type #=> String, one of "DELETE", "CREATE", "UPDATE", "RESET"
resp.operation_details.operation_identifier #=> String
resp.operation_details.status #=> String, one of "SUCCEEDED", "FAILED", "IN_PROGRESS"
resp.operation_details.start_time #=> Time
resp.operation_details.end_time #=> Time
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:



1079
1080
1081
1082
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1079

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({
  next_token: "String",
  max_results: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A pagination token.

  • :max_results (Integer) —

    The maximum number of results to be shown.

Returns:

See Also:



1123
1124
1125
1126
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1123

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. For usage examples, see ListControlOperation examples.

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"],
    target_identifiers: ["TargetIdentifier"],
    enabled_control_identifiers: ["Arn"],
    statuses: ["SUCCEEDED"], # accepts SUCCEEDED, FAILED, IN_PROGRESS
    control_operation_types: ["ENABLE_CONTROL"], # accepts ENABLE_CONTROL, DISABLE_CONTROL, UPDATE_ENABLED_CONTROL, RESET_ENABLED_CONTROL
  },
  next_token: "ListControlOperationsNextToken",
  max_results: 1,
})

Response structure


resp.control_operations #=> Array
resp.control_operations[0].operation_type #=> String, one of "ENABLE_CONTROL", "DISABLE_CONTROL", "UPDATE_ENABLED_CONTROL", "RESET_ENABLED_CONTROL"
resp.control_operations[0].start_time #=> Time
resp.control_operations[0].end_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].operation_identifier #=> String
resp.control_operations[0].control_identifier #=> String
resp.control_operations[0].target_identifier #=> String
resp.control_operations[0].enabled_control_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.

  • :next_token (String) —

    A pagination token.

  • :max_results (Integer) —

    The maximum number of results to be shown.

Returns:

See Also:



1184
1185
1186
1187
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1184

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: {
    target_identifiers: ["Arn"],
    baseline_identifiers: ["Arn"],
    parent_identifiers: ["Arn"],
    statuses: ["SUCCEEDED"], # accepts SUCCEEDED, FAILED, UNDER_CHANGE
    inheritance_drift_statuses: ["IN_SYNC"], # accepts IN_SYNC, DRIFTED
  },
  next_token: "ListEnabledBaselinesNextToken",
  max_results: 1,
  include_children: false,
})

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].drift_status_summary.types.inheritance.status #=> String, one of "IN_SYNC", "DRIFTED"
resp.enabled_baselines[0].target_identifier #=> String
resp.enabled_baselines[0].parent_identifier #=> String
resp.enabled_baselines[0].status_summary.status #=> String, one of "SUCCEEDED", "FAILED", "UNDER_CHANGE"
resp.enabled_baselines[0].status_summary.last_operation_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.

  • :next_token (String) —

    A pagination token.

  • :max_results (Integer) —

    The maximum number of results to be shown.

  • :include_children (Boolean) —

    A value that can be set to include the child enabled baselines in responses. The default value is false.

Returns:

See Also:



1252
1253
1254
1255
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1252

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 Controls Reference 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({
  target_identifier: "TargetIdentifier",
  next_token: "String",
  max_results: 1,
  filter: {
    control_identifiers: ["ControlIdentifier"],
    statuses: ["SUCCEEDED"], # accepts SUCCEEDED, FAILED, UNDER_CHANGE
    drift_statuses: ["DRIFTED"], # accepts DRIFTED, IN_SYNC, NOT_CHECKING, UNKNOWN
    parent_identifiers: ["ParentIdentifier"],
    inheritance_drift_statuses: ["DRIFTED"], # accepts DRIFTED, IN_SYNC, NOT_CHECKING, UNKNOWN
    resource_drift_statuses: ["DRIFTED"], # accepts DRIFTED, IN_SYNC, NOT_CHECKING, UNKNOWN
  },
  include_children: false,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :target_identifier (String) —

    The ARN of the target. The value depends on the target type:

    • Organizational unit (OU) – Specify the ARN of the OU.

    • Account – Specify the ARN of the account.

    For information on how to find the targetIdentifier, see the overview page.

  • :next_token (String) —

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

  • :max_results (Integer) —

    How many results to return per API call.

  • :filter (Types::EnabledControlFilter) —

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

  • :include_children (Boolean) —

    Specifies whether to include enabled controls from child organizational units and child accounts in the response.

Returns:

See Also:



1336
1337
1338
1339
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1336

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

Examples:

Request syntax with placeholder values


resp = client.list_landing_zone_operations({
  filter: {
    types: ["DELETE"], # accepts DELETE, CREATE, UPDATE, RESET
    statuses: ["SUCCEEDED"], # accepts SUCCEEDED, FAILED, IN_PROGRESS
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.landing_zone_operations #=> Array
resp.landing_zone_operations[0].operation_type #=> String, one of "DELETE", "CREATE", "UPDATE", "RESET"
resp.landing_zone_operations[0].operation_identifier #=> String
resp.landing_zone_operations[0].status #=> String, one of "SUCCEEDED", "FAILED", "IN_PROGRESS"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filter (Types::LandingZoneOperationFilter) —

    An input filter for the ListLandingZoneOperations API that lets you select the types of landing zone operations to view.

  • :next_token (String) —

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

  • :max_results (Integer) —

    How many results to return per API call.

Returns:

See Also:



1385
1386
1387
1388
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1385

def list_landing_zone_operations(params = {}, options = {})
  req = build_request(:list_landing_zone_operations, 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({
  next_token: "String",
  max_results: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



1427
1428
1429
1430
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1427

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 Controls Reference 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:



1461
1462
1463
1464
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1461

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:



1497
1498
1499
1500
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1497

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

#reset_enabled_control(params = {}) ⇒ Types::ResetEnabledControlOutput

Resets an enabled control. Does not work for controls implemented with SCPs.

Examples:

Request syntax with placeholder values


resp = client.reset_enabled_control({
  enabled_control_identifier: "Arn", # 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 to be reset.

Returns:

See Also:



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

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

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:



1560
1561
1562
1563
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1560

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 Controls Reference 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:



1593
1594
1595
1596
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1593

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 Controls Reference 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:



1624
1625
1626
1627
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1624

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
  parameters: [
    {
      key: "String", # required
      value: { # required
      },
    },
  ],
  enabled_baseline_identifier: "Arn", # 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.

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

    Parameters to apply when making an update.

  • :enabled_baseline_identifier (required, String) —

    Specifies the EnabledBaseline resource to be updated.

Returns:

See Also:



1673
1674
1675
1676
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1673

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 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 the ResetEnabledControl API. Alternatively, you can call DisableControl and then call EnableControl again. Also, you can run an extending governance operation to repair drift. For usage examples, see the Controls Reference Guide .

Examples:

Request syntax with placeholder values


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

Response structure


resp.operation_identifier #=> String

Parameters:

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

    ({})

Options Hash (params):

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

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

  • :enabled_control_identifier (required, String) —

    The ARN of the enabled control that will be updated.

Returns:

See Also:



1732
1733
1734
1735
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1732

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({
  version: "LandingZoneVersion", # required
  remediation_types: ["INHERITANCE_DRIFT"], # accepts INHERITANCE_DRIFT
  landing_zone_identifier: "String", # required
  manifest: {
  },
})

Response structure


resp.operation_identifier #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :version (required, String) —

    The landing zone version, for example, 3.2.

  • :remediation_types (Array<String>) —

    Specifies the types of remediation actions to apply when updating the landing zone configuration.

  • :landing_zone_identifier (required, String) —

    The unique identifier of the landing zone.

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

    The manifest file (JSON) is a text file that describes your Amazon Web Services resources. For an example, review Launch your landing zone. The example manifest file contains each of the available parameters. The schema for the landing zone's JSON manifest file is not published, by design.

    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.

Returns:

See Also:



1790
1791
1792
1793
 
# File 'gems/aws-sdk-controltower/lib/aws-sdk-controltower/client.rb', line 1790

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