Class: Aws::ComputeOptimizerAutomation::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
Aws::ClientStubs
Defined in:
lib/aws-sdk-computeoptimizerautomation/client.rb

Overview

An API client for ComputeOptimizerAutomation. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::ComputeOptimizerAutomation::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

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`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.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` 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:

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

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

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

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :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 ClientStubs#stub_responses. See 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::ComputeOptimizerAutomation::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ComputeOptimizerAutomation::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 ‘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 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 478

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2228
2229
2230
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 2228

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2231
2232
2233
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 2231

def errors_module
  Errors
end

Instance Method Details

#associate_accounts(params = {}) ⇒ Types::AssociateAccountsResponse

Associates one or more member accounts with your organization’s management account, enabling centralized implementation of optimization actions across those accounts. Once associated, the management account (or a delegated administrator) can apply recommended actions to the member account. When you associate a member account, its organization rule mode is automatically set to “Any allowed,” which permits the management account to create Automation rules that automatically apply actions to that account. If the member account has not previously enabled the Automation feature, the association process automatically enables it.

<note markdown=“1”> Only the management account or a delegated administrator can perform this action.

</note>

Examples:

Request syntax with placeholder values


resp = client.associate_accounts({
  account_ids: ["AccountId"], # required
  client_token: "ClientToken",
})

Response structure


