# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
require 'seahorse/client/plugins/content_length.rb'
require 'aws-sdk-core/plugins/credentials_configuration.rb'
require 'aws-sdk-core/plugins/logging.rb'
require 'aws-sdk-core/plugins/param_converter.rb'
require 'aws-sdk-core/plugins/param_validator.rb'
require 'aws-sdk-core/plugins/user_agent.rb'
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
require 'aws-sdk-core/plugins/retry_errors.rb'
require 'aws-sdk-core/plugins/global_configuration.rb'
require 'aws-sdk-core/plugins/regional_endpoint.rb'
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
require 'aws-sdk-core/plugins/response_paging.rb'
require 'aws-sdk-core/plugins/stub_responses.rb'
require 'aws-sdk-core/plugins/idempotency_token.rb'
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
require 'aws-sdk-core/plugins/transfer_encoding.rb'
require 'aws-sdk-core/plugins/signature_v4.rb'
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
Aws::Plugins::GlobalConfiguration.add_identifier(:autoscalingplans)
module Aws::AutoScalingPlans
# An API client for AutoScalingPlans. To construct a client, you need to configure a `:region` and `:credentials`.
#
# client = Aws::AutoScalingPlans::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 Client < Seahorse::Client::Base
include Aws::ClientStubs
@identifier = :autoscalingplans
set_api(ClientApi::API)
add_plugin(Seahorse::Client::Plugins::ContentLength)
add_plugin(Aws::Plugins::CredentialsConfiguration)
add_plugin(Aws::Plugins::Logging)
add_plugin(Aws::Plugins::ParamConverter)
add_plugin(Aws::Plugins::ParamValidator)
add_plugin(Aws::Plugins::UserAgent)
add_plugin(Aws::Plugins::HelpfulSocketErrors)
add_plugin(Aws::Plugins::RetryErrors)
add_plugin(Aws::Plugins::GlobalConfiguration)
add_plugin(Aws::Plugins::RegionalEndpoint)
add_plugin(Aws::Plugins::EndpointDiscovery)
add_plugin(Aws::Plugins::EndpointPattern)
add_plugin(Aws::Plugins::ResponsePaging)
add_plugin(Aws::Plugins::StubResponses)
add_plugin(Aws::Plugins::IdempotencyToken)
add_plugin(Aws::Plugins::JsonvalueConverter)
add_plugin(Aws::Plugins::ClientMetricsPlugin)
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
add_plugin(Aws::Plugins::TransferEncoding)
add_plugin(Aws::Plugins::SignatureV4)
add_plugin(Aws::Plugins::Protocols::JsonRpc)
# @overload initialize(options)
# @param [Hash] options
# @option options [required, Aws::CredentialProvider] :credentials
# Your AWS credentials. This can be an instance of any one of the
# following classes:
#
# * `Aws::Credentials` - Used for configuring static, non-refreshing
# credentials.
#
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
# from an EC2 IMDS on an EC2 instance.
#
# * `Aws::SharedCredentials` - Used for loading credentials from a
# shared file, such as `~/.aws/config`.
#
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
#
# When `:credentials` are not configured directly, the following
# locations will be searched for credentials:
#
# * `Aws.config[:credentials]`
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
# * `~/.aws/credentials`
# * `~/.aws/config`
# * EC2 IMDS instance profile - When used by default, the timeouts are
# very aggressive. Construct and pass an instance of
# `Aws::InstanceProfileCredentails` to enable retries and extended
# timeouts.
#
# @option options [required, String] :region
# The AWS region to connect to. The configured `:region` is
# used to determine the service `:endpoint`. When not passed,
# a default `:region` is searched for in the following locations:
#
# * `Aws.config[:region]`
# * `ENV['AWS_REGION']`
# * `ENV['AMAZON_REGION']`
# * `ENV['AWS_DEFAULT_REGION']`
# * `~/.aws/credentials`
# * `~/.aws/config`
#
# @option options [String] :access_key_id
#
# @option options [Boolean] :active_endpoint_cache (false)
# When set to `true`, a thread polling for endpoints will be running in
# the background every 60 secs (default). Defaults to `false`.
#
# @option options [Boolean] :adaptive_retry_wait_to_fill (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.
#
# @option options [Boolean] :client_side_monitoring (false)
# When `true`, client-side metrics will be collected for all API requests from
# this client.
#
# @option options [String] :client_side_monitoring_client_id ("")
# Allows you to provide an identifier for this client which will be attached to
# all generated client side metrics. Defaults to an empty string.
#
# @option options [String] :client_side_monitoring_host ("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.
#
# @option options [Integer] :client_side_monitoring_port (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.
#
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
# Allows you to provide a custom client-side monitoring publisher class. By default,
# will use the Client Side Monitoring Agent Publisher.
#
# @option options [Boolean] :convert_params (true)
# When `true`, an attempt is made to coerce request parameters into
# the required types.
#
# @option options [Boolean] :correct_clock_skew (true)
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
# a clock skew correction and retry requests with skewed client clocks.
#
# @option options [Boolean] :disable_host_prefix_injection (false)
# Set to true to disable SDK automatically adding host prefix
# to default service endpoint when available.
#
# @option options [String] :endpoint
# The client endpoint is normally constructed from the `:region`
# option. You should only configure an `:endpoint` when connecting
# to test endpoints. This should be a valid HTTP(S) URI.
#
# @option options [Integer] :endpoint_cache_max_entries (1000)
# Used for the maximum size limit of the LRU cache storing endpoints data
# for endpoint discovery enabled operations. Defaults to 1000.
#
# @option options [Integer] :endpoint_cache_max_threads (10)
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
#
# @option options [Integer] :endpoint_cache_poll_interval (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.
#
# @option options [Boolean] :endpoint_discovery (false)
# When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
#
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
# The log formatter.
#
# @option options [Symbol] :log_level (:info)
# The log level to send messages to the `:logger` at.
#
# @option options [Logger] :logger
# The Logger instance to send log messages to. If this option
# is not set, logging will be disabled.
#
# @option options [Integer] :max_attempts (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.
#
# @option options [String] :profile ("default")
# Used when loading credentials from the shared credentials file
# at HOME/.aws/credentials. When not specified, 'default' is used.
#
# @option options [Proc] :retry_backoff
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
# This option is only used in the `legacy` retry mode.
#
# @option options [Float] :retry_base_delay (0.3)
# The base delay in seconds used by the default backoff function. This option
# is only used in the `legacy` retry mode.
#
# @option options [Symbol] :retry_jitter (:none)
# A delay randomiser function used by the default backoff function.
# Some predefined functions can be referenced by name - :none, :equal, :full,
# otherwise a Proc that takes and returns a number. This option is only used
# in the `legacy` retry mode.
#
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
#
# @option options [Integer] :retry_limit (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.
#
# @option options [Integer] :retry_max_delay (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.
#
# @option options [String] :retry_mode ("legacy")
# Specifies which retry algorithm to use. Values are:
#
# * `legacy` - The pre-existing retry behavior. This is default value if
# no retry mode is provided.
#
# * `standard` - A standardized set of retry rules across the AWS SDKs.
# This includes support for retry quotas, which limit the number of
# unsuccessful retries a client can make.
#
# * `adaptive` - An experimental retry mode that includes all the
# functionality of `standard` mode along with automatic client side
# throttling. This is a provisional mode that may change behavior
# in the future.
#
#
# @option options [String] :secret_access_key
#
# @option options [String] :session_token
#
# @option options [Boolean] :simple_json (false)
# Disables request parameter conversion, validation, and formatting.
# Also disable response data type conversions. 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.
#
# When `:simple_json` is enabled, the request parameters hash must
# be formatted exactly as the DynamoDB API expects.
#
# @option options [Boolean] :stub_responses (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.
#
# @option options [Boolean] :validate_params (true)
# When `true`, request parameters are validated before
# sending the request.
#
# @option options [URI::HTTP,String] :http_proxy A proxy to send
# requests through. Formatted like 'http://proxy.com:123'.
#
# @option options [Float] :http_open_timeout (15) The number of
# seconds to wait when opening a HTTP session before raising a
# `Timeout::Error`.
#
# @option options [Integer] :http_read_timeout (60) The default
# number of seconds to wait for response data. This value can
# safely be set per-request on the session.
#
# @option options [Float] :http_idle_timeout (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.
#
# @option options [Float] :http_continue_timeout (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.
#
# @option options [Boolean] :http_wire_trace (false) When `true`,
# HTTP debug output will be sent to the `:logger`.
#
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
# SSL peer certificates are verified when establishing a
# connection.
#
# @option options [String] :ssl_ca_bundle 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.
#
# @option options [String] :ssl_ca_directory 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.
#
def initialize(*args)
super
end
# @!group API Operations
# Creates a scaling plan.
#
# @option params [required, String] :scaling_plan_name
# The name of the scaling plan. Names cannot contain vertical bars,
# colons, or forward slashes.
#
# @option params [required, Types::ApplicationSource] :application_source
# A CloudFormation stack or set of tags. You can create one scaling plan
# per application source.
#
# @option params [required, Array<Types::ScalingInstruction>] :scaling_instructions
# The scaling instructions.
#
# @return [Types::CreateScalingPlanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateScalingPlanResponse#scaling_plan_version #scaling_plan_version} => Integer
#
# @example Request syntax with placeholder values
#
# resp = client.create_scaling_plan({
# scaling_plan_name: "ScalingPlanName", # required
# application_source: { # required
# cloud_formation_stack_arn: "XmlString",
# tag_filters: [
# {
# key: "XmlStringMaxLen128",
# values: ["XmlStringMaxLen256"],
# },
# ],
# },
# scaling_instructions: [ # required
# {
# service_namespace: "autoscaling", # required, accepts autoscaling, ecs, ec2, rds, dynamodb
# resource_id: "ResourceIdMaxLen1600", # required
# scalable_dimension: "autoscaling:autoScalingGroup:DesiredCapacity", # required, accepts autoscaling:autoScalingGroup:DesiredCapacity, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits
# min_capacity: 1, # required
# max_capacity: 1, # required
# target_tracking_configurations: [ # required
# {
# predefined_scaling_metric_specification: {
# predefined_scaling_metric_type: "ASGAverageCPUUtilization", # required, accepts ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, ALBRequestCountPerTarget, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut
# resource_label: "ResourceLabel",
# },
# customized_scaling_metric_specification: {
# metric_name: "MetricName", # required
# namespace: "MetricNamespace", # required
# dimensions: [
# {
# name: "MetricDimensionName", # required
# value: "MetricDimensionValue", # required
# },
# ],
# statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum
# unit: "MetricUnit",
# },
# target_value: 1.0, # required
# disable_scale_in: false,
# scale_out_cooldown: 1,
# scale_in_cooldown: 1,
# estimated_instance_warmup: 1,
# },
# ],
# predefined_load_metric_specification: {
# predefined_load_metric_type: "ASGTotalCPUUtilization", # required, accepts ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut, ALBTargetGroupRequestCount
# resource_label: "ResourceLabel",
# },
# customized_load_metric_specification: {
# metric_name: "MetricName", # required
# namespace: "MetricNamespace", # required
# dimensions: [
# {
# name: "MetricDimensionName", # required
# value: "MetricDimensionValue", # required
# },
# ],
# statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum
# unit: "MetricUnit",
# },
# scheduled_action_buffer_time: 1,
# predictive_scaling_max_capacity_behavior: "SetForecastCapacityToMaxCapacity", # accepts SetForecastCapacityToMaxCapacity, SetMaxCapacityToForecastCapacity, SetMaxCapacityAboveForecastCapacity
# predictive_scaling_max_capacity_buffer: 1,
# predictive_scaling_mode: "ForecastAndScale", # accepts ForecastAndScale, ForecastOnly
# scaling_policy_update_behavior: "KeepExternalPolicies", # accepts KeepExternalPolicies, ReplaceExternalPolicies
# disable_dynamic_scaling: false,
# },
# ],
# })
#
# @example Response structure
#
# resp.scaling_plan_version #=> Integer
#
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/CreateScalingPlan AWS API Documentation
#
# @overload create_scaling_plan(params = {})
# @param [Hash] params ({})
def create_scaling_plan(params = {}, options = {})
req = build_request(:create_scaling_plan, params)
req.send_request(options)
end
# Deletes the specified scaling plan.
#
# Deleting a scaling plan deletes the underlying ScalingInstruction for
# all of the scalable resources that are covered by the plan.
#
# If the plan has launched resources or has scaling activities in
# progress, you must delete those resources separately.
#
# @option params [required, String] :scaling_plan_name
# The name of the scaling plan.
#
# @option params [required, Integer] :scaling_plan_version
# The version number of the scaling plan.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_scaling_plan({
# scaling_plan_name: "ScalingPlanName", # required
# scaling_plan_version: 1, # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DeleteScalingPlan AWS API Documentation
#
# @overload delete_scaling_plan(params = {})
# @param [Hash] params ({})
def delete_scaling_plan(params = {}, options = {})
req = build_request(:delete_scaling_plan, params)
req.send_request(options)
end
# Describes the scalable resources in the specified scaling plan.
#
# @option params [required, String] :scaling_plan_name
# The name of the scaling plan.
#
# @option params [required, Integer] :scaling_plan_version
# The version number of the scaling plan.
#
# @option params [Integer] :max_results
# The maximum number of scalable resources to return. The value must be
# between 1 and 50. The default value is 50.
#
# @option params [String] :next_token
# The token for the next set of results.
#
# @return [Types::DescribeScalingPlanResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeScalingPlanResourcesResponse#scaling_plan_resources #scaling_plan_resources} => Array<Types::ScalingPlanResource>
# * {Types::DescribeScalingPlanResourcesResponse#next_token #next_token} => String
#
# @example Request syntax with placeholder values
#
# resp = client.describe_scaling_plan_resources({
# scaling_plan_name: "ScalingPlanName", # required
# scaling_plan_version: 1, # required
# max_results: 1,
# next_token: "NextToken",
# })
#
# @example Response structure
#
# resp.scaling_plan_resources #=> Array
# resp.scaling_plan_resources[0].scaling_plan_name #=> String
# resp.scaling_plan_resources[0].scaling_plan_version #=> Integer
# resp.scaling_plan_resources[0].service_namespace #=> String, one of "autoscaling", "ecs", "ec2", "rds", "dynamodb"
# resp.scaling_plan_resources[0].resource_id #=> String
# resp.scaling_plan_resources[0].scalable_dimension #=> String, one of "autoscaling:autoScalingGroup:DesiredCapacity", "ecs:service:DesiredCount", "ec2:spot-fleet-request:TargetCapacity", "rds:cluster:ReadReplicaCount", "dynamodb:table:ReadCapacityUnits", "dynamodb:table:WriteCapacityUnits", "dynamodb:index:ReadCapacityUnits", "dynamodb:index:WriteCapacityUnits"
# resp.scaling_plan_resources[0].scaling_policies #=> Array
# resp.scaling_plan_resources[0].scaling_policies[0].policy_name #=> String
# resp.scaling_plan_resources[0].scaling_policies[0].policy_type #=> String, one of "TargetTrackingScaling"
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.predefined_scaling_metric_specification.predefined_scaling_metric_type #=> String, one of "ASGAverageCPUUtilization", "ASGAverageNetworkIn", "ASGAverageNetworkOut", "DynamoDBReadCapacityUtilization", "DynamoDBWriteCapacityUtilization", "ECSServiceAverageCPUUtilization", "ECSServiceAverageMemoryUtilization", "ALBRequestCountPerTarget", "RDSReaderAverageCPUUtilization", "RDSReaderAverageDatabaseConnections", "EC2SpotFleetRequestAverageCPUUtilization", "EC2SpotFleetRequestAverageNetworkIn", "EC2SpotFleetRequestAverageNetworkOut"
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.predefined_scaling_metric_specification.resource_label #=> String
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.metric_name #=> String
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.namespace #=> String
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.dimensions #=> Array
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.dimensions[0].name #=> String
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.dimensions[0].value #=> String
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.statistic #=> String, one of "Average", "Minimum", "Maximum", "SampleCount", "Sum"
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.unit #=> String
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.target_value #=> Float
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.disable_scale_in #=> Boolean
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.scale_out_cooldown #=> Integer
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.scale_in_cooldown #=> Integer
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.estimated_instance_warmup #=> Integer
# resp.scaling_plan_resources[0].scaling_status_code #=> String, one of "Inactive", "PartiallyActive", "Active"
# resp.scaling_plan_resources[0].scaling_status_message #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DescribeScalingPlanResources AWS API Documentation
#
# @overload describe_scaling_plan_resources(params = {})
# @param [Hash] params ({})
def describe_scaling_plan_resources(params = {}, options = {})
req = build_request(:describe_scaling_plan_resources, params)
req.send_request(options)
end
# Describes one or more of your scaling plans.
#
# @option params [Array<String>] :scaling_plan_names
# The names of the scaling plans (up to 10). If you specify application
# sources, you cannot specify scaling plan names.
#
# @option params [Integer] :scaling_plan_version
# The version number of the scaling plan. If you specify a scaling plan
# version, you must also specify a scaling plan name.
#
# @option params [Array<Types::ApplicationSource>] :application_sources
# The sources for the applications (up to 10). If you specify scaling
# plan names, you cannot specify application sources.
#
# @option params [Integer] :max_results
# The maximum number of scalable resources to return. This value can be
# between 1 and 50. The default value is 50.
#
# @option params [String] :next_token
# The token for the next set of results.
#
# @return [Types::DescribeScalingPlansResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeScalingPlansResponse#scaling_plans #scaling_plans} => Array<Types::ScalingPlan>
# * {Types::DescribeScalingPlansResponse#next_token #next_token} => String
#
# @example Request syntax with placeholder values
#
# resp = client.describe_scaling_plans({
# scaling_plan_names: ["ScalingPlanName"],
# scaling_plan_version: 1,
# application_sources: [
# {
# cloud_formation_stack_arn: "XmlString",
# tag_filters: [
# {
# key: "XmlStringMaxLen128",
# values: ["XmlStringMaxLen256"],
# },
# ],
# },
# ],
# max_results: 1,
# next_token: "NextToken",
# })
#
# @example Response structure
#
# resp.scaling_plans #=> Array
# resp.scaling_plans[0].scaling_plan_name #=> String
# resp.scaling_plans[0].scaling_plan_version #=> Integer
# resp.scaling_plans[0].application_source.cloud_formation_stack_arn #=> String
# resp.scaling_plans[0].application_source.tag_filters #=> Array
# resp.scaling_plans[0].application_source.tag_filters[0].key #=> String
# resp.scaling_plans[0].application_source.tag_filters[0].values #=> Array
# resp.scaling_plans[0].application_source.tag_filters[0].values[0] #=> String
# resp.scaling_plans[0].scaling_instructions #=> Array
# resp.scaling_plans[0].scaling_instructions[0].service_namespace #=> String, one of "autoscaling", "ecs", "ec2", "rds", "dynamodb"
# resp.scaling_plans[0].scaling_instructions[0].resource_id #=> String
# resp.scaling_plans[0].scaling_instructions[0].scalable_dimension #=> String, one of "autoscaling:autoScalingGroup:DesiredCapacity", "ecs:service:DesiredCount", "ec2:spot-fleet-request:TargetCapacity", "rds:cluster:ReadReplicaCount", "dynamodb:table:ReadCapacityUnits", "dynamodb:table:WriteCapacityUnits", "dynamodb:index:ReadCapacityUnits", "dynamodb:index:WriteCapacityUnits"
# resp.scaling_plans[0].scaling_instructions[0].min_capacity #=> Integer
# resp.scaling_plans[0].scaling_instructions[0].max_capacity #=> Integer
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations #=> Array
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].predefined_scaling_metric_specification.predefined_scaling_metric_type #=> String, one of "ASGAverageCPUUtilization", "ASGAverageNetworkIn", "ASGAverageNetworkOut", "DynamoDBReadCapacityUtilization", "DynamoDBWriteCapacityUtilization", "ECSServiceAverageCPUUtilization", "ECSServiceAverageMemoryUtilization", "ALBRequestCountPerTarget", "RDSReaderAverageCPUUtilization", "RDSReaderAverageDatabaseConnections", "EC2SpotFleetRequestAverageCPUUtilization", "EC2SpotFleetRequestAverageNetworkIn", "EC2SpotFleetRequestAverageNetworkOut"
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].predefined_scaling_metric_specification.resource_label #=> String
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.metric_name #=> String
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.namespace #=> String
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.dimensions #=> Array
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.dimensions[0].name #=> String
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.dimensions[0].value #=> String
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.statistic #=> String, one of "Average", "Minimum", "Maximum", "SampleCount", "Sum"
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.unit #=> String
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].target_value #=> Float
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].disable_scale_in #=> Boolean
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].scale_out_cooldown #=> Integer
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].scale_in_cooldown #=> Integer
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].estimated_instance_warmup #=> Integer
# resp.scaling_plans[0].scaling_instructions[0].predefined_load_metric_specification.predefined_load_metric_type #=> String, one of "ASGTotalCPUUtilization", "ASGTotalNetworkIn", "ASGTotalNetworkOut", "ALBTargetGroupRequestCount"
# resp.scaling_plans[0].scaling_instructions[0].predefined_load_metric_specification.resource_label #=> String
# resp.scaling_plans[0].scaling_instructions[0].customized_load_metric_specification.metric_name #=> String
# resp.scaling_plans[0].scaling_instructions[0].customized_load_metric_specification.namespace #=> String
# resp.scaling_plans[0].scaling_instructions[0].customized_load_metric_specification.dimensions #=> Array
# resp.scaling_plans[0].scaling_instructions[0].customized_load_metric_specification.dimensions[0].name #=> String
# resp.scaling_plans[0].scaling_instructions[0].customized_load_metric_specification.dimensions[0].value #=> String
# resp.scaling_plans[0].scaling_instructions[0].customized_load_metric_specification.statistic #=> String, one of "Average", "Minimum", "Maximum", "SampleCount", "Sum"
# resp.scaling_plans[0].scaling_instructions[0].customized_load_metric_specification.unit #=> String
# resp.scaling_plans[0].scaling_instructions[0].scheduled_action_buffer_time #=> Integer
# resp.scaling_plans[0].scaling_instructions[0].predictive_scaling_max_capacity_behavior #=> String, one of "SetForecastCapacityToMaxCapacity", "SetMaxCapacityToForecastCapacity", "SetMaxCapacityAboveForecastCapacity"
# resp.scaling_plans[0].scaling_instructions[0].predictive_scaling_max_capacity_buffer #=> Integer
# resp.scaling_plans[0].scaling_instructions[0].predictive_scaling_mode #=> String, one of "ForecastAndScale", "ForecastOnly"
# resp.scaling_plans[0].scaling_instructions[0].scaling_policy_update_behavior #=> String, one of "KeepExternalPolicies", "ReplaceExternalPolicies"
# resp.scaling_plans[0].scaling_instructions[0].disable_dynamic_scaling #=> Boolean
# resp.scaling_plans[0].status_code #=> String, one of "Active", "ActiveWithProblems", "CreationInProgress", "CreationFailed", "DeletionInProgress", "DeletionFailed", "UpdateInProgress", "UpdateFailed"
# resp.scaling_plans[0].status_message #=> String
# resp.scaling_plans[0].status_start_time #=> Time
# resp.scaling_plans[0].creation_time #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DescribeScalingPlans AWS API Documentation
#
# @overload describe_scaling_plans(params = {})
# @param [Hash] params ({})
def describe_scaling_plans(params = {}, options = {})
req = build_request(:describe_scaling_plans, params)
req.send_request(options)
end
# Retrieves the forecast data for a scalable resource.
#
# Capacity forecasts are represented as predicted values, or data
# points, that are calculated using historical data points from a
# specified CloudWatch load metric. Data points are available for up to
# 56 days.
#
# @option params [required, String] :scaling_plan_name
# The name of the scaling plan.
#
# @option params [required, Integer] :scaling_plan_version
# The version number of the scaling plan.
#
# @option params [required, String] :service_namespace
# The namespace of the AWS service.
#
# @option params [required, String] :resource_id
# The ID of the resource. This string consists of the resource type and
# unique identifier.
#
# * Auto Scaling group - The resource type is `autoScalingGroup` and the
# unique identifier is the name of the Auto Scaling group. Example:
# `autoScalingGroup/my-asg`.
#
# * ECS service - The resource type is `service` and the unique
# identifier is the cluster name and service name. Example:
# `service/default/sample-webapp`.
#
# * Spot Fleet request - The resource type is `spot-fleet-request` and
# the unique identifier is the Spot Fleet request ID. Example:
# `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`.
#
# * DynamoDB table - The resource type is `table` and the unique
# identifier is the resource ID. Example: `table/my-table`.
#
# * DynamoDB global secondary index - The resource type is `index` and
# the unique identifier is the resource ID. Example:
# `table/my-table/index/my-table-index`.
#
# * Aurora DB cluster - The resource type is `cluster` and the unique
# identifier is the cluster name. Example: `cluster:my-db-cluster`.
#
# @option params [required, String] :scalable_dimension
# The scalable dimension for the resource.
#
# @option params [required, String] :forecast_data_type
# The type of forecast data to get.
#
# * `LoadForecast`\: The load metric forecast.
#
# * `CapacityForecast`\: The capacity forecast.
#
# * `ScheduledActionMinCapacity`\: The minimum capacity for each
# scheduled scaling action. This data is calculated as the larger of
# two values: the capacity forecast or the minimum capacity in the
# scaling instruction.
#
# * `ScheduledActionMaxCapacity`\: The maximum capacity for each
# scheduled scaling action. The calculation used is determined by the
# predictive scaling maximum capacity behavior setting in the scaling
# instruction.
#
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
# The inclusive start time of the time range for the forecast data to
# get. The date and time can be at most 56 days before the current date
# and time.
#
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
# The exclusive end time of the time range for the forecast data to get.
# The maximum time duration between the start and end time is seven
# days.
#
# Although this parameter can accept a date and time that is more than
# two days in the future, the availability of forecast data has limits.
# AWS Auto Scaling only issues forecasts for periods of two days in
# advance.
#
# @return [Types::GetScalingPlanResourceForecastDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetScalingPlanResourceForecastDataResponse#datapoints #datapoints} => Array<Types::Datapoint>
#
# @example Request syntax with placeholder values
#
# resp = client.get_scaling_plan_resource_forecast_data({
# scaling_plan_name: "ScalingPlanName", # required
# scaling_plan_version: 1, # required
# service_namespace: "autoscaling", # required, accepts autoscaling, ecs, ec2, rds, dynamodb
# resource_id: "XmlString", # required
# scalable_dimension: "autoscaling:autoScalingGroup:DesiredCapacity", # required, accepts autoscaling:autoScalingGroup:DesiredCapacity, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits
# forecast_data_type: "CapacityForecast", # required, accepts CapacityForecast, LoadForecast, ScheduledActionMinCapacity, ScheduledActionMaxCapacity
# start_time: Time.now, # required
# end_time: Time.now, # required
# })
#
# @example Response structure
#
# resp.datapoints #=> Array
# resp.datapoints[0].timestamp #=> Time
# resp.datapoints[0].value #=> Float
#
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/GetScalingPlanResourceForecastData AWS API Documentation
#
# @overload get_scaling_plan_resource_forecast_data(params = {})
# @param [Hash] params ({})
def get_scaling_plan_resource_forecast_data(params = {}, options = {})
req = build_request(:get_scaling_plan_resource_forecast_data, params)
req.send_request(options)
end
# Updates the specified scaling plan.
#
# You cannot update a scaling plan if it is in the process of being
# created, updated, or deleted.
#
# @option params [required, String] :scaling_plan_name
# The name of the scaling plan.
#
# @option params [required, Integer] :scaling_plan_version
# The version number of the scaling plan.
#
# @option params [Types::ApplicationSource] :application_source
# A CloudFormation stack or set of tags.
#
# @option params [Array<Types::ScalingInstruction>] :scaling_instructions
# The scaling instructions.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.update_scaling_plan({
# scaling_plan_name: "ScalingPlanName", # required
# scaling_plan_version: 1, # required
# application_source: {
# cloud_formation_stack_arn: "XmlString",
# tag_filters: [
# {
# key: "XmlStringMaxLen128",
# values: ["XmlStringMaxLen256"],
# },
# ],
# },
# scaling_instructions: [
# {
# service_namespace: "autoscaling", # required, accepts autoscaling, ecs, ec2, rds, dynamodb
# resource_id: "ResourceIdMaxLen1600", # required
# scalable_dimension: "autoscaling:autoScalingGroup:DesiredCapacity", # required, accepts autoscaling:autoScalingGroup:DesiredCapacity, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits
# min_capacity: 1, # required
# max_capacity: 1, # required
# target_tracking_configurations: [ # required
# {
# predefined_scaling_metric_specification: {
# predefined_scaling_metric_type: "ASGAverageCPUUtilization", # required, accepts ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, ALBRequestCountPerTarget, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut
# resource_label: "ResourceLabel",
# },
# customized_scaling_metric_specification: {
# metric_name: "MetricName", # required
# namespace: "MetricNamespace", # required
# dimensions: [
# {
# name: "MetricDimensionName", # required
# value: "MetricDimensionValue", # required
# },
# ],
# statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum
# unit: "MetricUnit",
# },
# target_value: 1.0, # required
# disable_scale_in: false,
# scale_out_cooldown: 1,
# scale_in_cooldown: 1,
# estimated_instance_warmup: 1,
# },
# ],
# predefined_load_metric_specification: {
# predefined_load_metric_type: "ASGTotalCPUUtilization", # required, accepts ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut, ALBTargetGroupRequestCount
# resource_label: "ResourceLabel",
# },
# customized_load_metric_specification: {
# metric_name: "MetricName", # required
# namespace: "MetricNamespace", # required
# dimensions: [
# {
# name: "MetricDimensionName", # required
# value: "MetricDimensionValue", # required
# },
# ],
# statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum
# unit: "MetricUnit",
# },
# scheduled_action_buffer_time: 1,
# predictive_scaling_max_capacity_behavior: "SetForecastCapacityToMaxCapacity", # accepts SetForecastCapacityToMaxCapacity, SetMaxCapacityToForecastCapacity, SetMaxCapacityAboveForecastCapacity
# predictive_scaling_max_capacity_buffer: 1,
# predictive_scaling_mode: "ForecastAndScale", # accepts ForecastAndScale, ForecastOnly
# scaling_policy_update_behavior: "KeepExternalPolicies", # accepts KeepExternalPolicies, ReplaceExternalPolicies
# disable_dynamic_scaling: false,
# },
# ],
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/UpdateScalingPlan AWS API Documentation
#
# @overload update_scaling_plan(params = {})
# @param [Hash] params ({})
def update_scaling_plan(params = {}, options = {})
req = build_request(:update_scaling_plan, params)
req.send_request(options)
end
# @!endgroup
# @param params ({})
# @api private
def build_request(operation_name, params = {})
handlers = @handlers.for(operation_name)
context = Seahorse::Client::RequestContext.new(
operation_name: operation_name,
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-autoscalingplans'
context[:gem_version] = '1.22.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated
def waiter_names
[]
end
class << self
# @api private
attr_reader :identifier
# @api private
def errors_module
Errors
end
end
end
end