resp. #=> Array
resp.[0] #=> String
resp.errors #=> Array
resp.errors[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    The IDs of the member accounts to associate. You can specify up to 50 account IDs.

  • :client_token (String) —

    A unique identifier to ensure idempotency of the request. Valid for 24 hours after creation.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

See Also:



534
535
536
537
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 534

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

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 2201

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::ComputeOptimizerAutomation')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-computeoptimizerautomation'
  context[:gem_version] = '1.8.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_automation_rule(params = {}) ⇒ Types::CreateAutomationRuleResponse

Creates a new automation rule to apply recommended actions to resources based on specified criteria.

Examples:

Request syntax with placeholder values


resp = client.create_automation_rule({
  name: "RuleName", # required
  description: "RuleDescription",
  rule_type: "OrganizationRule", # required, accepts OrganizationRule, AccountRule
  organization_configuration: {
    rule_apply_order: "BeforeAccountRules", # accepts BeforeAccountRules, AfterAccountRules
    account_ids: ["AccountId"],
  },
  priority: "String",
  recommended_action_types: ["SnapshotAndDeleteUnattachedEbsVolume"], # required, accepts SnapshotAndDeleteUnattachedEbsVolume, UpgradeEbsVolumeType
  criteria: {
    region: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
    resource_arn: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
    ebs_volume_type: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
    ebs_volume_size_in_gib: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: [1],
      },
    ],
    estimated_monthly_savings: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: [1.0],
      },
    ],
    resource_tag: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        key: "StringCriteriaValue",
        values: ["StringCriteriaValue"],
      },
    ],
    look_back_period_in_days: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: [1],
      },
    ],
    restart_needed: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
  },
  schedule: { # required
    schedule_expression: "String",
    schedule_expression_timezone: "String",
    execution_window_in_minutes: 1,
  },
  status: "Active", # required, accepts Active, Inactive
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.rule_arn #=> String
resp.rule_id #=> String
resp.name #=> String
resp.description #=> String
resp.rule_type #=> String, one of "OrganizationRule", "AccountRule"
resp.rule_revision #=> Integer
resp.organization_configuration.rule_apply_order #=> String, one of "BeforeAccountRules", "AfterAccountRules"
resp.organization_configuration. #=> Array
resp.organization_configuration.[0] #=> String
resp.priority #=> String
resp.recommended_action_types #=> Array
resp.recommended_action_types[0] #=> String, one of "SnapshotAndDeleteUnattachedEbsVolume", "UpgradeEbsVolumeType"
resp.criteria.region #=> Array
resp.criteria.region[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.region[0].values #=> Array
resp.criteria.region[0].values[0] #=> String
resp.criteria.resource_arn #=> Array
resp.criteria.resource_arn[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.resource_arn[0].values #=> Array
resp.criteria.resource_arn[0].values[0] #=> String
resp.criteria.ebs_volume_type #=> Array
resp.criteria.ebs_volume_type[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.ebs_volume_type[0].values #=> Array
resp.criteria.ebs_volume_type[0].values[0] #=> String
resp.criteria.ebs_volume_size_in_gib #=> Array
resp.criteria.ebs_volume_size_in_gib[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.ebs_volume_size_in_gib[0].values #=> Array
resp.criteria.ebs_volume_size_in_gib[0].values[0] #=> Integer
resp.criteria.estimated_monthly_savings #=> Array
resp.criteria.estimated_monthly_savings[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.estimated_monthly_savings[0].values #=> Array
resp.criteria.estimated_monthly_savings[0].values[0] #=> Float
resp.criteria.resource_tag #=> Array
resp.criteria.resource_tag[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.resource_tag[0].key #=> String
resp.criteria.resource_tag[0].values #=> Array
resp.criteria.resource_tag[0].values[0] #=> String
resp.criteria.look_back_period_in_days #=> Array
resp.criteria.look_back_period_in_days[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.look_back_period_in_days[0].values #=> Array
resp.criteria.look_back_period_in_days[0].values[0] #=> Integer
resp.criteria.restart_needed #=> Array
resp.criteria.restart_needed[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.restart_needed[0].values #=> Array
resp.criteria.restart_needed[0].values[0] #=> String
resp.schedule.schedule_expression #=> String
resp.schedule.schedule_expression_timezone #=> String
resp.schedule.execution_window_in_minutes #=> Integer
resp.status #=> String, one of "Active", "Inactive"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.created_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the automation rule.

  • :description (String) —

    A description of the automation rule.

  • :rule_type (required, String) —

    The type of rule.

    <note markdown=“1”> Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.

    </note>
  • :organization_configuration (Types::OrganizationConfiguration) —

    Configuration for organization-level rules. Required for OrganizationRule type.

  • :priority (String) —

    A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule. When multiple rules match the same recommended action, Compute Optimizer assigns the action to the rule with the lowest priority value (highest priority), even if that rule is scheduled to run later than other matching rules.

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

    The types of recommended actions this rule will automate.

  • :criteria (Types::Criteria) —

    A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time.

  • :schedule (required, Types::Schedule) —

    The schedule for when the rule should run.

  • :status (required, String) —

    The status of the rule

  • :tags (Array<Types::Tag>) —

    The tags to associate with the rule.

  • :client_token (String) —

    A unique identifier to ensure idempotency of the request.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

See Also:



747
748
749
750
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 747

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

#delete_automation_rule(params = {}) ⇒ Struct

Deletes an existing automation rule.

Examples:

Request syntax with placeholder values


resp = client.delete_automation_rule({
  rule_arn: "RuleArn", # required
  rule_revision: 1, # required
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :rule_arn (required, String) —

    The ARN of the rule to delete.

  • :rule_revision (required, Integer) —

    The revision number of the rule to delete.

  • :client_token (String) —

    A unique identifier to ensure idempotency of the request.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



780
781
782
783
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 780

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

#disassociate_accounts(params = {}) ⇒ Types::DisassociateAccountsResponse

Disassociates member accounts from your organization’s management account, removing centralized automation capabilities. Once disassociated, organization rules no longer apply to the member account, and the management account (or delegated administrator) cannot create Automation rules for that account.

<note markdown=“1”> Only the management account or a delegated administrator can perform this action.

</note>

Examples:

Request syntax with placeholder values


resp = client.disassociate_accounts({
  account_ids: ["AccountId"], # required
  client_token: "ClientToken",
})

Response structure


resp. #=> Array
resp.[0] #=> String
resp.errors #=> Array
resp.errors[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    The IDs of the member accounts to disassociate.

  • :client_token (String) —

    A unique identifier to ensure idempotency of the request.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

See Also:



828
829
830
831
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 828

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

#get_automation_event(params = {}) ⇒ Types::GetAutomationEventResponse

Retrieves details about a specific automation event.

Examples:

Request syntax with placeholder values


resp = client.get_automation_event({
  event_id: "EventId", # required
})

Response structure


resp.event_id #=> String
resp.event_description #=> String
resp.event_type #=> String, one of "SnapshotAndDeleteUnattachedEbsVolume", "UpgradeEbsVolumeType"
resp.event_status #=> String, one of "Ready", "InProgress", "Complete", "Failed", "Cancelled", "RollbackReady", "RollbackInProgress", "RollbackComplete", "RollbackFailed"
resp.event_status_reason #=> String
resp.resource_arn #=> String
resp.resource_id #=> String
resp.recommended_action_id #=> String
resp. #=> String
resp.region #=> String
resp.rule_id #=> String
resp.resource_type #=> String, one of "EbsVolume"
resp.created_timestamp #=> Time
resp.completed_timestamp #=> Time
resp.estimated_monthly_savings.currency #=> String
resp.estimated_monthly_savings.before_discount_savings #=> Float
resp.estimated_monthly_savings.after_discount_savings #=> Float
resp.estimated_monthly_savings.savings_estimation_mode #=> String, one of "BeforeDiscount", "AfterDiscount"

Parameters:

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

    ({})

Options Hash (params):

  • :event_id (required, String) —

    The ID of the automation event to retrieve.

Returns:

See Also:



887
888
889
890
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 887

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

#get_automation_rule(params = {}) ⇒ Types::GetAutomationRuleResponse

Retrieves details about a specific automation rule.

Examples:

Request syntax with placeholder values


resp = client.get_automation_rule({
  rule_arn: "RuleArn", # required
})

Response structure


resp.rule_arn #=> String
resp.rule_id #=> String
resp.name #=> String
resp.description #=> String
resp.rule_type #=> String, one of "OrganizationRule", "AccountRule"
resp.rule_revision #=> Integer
resp. #=> String
resp.organization_configuration.rule_apply_order #=> String, one of "BeforeAccountRules", "AfterAccountRules"
resp.organization_configuration. #=> Array
resp.organization_configuration.[0] #=> String
resp.priority #=> String
resp.recommended_action_types #=> Array
resp.recommended_action_types[0] #=> String, one of "SnapshotAndDeleteUnattachedEbsVolume", "UpgradeEbsVolumeType"
resp.criteria.region #=> Array
resp.criteria.region[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.region[0].values #=> Array
resp.criteria.region[0].values[0] #=> String
resp.criteria.resource_arn #=> Array
resp.criteria.resource_arn[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.resource_arn[0].values #=> Array
resp.criteria.resource_arn[0].values[0] #=> String
resp.criteria.ebs_volume_type #=> Array
resp.criteria.ebs_volume_type[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.ebs_volume_type[0].values #=> Array
resp.criteria.ebs_volume_type[0].values[0] #=> String
resp.criteria.ebs_volume_size_in_gib #=> Array
resp.criteria.ebs_volume_size_in_gib[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.ebs_volume_size_in_gib[0].values #=> Array
resp.criteria.ebs_volume_size_in_gib[0].values[0] #=> Integer
resp.criteria.estimated_monthly_savings #=> Array
resp.criteria.estimated_monthly_savings[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.estimated_monthly_savings[0].values #=> Array
resp.criteria.estimated_monthly_savings[0].values[0] #=> Float
resp.criteria.resource_tag #=> Array
resp.criteria.resource_tag[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.resource_tag[0].key #=> String
resp.criteria.resource_tag[0].values #=> Array
resp.criteria.resource_tag[0].values[0] #=> String
resp.criteria.look_back_period_in_days #=> Array
resp.criteria.look_back_period_in_days[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.look_back_period_in_days[0].values #=> Array
resp.criteria.look_back_period_in_days[0].values[0] #=> Integer
resp.criteria.restart_needed #=> Array
resp.criteria.restart_needed[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.restart_needed[0].values #=> Array
resp.criteria.restart_needed[0].values[0] #=> String
resp.schedule.schedule_expression #=> String
resp.schedule.schedule_expression_timezone #=> String
resp.schedule.execution_window_in_minutes #=> Integer
resp.status #=> String, one of "Active", "Inactive"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.created_timestamp #=> Time
resp.last_updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :rule_arn (required, String) —

    The ARN of the rule to retrieve.

Returns:

See Also:



984
985
986
987
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 984

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

#get_enrollment_configuration(params = {}) ⇒ Types::GetEnrollmentConfigurationResponse

Retrieves the current enrollment configuration for Compute Optimizer Automation.

Examples:

Response structure


resp.status #=> String, one of "Active", "Inactive", "Pending", "Failed"
resp.status_reason #=> String
resp.organization_rule_mode #=> String, one of "AnyAllowed", "NoneAllowed"
resp.last_updated_timestamp #=> Time

Parameters:

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

    ({})

Returns:

See Also:



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

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

#list_accounts(params = {}) ⇒ Types::ListAccountsResponse

Lists the accounts in your organization that are enrolled in Compute Optimizer and whether they have enabled Automation.

<note markdown=“1”> Only the management account or a delegated administrator can perform this action.

</note>

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

Response structure


resp.accounts #=> Array
resp.accounts[0]. #=> String
resp.accounts[0].status #=> String, one of "Active", "Inactive", "Pending", "Failed"
resp.accounts[0].organization_rule_mode #=> String, one of "AnyAllowed", "NoneAllowed"
resp.accounts[0].status_reason #=> String
resp.accounts[0].last_updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



1057
1058
1059
1060
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 1057

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

#list_automation_event_steps(params = {}) ⇒ Types::ListAutomationEventStepsResponse

Lists the steps for a specific automation event. You can only list steps for events created within the past year.

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_automation_event_steps({
  event_id: "EventId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.automation_event_steps #=> Array
resp.automation_event_steps[0].event_id #=> String
resp.automation_event_steps[0].step_id #=> String
resp.automation_event_steps[0].step_type #=> String, one of "CreateEbsSnapshot", "DeleteEbsVolume", "ModifyEbsVolume", "CreateEbsVolume"
resp.automation_event_steps[0].step_status #=> String, one of "Ready", "InProgress", "Complete", "Failed"
resp.automation_event_steps[0].resource_id #=> String
resp.automation_event_steps[0].start_timestamp #=> Time
resp.automation_event_steps[0].completed_timestamp #=> Time
resp.automation_event_steps[0].estimated_monthly_savings.currency #=> String
resp.automation_event_steps[0].estimated_monthly_savings.before_discount_savings #=> Float
resp.automation_event_steps[0].estimated_monthly_savings.after_discount_savings #=> Float
resp.automation_event_steps[0].estimated_monthly_savings.savings_estimation_mode #=> String, one of "BeforeDiscount", "AfterDiscount"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :event_id (required, String) —

    The ID of the automation event.

  • :max_results (Integer) —

    The maximum number of automation event steps to return in a single response. Valid range is 1-1000.

  • :next_token (String) —

    A token used for pagination to retrieve the next set of results when the response is truncated.

Returns:

See Also:



1111
1112
1113
1114
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 1111

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

#list_automation_event_summaries(params = {}) ⇒ Types::ListAutomationEventSummariesResponse

Provides a summary of automation events based on specified filters. Only events created within the past year will be included in the summary.

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_automation_event_summaries({
  filters: [
    {
      name: "AccountId", # required, accepts AccountId, ResourceType, EventType, EventStatus
      values: ["FilterValue"], # required
    },
  ],
  start_date_inclusive: "String",
  end_date_exclusive: "String",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.automation_event_summaries #=> Array
resp.automation_event_summaries[0].key #=> String
resp.automation_event_summaries[0].dimensions #=> Array
resp.automation_event_summaries[0].dimensions[0].key #=> String, one of "EventStatus"
resp.automation_event_summaries[0].dimensions[0].value #=> String
resp.automation_event_summaries[0].time_period.start_time_inclusive #=> Time
resp.automation_event_summaries[0].time_period.end_time_exclusive #=> Time
resp.automation_event_summaries[0].total.automation_event_count #=> Integer
resp.automation_event_summaries[0].total.estimated_monthly_savings.currency #=> String
resp.automation_event_summaries[0].total.estimated_monthly_savings.before_discount_savings #=> Float
resp.automation_event_summaries[0].total.estimated_monthly_savings.after_discount_savings #=> Float
resp.automation_event_summaries[0].total.estimated_monthly_savings.savings_estimation_mode #=> String, one of "BeforeDiscount", "AfterDiscount"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Array<Types::AutomationEventFilter>) —

    The filters to apply to the list of automation event summaries.

  • :start_date_inclusive (String) —

    The start date for filtering automation event summaries, inclusive. Events created on or after this date will be included.

  • :end_date_exclusive (String) —

    The end date for filtering automation event summaries, exclusive. Events created before this date will be included.

  • :max_results (Integer) —

    The maximum number of automation event summaries to return in a single response. Valid range is 1-1000.

  • :next_token (String) —

    A token used for pagination to retrieve the next set of results when the response is truncated.

Returns:

See Also:



1181
1182
1183
1184
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 1181

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

#list_automation_events(params = {}) ⇒ Types::ListAutomationEventsResponse

Lists automation events based on specified filters. You can retrieve events that were created within the past year.

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_automation_events({
  filters: [
    {
      name: "AccountId", # required, accepts AccountId, ResourceType, EventType, EventStatus
      values: ["FilterValue"], # required
    },
  ],
  start_time_inclusive: Time.now,
  end_time_exclusive: Time.now,
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.automation_events #=> Array
resp.automation_events[0].event_id #=> String
resp.automation_events[0].event_description #=> String
resp.automation_events[0].event_type #=> String, one of "SnapshotAndDeleteUnattachedEbsVolume", "UpgradeEbsVolumeType"
resp.automation_events[0].event_status #=> String, one of "Ready", "InProgress", "Complete", "Failed", "Cancelled", "RollbackReady", "RollbackInProgress", "RollbackComplete", "RollbackFailed"
resp.automation_events[0].event_status_reason #=> String
resp.automation_events[0].resource_arn #=> String
resp.automation_events[0].resource_id #=> String
resp.automation_events[0].recommended_action_id #=> String
resp.automation_events[0]. #=> String
resp.automation_events[0].region #=> String
resp.automation_events[0].rule_id #=> String
resp.automation_events[0].resource_type #=> String, one of "EbsVolume"
resp.automation_events[0].created_timestamp #=> Time
resp.automation_events[0].completed_timestamp #=> Time
resp.automation_events[0].estimated_monthly_savings.currency #=> String
resp.automation_events[0].estimated_monthly_savings.before_discount_savings #=> Float
resp.automation_events[0].estimated_monthly_savings.after_discount_savings #=> Float
resp.automation_events[0].estimated_monthly_savings.savings_estimation_mode #=> String, one of "BeforeDiscount", "AfterDiscount"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Array<Types::AutomationEventFilter>) —

    The filters to apply to the list of automation events.

  • :start_time_inclusive (Time, DateTime, Date, Integer, String) —

    The start of the time range to query for events.

  • :end_time_exclusive (Time, DateTime, Date, Integer, String) —

    The end of the time range to query for events.

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



1253
1254
1255
1256
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 1253

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

#list_automation_rule_preview(params = {}) ⇒ Types::ListAutomationRulePreviewResponse

Returns a preview of the recommended actions that match your Automation rule’s configuration and criteria.

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_automation_rule_preview({
  rule_type: "OrganizationRule", # required, accepts OrganizationRule, AccountRule
  organization_scope: {
    account_ids: ["AccountId"],
  },
  recommended_action_types: ["SnapshotAndDeleteUnattachedEbsVolume"], # required, accepts SnapshotAndDeleteUnattachedEbsVolume, UpgradeEbsVolumeType
  criteria: {
    region: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
    resource_arn: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
    ebs_volume_type: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
    ebs_volume_size_in_gib: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: [1],
      },
    ],
    estimated_monthly_savings: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: [1.0],
      },
    ],
    resource_tag: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        key: "StringCriteriaValue",
        values: ["StringCriteriaValue"],
      },
    ],
    look_back_period_in_days: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: [1],
      },
    ],
    restart_needed: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.preview_results #=> Array
resp.preview_results[0].recommended_action_id #=> String
resp.preview_results[0].resource_arn #=> String
resp.preview_results[0].resource_id #=> String
resp.preview_results[0]. #=> String
resp.preview_results[0].region #=> String
resp.preview_results[0].resource_type #=> String, one of "EbsVolume"
resp.preview_results[0].look_back_period_in_days #=> Integer
resp.preview_results[0].recommended_action_type #=> String, one of "SnapshotAndDeleteUnattachedEbsVolume", "UpgradeEbsVolumeType"
resp.preview_results[0].current_resource_summary #=> String
resp.preview_results[0].current_resource_details.ebs_volume.configuration.type #=> String
resp.preview_results[0].current_resource_details.ebs_volume.configuration.size_in_gib #=> Integer
resp.preview_results[0].current_resource_details.ebs_volume.configuration.iops #=> Integer
resp.preview_results[0].current_resource_details.ebs_volume.configuration.throughput #=> Integer
resp.preview_results[0].recommended_resource_summary #=> String
resp.preview_results[0].recommended_resource_details.ebs_volume.configuration.type #=> String
resp.preview_results[0].recommended_resource_details.ebs_volume.configuration.size_in_gib #=> Integer
resp.preview_results[0].recommended_resource_details.ebs_volume.configuration.iops #=> Integer
resp.preview_results[0].recommended_resource_details.ebs_volume.configuration.throughput #=> Integer
resp.preview_results[0].restart_needed #=> Boolean
resp.preview_results[0].estimated_monthly_savings.currency #=> String
resp.preview_results[0].estimated_monthly_savings.before_discount_savings #=> Float
resp.preview_results[0].estimated_monthly_savings.after_discount_savings #=> Float
resp.preview_results[0].estimated_monthly_savings.savings_estimation_mode #=> String, one of "BeforeDiscount", "AfterDiscount"
resp.preview_results[0].resource_tags #=> Array
resp.preview_results[0].resource_tags[0].key #=> String
resp.preview_results[0].resource_tags[0].value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rule_type (required, String) —

    The type of rule.

    <note markdown=“1”> Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.

    </note>
  • :organization_scope (Types::OrganizationScope) —

    The organizational scope for the rule preview.

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

    The types of recommended actions to include in the preview.

  • :criteria (Types::Criteria) —

    A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time.

  • :max_results (Integer) —

    The maximum number of automation rule preview results to return in a single response. Valid range is 1-1000.

  • :next_token (String) —

    A token used for pagination to retrieve the next set of results when the response is truncated.

Returns:

See Also:



1394
1395
1396
1397
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 1394

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

#list_automation_rule_preview_summaries(params = {}) ⇒ Types::ListAutomationRulePreviewSummariesResponse

Returns a summary of the recommended actions that match your rule preview configuration and criteria.

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_automation_rule_preview_summaries({
  rule_type: "OrganizationRule", # required, accepts OrganizationRule, AccountRule
  organization_scope: {
    account_ids: ["AccountId"],
  },
  recommended_action_types: ["SnapshotAndDeleteUnattachedEbsVolume"], # required, accepts SnapshotAndDeleteUnattachedEbsVolume, UpgradeEbsVolumeType
  criteria: {
    region: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
    resource_arn: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
    ebs_volume_type: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
    ebs_volume_size_in_gib: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: [1],
      },
    ],
    estimated_monthly_savings: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: [1.0],
      },
    ],
    resource_tag: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        key: "StringCriteriaValue",
        values: ["StringCriteriaValue"],
      },
    ],
    look_back_period_in_days: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: [1],
      },
    ],
    restart_needed: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.preview_result_summaries #=> Array
resp.preview_result_summaries[0].key #=> String
resp.preview_result_summaries[0].total.recommended_action_count #=> Integer
resp.preview_result_summaries[0].total.estimated_monthly_savings.currency #=> String
resp.preview_result_summaries[0].total.estimated_monthly_savings.before_discount_savings #=> Float
resp.preview_result_summaries[0].total.estimated_monthly_savings.after_discount_savings #=> Float
resp.preview_result_summaries[0].total.estimated_monthly_savings.savings_estimation_mode #=> String, one of "BeforeDiscount", "AfterDiscount"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rule_type (required, String) —

    The type of rule.

  • :organization_scope (Types::OrganizationScope) —

    The organizational scope for the rule preview.

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

    The types of recommended actions to include in the preview.

  • :criteria (Types::Criteria) —

    A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time. You can specify up to 20 conditions per filter criteria and 20 values per condition.

  • :max_results (Integer) —

    The maximum number of automation rule preview summaries to return in a single response. Valid range is 1-1000.

  • :next_token (String) —

    A token used for pagination to retrieve the next set of results when the response is truncated.

Returns:

See Also:



1511
1512
1513
1514
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 1511

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

#list_automation_rules(params = {}) ⇒ Types::ListAutomationRulesResponse

Lists the automation rules that match specified filters.

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_automation_rules({
  filters: [
    {
      name: "Name", # required, accepts Name, RecommendedActionType, Status, RuleType, OrganizationConfigurationRuleApplyOrder, AccountId
      values: ["FilterValue"], # required
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.automation_rules #=> Array
resp.automation_rules[0].rule_arn #=> String
resp.automation_rules[0].rule_id #=> String
resp.automation_rules[0].name #=> String
resp.automation_rules[0].description #=> String
resp.automation_rules[0].rule_type #=> String, one of "OrganizationRule", "AccountRule"
resp.automation_rules[0].rule_revision #=> Integer
resp.automation_rules[0]. #=> String
resp.automation_rules[0].organization_configuration.rule_apply_order #=> String, one of "BeforeAccountRules", "AfterAccountRules"
resp.automation_rules[0].organization_configuration. #=> Array
resp.automation_rules[0].organization_configuration.[0] #=> String
resp.automation_rules[0].priority #=> String
resp.automation_rules[0].recommended_action_types #=> Array
resp.automation_rules[0].recommended_action_types[0] #=> String, one of "SnapshotAndDeleteUnattachedEbsVolume", "UpgradeEbsVolumeType"
resp.automation_rules[0].schedule.schedule_expression #=> String
resp.automation_rules[0].schedule.schedule_expression_timezone #=> String
resp.automation_rules[0].schedule.execution_window_in_minutes #=> Integer
resp.automation_rules[0].status #=> String, one of "Active", "Inactive"
resp.automation_rules[0].created_timestamp #=> Time
resp.automation_rules[0].last_updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

    The filters to apply to the list of automation rules.

  • :max_results (Integer) —

    The maximum number of automation rules to return in a single response. Valid range is 1-1000.

  • :next_token (String) —

    A token used for pagination to retrieve the next set of results when the response is truncated.

Returns:

See Also:



1577
1578
1579
1580
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 1577

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

#list_recommended_action_summaries(params = {}) ⇒ Types::ListRecommendedActionSummariesResponse

Provides a summary of recommended actions based on specified filters.

<note markdown=“1”> Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using ‘AssociateAccounts`.

</note>

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_recommended_action_summaries({
  filters: [
    {
      name: "ResourceType", # required, accepts ResourceType, RecommendedActionType, ResourceId, LookBackPeriodInDays, CurrentResourceDetailsEbsVolumeType, ResourceTagsKey, ResourceTagsValue, AccountId, RestartNeeded
      values: ["FilterValue"], # required
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.recommended_action_summaries #=> Array
resp.recommended_action_summaries[0].key #=> String
resp.recommended_action_summaries[0].total.recommended_action_count #=> Integer
resp.recommended_action_summaries[0].total.estimated_monthly_savings.currency #=> String
resp.recommended_action_summaries[0].total.estimated_monthly_savings.before_discount_savings #=> Float
resp.recommended_action_summaries[0].total.estimated_monthly_savings.after_discount_savings #=> Float
resp.recommended_action_summaries[0].total.estimated_monthly_savings.savings_estimation_mode #=> String, one of "BeforeDiscount", "AfterDiscount"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Array<Types::RecommendedActionFilter>) —

    A list of filters to apply when retrieving recommended action summaries. Filters can be based on resource type, action type, account ID, and other criteria.

  • :max_results (Integer) —

    The maximum number of recommended action summaries to return in a single response. Valid range is 1-1000.

  • :next_token (String) —

    A token used for pagination to retrieve the next set of results when the response is truncated.

Returns:

See Also:



1638
1639
1640
1641
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 1638

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

#list_recommended_actions(params = {}) ⇒ Types::ListRecommendedActionsResponse

Lists the recommended actions based that match specified filters.

<note markdown=“1”> Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using ‘AssociateAccounts`.

</note>

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_recommended_actions({
  filters: [
    {
      name: "ResourceType", # required, accepts ResourceType, RecommendedActionType, ResourceId, LookBackPeriodInDays, CurrentResourceDetailsEbsVolumeType, ResourceTagsKey, ResourceTagsValue, AccountId, RestartNeeded
      values: ["FilterValue"], # required
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.recommended_actions #=> Array
resp.recommended_actions[0].recommended_action_id #=> String
resp.recommended_actions[0].resource_arn #=> String
resp.recommended_actions[0].resource_id #=> String
resp.recommended_actions[0]. #=> String
resp.recommended_actions[0].region #=> String
resp.recommended_actions[0].resource_type #=> String, one of "EbsVolume"
resp.recommended_actions[0].look_back_period_in_days #=> Integer
resp.recommended_actions[0].recommended_action_type #=> String, one of "SnapshotAndDeleteUnattachedEbsVolume", "UpgradeEbsVolumeType"
resp.recommended_actions[0].current_resource_summary #=> String
resp.recommended_actions[0].current_resource_details.ebs_volume.configuration.type #=> String
resp.recommended_actions[0].current_resource_details.ebs_volume.configuration.size_in_gib #=> Integer
resp.recommended_actions[0].current_resource_details.ebs_volume.configuration.iops #=> Integer
resp.recommended_actions[0].current_resource_details.ebs_volume.configuration.throughput #=> Integer
resp.recommended_actions[0].recommended_resource_summary #=> String
resp.recommended_actions[0].recommended_resource_details.ebs_volume.configuration.type #=> String
resp.recommended_actions[0].recommended_resource_details.ebs_volume.configuration.size_in_gib #=> Integer
resp.recommended_actions[0].recommended_resource_details.ebs_volume.configuration.iops #=> Integer
resp.recommended_actions[0].recommended_resource_details.ebs_volume.configuration.throughput #=> Integer
resp.recommended_actions[0].restart_needed #=> Boolean
resp.recommended_actions[0].estimated_monthly_savings.currency #=> String
resp.recommended_actions[0].estimated_monthly_savings.before_discount_savings #=> Float
resp.recommended_actions[0].estimated_monthly_savings.after_discount_savings #=> Float
resp.recommended_actions[0].estimated_monthly_savings.savings_estimation_mode #=> String, one of "BeforeDiscount", "AfterDiscount"
resp.recommended_actions[0].resource_tags #=> Array
resp.recommended_actions[0].resource_tags[0].key #=> String
resp.recommended_actions[0].resource_tags[0].value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Array<Types::RecommendedActionFilter>) —

    The filters to apply to the list of recommended actions.

  • :max_results (Integer) —

    The maximum number of recommended actions to return in a single response. Valid range is 1-1000.

  • :next_token (String) —

    A token used for pagination to retrieve the next set of results when the response is truncated.

Returns:

See Also:



1717
1718
1719
1720
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 1717

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags for a specified resource.

Examples:

Request syntax with placeholder values


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

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to list tags for.

Returns:

See Also:



1747
1748
1749
1750
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 1747

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

#rollback_automation_event(params = {}) ⇒ Types::RollbackAutomationEventResponse

Initiates a rollback for a completed automation event.

<note markdown=“1”> Management accounts and delegated administrators can only initiate a rollback for events belonging to associated member accounts. You can associate a member account using ‘AssociateAccounts`.

</note>

Examples:

Request syntax with placeholder values


resp = client.rollback_automation_event({
  event_id: "EventId", # required
  client_token: "ClientToken",
})

Response structure


resp.event_id #=> String
resp.event_status #=> String, one of "Ready", "InProgress", "Complete", "Failed", "Cancelled", "RollbackReady", "RollbackInProgress", "RollbackComplete", "RollbackFailed"

Parameters:

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

    ({})

Options Hash (params):

  • :event_id (required, String) —

    The ID of the automation event to roll back.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

See Also:



1792
1793
1794
1795
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 1792

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

#start_automation_event(params = {}) ⇒ Types::StartAutomationEventResponse

Initiates a one-time, on-demand automation for the specified recommended action.

<note markdown=“1”> Management accounts and delegated administrators can only initiate recommended actions for associated member accounts. You can associate a member account using ‘AssociateAccounts`.

</note>

Examples:

Request syntax with placeholder values


resp = client.start_automation_event({
  recommended_action_id: "RecommendedActionId", # required
  client_token: "ClientToken",
})

Response structure


resp.recommended_action_id #=> String
resp.event_id #=> String
resp.event_status #=> String, one of "Ready", "InProgress", "Complete", "Failed", "Cancelled", "RollbackReady", "RollbackInProgress", "RollbackComplete", "RollbackFailed"

Parameters:

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

    ({})

Options Hash (params):

  • :recommended_action_id (required, String) —

    The ID of the recommended action to automate.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

See Also:



1840
1841
1842
1843
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 1840

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

#tag_resource(params = {}) ⇒ Struct

Adds tags to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "RuleArn", # required
  rule_revision: 1, # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to tag.

  • :rule_revision (required, Integer) —

    The revision number of the automation rule to tag. This ensures you’re tagging the correct version of the rule.

  • :tags (required, Array<Types::Tag>) —

    The tags to add to the resource.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1885
1886
1887
1888
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 1885

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "RuleArn", # required
  rule_revision: 1, # required
  tag_keys: ["String"], # required
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to untag.

  • :rule_revision (required, Integer) —

    The revision number of the automation rule to untag. This ensures you’re untagging the correct version of the rule.

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

    The keys of the tags to remove from the resource.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1925
1926
1927
1928
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 1925

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

#update_automation_rule(params = {}) ⇒ Types::UpdateAutomationRuleResponse

Updates an existing automation rule.

Examples:

Request syntax with placeholder values


resp = client.update_automation_rule({
  rule_arn: "RuleArn", # required
  rule_revision: 1, # required
  name: "RuleName",
  description: "RuleDescription",
  rule_type: "OrganizationRule", # accepts OrganizationRule, AccountRule
  organization_configuration: {
    rule_apply_order: "BeforeAccountRules", # accepts BeforeAccountRules, AfterAccountRules
    account_ids: ["AccountId"],
  },
  priority: "String",
  recommended_action_types: ["SnapshotAndDeleteUnattachedEbsVolume"], # accepts SnapshotAndDeleteUnattachedEbsVolume, UpgradeEbsVolumeType
  criteria: {
    region: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
    resource_arn: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
    ebs_volume_type: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
    ebs_volume_size_in_gib: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: [1],
      },
    ],
    estimated_monthly_savings: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: [1.0],
      },
    ],
    resource_tag: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        key: "StringCriteriaValue",
        values: ["StringCriteriaValue"],
      },
    ],
    look_back_period_in_days: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: [1],
      },
    ],
    restart_needed: [
      {
        comparison: "StringEquals", # accepts StringEquals, StringNotEquals, StringEqualsIgnoreCase, StringNotEqualsIgnoreCase, StringLike, StringNotLike, NumericEquals, NumericNotEquals, NumericLessThan, NumericLessThanEquals, NumericGreaterThan, NumericGreaterThanEquals
        values: ["StringCriteriaValue"],
      },
    ],
  },
  schedule: {
    schedule_expression: "String",
    schedule_expression_timezone: "String",
    execution_window_in_minutes: 1,
  },
  status: "Active", # accepts Active, Inactive
  client_token: "ClientToken",
})

Response structure


resp.rule_arn #=> String
resp.rule_revision #=> Integer
resp.name #=> String
resp.description #=> String
resp.rule_type #=> String, one of "OrganizationRule", "AccountRule"
resp.organization_configuration.rule_apply_order #=> String, one of "BeforeAccountRules", "AfterAccountRules"
resp.organization_configuration. #=> Array
resp.organization_configuration.[0] #=> String
resp.priority #=> String
resp.recommended_action_types #=> Array
resp.recommended_action_types[0] #=> String, one of "SnapshotAndDeleteUnattachedEbsVolume", "UpgradeEbsVolumeType"
resp.criteria.region #=> Array
resp.criteria.region[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.region[0].values #=> Array
resp.criteria.region[0].values[0] #=> String
resp.criteria.resource_arn #=> Array
resp.criteria.resource_arn[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.resource_arn[0].values #=> Array
resp.criteria.resource_arn[0].values[0] #=> String
resp.criteria.ebs_volume_type #=> Array
resp.criteria.ebs_volume_type[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.ebs_volume_type[0].values #=> Array
resp.criteria.ebs_volume_type[0].values[0] #=> String
resp.criteria.ebs_volume_size_in_gib #=> Array
resp.criteria.ebs_volume_size_in_gib[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.ebs_volume_size_in_gib[0].values #=> Array
resp.criteria.ebs_volume_size_in_gib[0].values[0] #=> Integer
resp.criteria.estimated_monthly_savings #=> Array
resp.criteria.estimated_monthly_savings[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.estimated_monthly_savings[0].values #=> Array
resp.criteria.estimated_monthly_savings[0].values[0] #=> Float
resp.criteria.resource_tag #=> Array
resp.criteria.resource_tag[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.resource_tag[0].key #=> String
resp.criteria.resource_tag[0].values #=> Array
resp.criteria.resource_tag[0].values[0] #=> String
resp.criteria.look_back_period_in_days #=> Array
resp.criteria.look_back_period_in_days[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.look_back_period_in_days[0].values #=> Array
resp.criteria.look_back_period_in_days[0].values[0] #=> Integer
resp.criteria.restart_needed #=> Array
resp.criteria.restart_needed[0].comparison #=> String, one of "StringEquals", "StringNotEquals", "StringEqualsIgnoreCase", "StringNotEqualsIgnoreCase", "StringLike", "StringNotLike", "NumericEquals", "NumericNotEquals", "NumericLessThan", "NumericLessThanEquals", "NumericGreaterThan", "NumericGreaterThanEquals"
resp.criteria.restart_needed[0].values #=> Array
resp.criteria.restart_needed[0].values[0] #=> String
resp.schedule.schedule_expression #=> String
resp.schedule.schedule_expression_timezone #=> String
resp.schedule.execution_window_in_minutes #=> Integer
resp.status #=> String, one of "Active", "Inactive"
resp.created_timestamp #=> Time
resp.last_updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :rule_arn (required, String) —

    The ARN of the rule to update.

  • :rule_revision (required, Integer) —

    The revision number of the rule to update.

  • :name (String) —

    The updated name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.

  • :description (String) —

    The updated description of the automation rule. Can be up to 1024 characters long and contain alphanumeric characters, underscores, hyphens, spaces, and certain special characters.

  • :rule_type (String) —

    The updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.

  • :organization_configuration (Types::OrganizationConfiguration) —

    Updated configuration settings for organization-wide rules, including rule application order and target account IDs.

  • :priority (String) —

    The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.

  • :recommended_action_types (Array<String>) —

    Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.

  • :criteria (Types::Criteria) —

    A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time. You can specify up to 20 conditions per filter criteria and 20 values per condition.

  • :schedule (Types::Schedule) —

    The updated schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.

  • :status (String) —

    The updated status of the automation rule. Can be Active or Inactive.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

See Also:



2132
2133
2134
2135
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 2132

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

#update_enrollment_configuration(params = {}) ⇒ Types::UpdateEnrollmentConfigurationResponse

Updates your account’s Compute Optimizer Automation enrollment configuration.

Examples:

Request syntax with placeholder values


resp = client.update_enrollment_configuration({
  status: "Active", # required, accepts Active, Inactive, Pending, Failed
  client_token: "ClientToken",
})

Response structure


resp.status #=> String, one of "Active", "Inactive", "Pending", "Failed"
resp.status_reason #=> String
resp.last_updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :status (required, String) —

    The desired enrollment status.

    • Active - Enables the Automation feature for your account.

    • Inactive - Disables the Automation feature for your account and stops all of your automation rules. If you opt in again later, all rules will be inactive, and you must enable the rules you want to run. You must wait at least 24 hours after opting out to opt in again.

    <note markdown=“1”> The ‘Pending` and `Failed` options cannot be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account.

    If you are a member account, your account must be disassociated from

    your organization’s management account before you can disable Automation. Contact your administrator to make this change.

    </note>
  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

See Also:



2192
2193
2194
2195
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 2192

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


2221
2222
2223
 
# File 'lib/aws-sdk-computeoptimizerautomation/client.rb', line 2221

def waiter_names
  []
end