aws-sdk-autoscalingplans 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-autoscalingplans.rb +47 -0
- data/lib/aws-sdk-autoscalingplans/client.rb +411 -0
- data/lib/aws-sdk-autoscalingplans/client_api.rb +248 -0
- data/lib/aws-sdk-autoscalingplans/customizations.rb +0 -0
- data/lib/aws-sdk-autoscalingplans/errors.rb +14 -0
- data/lib/aws-sdk-autoscalingplans/resource.rb +23 -0
- data/lib/aws-sdk-autoscalingplans/types.rb +531 -0
- metadata +82 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 505aa2da091ea523ece408a1949c6783d16865f0
|
4
|
+
data.tar.gz: 78c37f02d8ae87838e751fb96ea2251751ae622b
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 92482b926b043a365f2da3b5eff1ad97ae7a4ac88f0b2f032a19540cd5848b8e6bb90b3e7dad6c48b2e20e504f9651360a6820affdb6e0e4d1ed0dfef6f40395
|
7
|
+
data.tar.gz: 72791373a6ef2b864a26e807a745dc8b2a3ebc1358ee5b0798db37040474ea04f74eee028afbba26a1bda5acc4d1feeb3b04eb5e53906591f6e9ba8d8c5f69f3
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-autoscalingplans/types'
|
12
|
+
require_relative 'aws-sdk-autoscalingplans/client_api'
|
13
|
+
require_relative 'aws-sdk-autoscalingplans/client'
|
14
|
+
require_relative 'aws-sdk-autoscalingplans/errors'
|
15
|
+
require_relative 'aws-sdk-autoscalingplans/resource'
|
16
|
+
require_relative 'aws-sdk-autoscalingplans/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS Auto Scaling Plans. This module is available in the
|
19
|
+
# `aws-sdk-autoscalingplans` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from AWS Auto Scaling Plans all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::AutoScalingPlans::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::AutoScalingPlans
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,411 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
22
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
23
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
24
|
+
|
25
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:autoscalingplans)
|
26
|
+
|
27
|
+
module Aws::AutoScalingPlans
|
28
|
+
class Client < Seahorse::Client::Base
|
29
|
+
|
30
|
+
include Aws::ClientStubs
|
31
|
+
|
32
|
+
@identifier = :autoscalingplans
|
33
|
+
|
34
|
+
set_api(ClientApi::API)
|
35
|
+
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
49
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
50
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
51
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
52
|
+
|
53
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
54
|
+
# Your AWS credentials. This can be an instance of any one of the
|
55
|
+
# following classes:
|
56
|
+
#
|
57
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
58
|
+
# credentials.
|
59
|
+
#
|
60
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
61
|
+
# from an EC2 IMDS on an EC2 instance.
|
62
|
+
#
|
63
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
64
|
+
# shared file, such as `~/.aws/config`.
|
65
|
+
#
|
66
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
67
|
+
#
|
68
|
+
# When `:credentials` are not configured directly, the following
|
69
|
+
# locations will be searched for credentials:
|
70
|
+
#
|
71
|
+
# * `Aws.config[:credentials]`
|
72
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
73
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
74
|
+
# * `~/.aws/credentials`
|
75
|
+
# * `~/.aws/config`
|
76
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
77
|
+
# very aggressive. Construct and pass an instance of
|
78
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
79
|
+
# timeouts.
|
80
|
+
#
|
81
|
+
# @option options [required, String] :region
|
82
|
+
# The AWS region to connect to. The configured `:region` is
|
83
|
+
# used to determine the service `:endpoint`. When not passed,
|
84
|
+
# a default `:region` is search for in the following locations:
|
85
|
+
#
|
86
|
+
# * `Aws.config[:region]`
|
87
|
+
# * `ENV['AWS_REGION']`
|
88
|
+
# * `ENV['AMAZON_REGION']`
|
89
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
90
|
+
# * `~/.aws/credentials`
|
91
|
+
# * `~/.aws/config`
|
92
|
+
#
|
93
|
+
# @option options [String] :access_key_id
|
94
|
+
#
|
95
|
+
# @option options [Boolean] :convert_params (true)
|
96
|
+
# When `true`, an attempt is made to coerce request parameters into
|
97
|
+
# the required types.
|
98
|
+
#
|
99
|
+
# @option options [String] :endpoint
|
100
|
+
# The client endpoint is normally constructed from the `:region`
|
101
|
+
# option. You should only configure an `:endpoint` when connecting
|
102
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
103
|
+
#
|
104
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
105
|
+
# The log formatter.
|
106
|
+
#
|
107
|
+
# @option options [Symbol] :log_level (:info)
|
108
|
+
# The log level to send messages to the `:logger` at.
|
109
|
+
#
|
110
|
+
# @option options [Logger] :logger
|
111
|
+
# The Logger instance to send log messages to. If this option
|
112
|
+
# is not set, logging will be disabled.
|
113
|
+
#
|
114
|
+
# @option options [String] :profile ("default")
|
115
|
+
# Used when loading credentials from the shared credentials file
|
116
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
117
|
+
#
|
118
|
+
# @option options [Integer] :retry_limit (3)
|
119
|
+
# The maximum number of times to retry failed requests. Only
|
120
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
121
|
+
# are retried. Generally, these are throttling errors, data
|
122
|
+
# checksum errors, networking errors, timeout errors and auth
|
123
|
+
# errors from expired credentials.
|
124
|
+
#
|
125
|
+
# @option options [String] :secret_access_key
|
126
|
+
#
|
127
|
+
# @option options [String] :session_token
|
128
|
+
#
|
129
|
+
# @option options [Boolean] :simple_json (false)
|
130
|
+
# Disables request parameter conversion, validation, and formatting.
|
131
|
+
# Also disable response data type conversions. This option is useful
|
132
|
+
# when you want to ensure the highest level of performance by
|
133
|
+
# avoiding overhead of walking request parameters and response data
|
134
|
+
# structures.
|
135
|
+
#
|
136
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
137
|
+
# be formatted exactly as the DynamoDB API expects.
|
138
|
+
#
|
139
|
+
# @option options [Boolean] :stub_responses (false)
|
140
|
+
# Causes the client to return stubbed responses. By default
|
141
|
+
# fake responses are generated and returned. You can specify
|
142
|
+
# the response data to return or errors to raise by calling
|
143
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
144
|
+
#
|
145
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
146
|
+
# requests are made, and retries are disabled.
|
147
|
+
#
|
148
|
+
# @option options [Boolean] :validate_params (true)
|
149
|
+
# When `true`, request parameters are validated before
|
150
|
+
# sending the request.
|
151
|
+
#
|
152
|
+
def initialize(*args)
|
153
|
+
super
|
154
|
+
end
|
155
|
+
|
156
|
+
# @!group API Operations
|
157
|
+
|
158
|
+
# @option params [required, String] :scaling_plan_name
|
159
|
+
#
|
160
|
+
# @option params [required, Types::ApplicationSource] :application_source
|
161
|
+
#
|
162
|
+
# @option params [required, Array<Types::ScalingInstruction>] :scaling_instructions
|
163
|
+
#
|
164
|
+
# @return [Types::CreateScalingPlanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
165
|
+
#
|
166
|
+
# * {Types::CreateScalingPlanResponse#scaling_plan_version #scaling_plan_version} => Integer
|
167
|
+
#
|
168
|
+
# @example Request syntax with placeholder values
|
169
|
+
#
|
170
|
+
# resp = client.create_scaling_plan({
|
171
|
+
# scaling_plan_name: "ScalingPlanName", # required
|
172
|
+
# application_source: { # required
|
173
|
+
# cloud_formation_stack_arn: "XmlString",
|
174
|
+
# },
|
175
|
+
# scaling_instructions: [ # required
|
176
|
+
# {
|
177
|
+
# service_namespace: "autoscaling", # required, accepts autoscaling, ecs, ec2, rds, dynamodb
|
178
|
+
# resource_id: "ResourceIdMaxLen1600", # required
|
179
|
+
# 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
|
180
|
+
# min_capacity: 1, # required
|
181
|
+
# max_capacity: 1, # required
|
182
|
+
# target_tracking_configurations: [ # required
|
183
|
+
# {
|
184
|
+
# predefined_scaling_metric_specification: {
|
185
|
+
# predefined_scaling_metric_type: "ASGAverageCPUUtilization", # required, accepts ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, ALBRequestCountPerTarget, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut
|
186
|
+
# resource_label: "ResourceLabel",
|
187
|
+
# },
|
188
|
+
# customized_scaling_metric_specification: {
|
189
|
+
# metric_name: "MetricName", # required
|
190
|
+
# namespace: "MetricNamespace", # required
|
191
|
+
# dimensions: [
|
192
|
+
# {
|
193
|
+
# name: "MetricDimensionName", # required
|
194
|
+
# value: "MetricDimensionValue", # required
|
195
|
+
# },
|
196
|
+
# ],
|
197
|
+
# statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum
|
198
|
+
# unit: "MetricUnit",
|
199
|
+
# },
|
200
|
+
# target_value: 1.0, # required
|
201
|
+
# disable_scale_in: false,
|
202
|
+
# scale_out_cooldown: 1,
|
203
|
+
# scale_in_cooldown: 1,
|
204
|
+
# estimated_instance_warmup: 1,
|
205
|
+
# },
|
206
|
+
# ],
|
207
|
+
# },
|
208
|
+
# ],
|
209
|
+
# })
|
210
|
+
#
|
211
|
+
# @example Response structure
|
212
|
+
#
|
213
|
+
# resp.scaling_plan_version #=> Integer
|
214
|
+
#
|
215
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/CreateScalingPlan AWS API Documentation
|
216
|
+
#
|
217
|
+
# @overload create_scaling_plan(params = {})
|
218
|
+
# @param [Hash] params ({})
|
219
|
+
def create_scaling_plan(params = {}, options = {})
|
220
|
+
req = build_request(:create_scaling_plan, params)
|
221
|
+
req.send_request(options)
|
222
|
+
end
|
223
|
+
|
224
|
+
# @option params [required, String] :scaling_plan_name
|
225
|
+
#
|
226
|
+
# @option params [required, Integer] :scaling_plan_version
|
227
|
+
#
|
228
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
229
|
+
#
|
230
|
+
# @example Request syntax with placeholder values
|
231
|
+
#
|
232
|
+
# resp = client.delete_scaling_plan({
|
233
|
+
# scaling_plan_name: "ScalingPlanName", # required
|
234
|
+
# scaling_plan_version: 1, # required
|
235
|
+
# })
|
236
|
+
#
|
237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DeleteScalingPlan AWS API Documentation
|
238
|
+
#
|
239
|
+
# @overload delete_scaling_plan(params = {})
|
240
|
+
# @param [Hash] params ({})
|
241
|
+
def delete_scaling_plan(params = {}, options = {})
|
242
|
+
req = build_request(:delete_scaling_plan, params)
|
243
|
+
req.send_request(options)
|
244
|
+
end
|
245
|
+
|
246
|
+
# @option params [required, String] :scaling_plan_name
|
247
|
+
#
|
248
|
+
# @option params [required, Integer] :scaling_plan_version
|
249
|
+
#
|
250
|
+
# @option params [Integer] :max_results
|
251
|
+
#
|
252
|
+
# @option params [String] :next_token
|
253
|
+
#
|
254
|
+
# @return [Types::DescribeScalingPlanResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
255
|
+
#
|
256
|
+
# * {Types::DescribeScalingPlanResourcesResponse#scaling_plan_resources #scaling_plan_resources} => Array<Types::ScalingPlanResource>
|
257
|
+
# * {Types::DescribeScalingPlanResourcesResponse#next_token #next_token} => String
|
258
|
+
#
|
259
|
+
# @example Request syntax with placeholder values
|
260
|
+
#
|
261
|
+
# resp = client.describe_scaling_plan_resources({
|
262
|
+
# scaling_plan_name: "ScalingPlanName", # required
|
263
|
+
# scaling_plan_version: 1, # required
|
264
|
+
# max_results: 1,
|
265
|
+
# next_token: "NextToken",
|
266
|
+
# })
|
267
|
+
#
|
268
|
+
# @example Response structure
|
269
|
+
#
|
270
|
+
# resp.scaling_plan_resources #=> Array
|
271
|
+
# resp.scaling_plan_resources[0].scaling_plan_name #=> String
|
272
|
+
# resp.scaling_plan_resources[0].scaling_plan_version #=> Integer
|
273
|
+
# resp.scaling_plan_resources[0].service_namespace #=> String, one of "autoscaling", "ecs", "ec2", "rds", "dynamodb"
|
274
|
+
# resp.scaling_plan_resources[0].resource_id #=> String
|
275
|
+
# 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"
|
276
|
+
# resp.scaling_plan_resources[0].scaling_policies #=> Array
|
277
|
+
# resp.scaling_plan_resources[0].scaling_policies[0].policy_name #=> String
|
278
|
+
# resp.scaling_plan_resources[0].scaling_policies[0].policy_type #=> String, one of "TargetTrackingScaling"
|
279
|
+
# 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"
|
280
|
+
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.predefined_scaling_metric_specification.resource_label #=> String
|
281
|
+
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.metric_name #=> String
|
282
|
+
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.namespace #=> String
|
283
|
+
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.dimensions #=> Array
|
284
|
+
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.dimensions[0].name #=> String
|
285
|
+
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.dimensions[0].value #=> String
|
286
|
+
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.statistic #=> String, one of "Average", "Minimum", "Maximum", "SampleCount", "Sum"
|
287
|
+
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.customized_scaling_metric_specification.unit #=> String
|
288
|
+
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.target_value #=> Float
|
289
|
+
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.disable_scale_in #=> Boolean
|
290
|
+
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.scale_out_cooldown #=> Integer
|
291
|
+
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.scale_in_cooldown #=> Integer
|
292
|
+
# resp.scaling_plan_resources[0].scaling_policies[0].target_tracking_configuration.estimated_instance_warmup #=> Integer
|
293
|
+
# resp.scaling_plan_resources[0].scaling_status_code #=> String, one of "Inactive", "PartiallyActive", "Active"
|
294
|
+
# resp.scaling_plan_resources[0].scaling_status_message #=> String
|
295
|
+
# resp.next_token #=> String
|
296
|
+
#
|
297
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DescribeScalingPlanResources AWS API Documentation
|
298
|
+
#
|
299
|
+
# @overload describe_scaling_plan_resources(params = {})
|
300
|
+
# @param [Hash] params ({})
|
301
|
+
def describe_scaling_plan_resources(params = {}, options = {})
|
302
|
+
req = build_request(:describe_scaling_plan_resources, params)
|
303
|
+
req.send_request(options)
|
304
|
+
end
|
305
|
+
|
306
|
+
# @option params [Array<String>] :scaling_plan_names
|
307
|
+
#
|
308
|
+
# @option params [Integer] :scaling_plan_version
|
309
|
+
#
|
310
|
+
# @option params [Array<Types::ApplicationSource>] :application_sources
|
311
|
+
#
|
312
|
+
# @option params [Integer] :max_results
|
313
|
+
#
|
314
|
+
# @option params [String] :next_token
|
315
|
+
#
|
316
|
+
# @return [Types::DescribeScalingPlansResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
317
|
+
#
|
318
|
+
# * {Types::DescribeScalingPlansResponse#scaling_plans #scaling_plans} => Array<Types::ScalingPlan>
|
319
|
+
# * {Types::DescribeScalingPlansResponse#next_token #next_token} => String
|
320
|
+
#
|
321
|
+
# @example Request syntax with placeholder values
|
322
|
+
#
|
323
|
+
# resp = client.describe_scaling_plans({
|
324
|
+
# scaling_plan_names: ["ScalingPlanName"],
|
325
|
+
# scaling_plan_version: 1,
|
326
|
+
# application_sources: [
|
327
|
+
# {
|
328
|
+
# cloud_formation_stack_arn: "XmlString",
|
329
|
+
# },
|
330
|
+
# ],
|
331
|
+
# max_results: 1,
|
332
|
+
# next_token: "NextToken",
|
333
|
+
# })
|
334
|
+
#
|
335
|
+
# @example Response structure
|
336
|
+
#
|
337
|
+
# resp.scaling_plans #=> Array
|
338
|
+
# resp.scaling_plans[0].scaling_plan_name #=> String
|
339
|
+
# resp.scaling_plans[0].scaling_plan_version #=> Integer
|
340
|
+
# resp.scaling_plans[0].application_source.cloud_formation_stack_arn #=> String
|
341
|
+
# resp.scaling_plans[0].scaling_instructions #=> Array
|
342
|
+
# resp.scaling_plans[0].scaling_instructions[0].service_namespace #=> String, one of "autoscaling", "ecs", "ec2", "rds", "dynamodb"
|
343
|
+
# resp.scaling_plans[0].scaling_instructions[0].resource_id #=> String
|
344
|
+
# 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"
|
345
|
+
# resp.scaling_plans[0].scaling_instructions[0].min_capacity #=> Integer
|
346
|
+
# resp.scaling_plans[0].scaling_instructions[0].max_capacity #=> Integer
|
347
|
+
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations #=> Array
|
348
|
+
# 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"
|
349
|
+
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].predefined_scaling_metric_specification.resource_label #=> String
|
350
|
+
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.metric_name #=> String
|
351
|
+
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.namespace #=> String
|
352
|
+
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.dimensions #=> Array
|
353
|
+
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.dimensions[0].name #=> String
|
354
|
+
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.dimensions[0].value #=> String
|
355
|
+
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.statistic #=> String, one of "Average", "Minimum", "Maximum", "SampleCount", "Sum"
|
356
|
+
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].customized_scaling_metric_specification.unit #=> String
|
357
|
+
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].target_value #=> Float
|
358
|
+
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].disable_scale_in #=> Boolean
|
359
|
+
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].scale_out_cooldown #=> Integer
|
360
|
+
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].scale_in_cooldown #=> Integer
|
361
|
+
# resp.scaling_plans[0].scaling_instructions[0].target_tracking_configurations[0].estimated_instance_warmup #=> Integer
|
362
|
+
# resp.scaling_plans[0].status_code #=> String, one of "Active", "ActiveWithProblems", "CreationInProgress", "CreationFailed", "DeletionInProgress", "DeletionFailed"
|
363
|
+
# resp.scaling_plans[0].status_message #=> String
|
364
|
+
# resp.scaling_plans[0].creation_time #=> Time
|
365
|
+
# resp.next_token #=> String
|
366
|
+
#
|
367
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DescribeScalingPlans AWS API Documentation
|
368
|
+
#
|
369
|
+
# @overload describe_scaling_plans(params = {})
|
370
|
+
# @param [Hash] params ({})
|
371
|
+
def describe_scaling_plans(params = {}, options = {})
|
372
|
+
req = build_request(:describe_scaling_plans, params)
|
373
|
+
req.send_request(options)
|
374
|
+
end
|
375
|
+
|
376
|
+
# @!endgroup
|
377
|
+
|
378
|
+
# @param params ({})
|
379
|
+
# @api private
|
380
|
+
def build_request(operation_name, params = {})
|
381
|
+
handlers = @handlers.for(operation_name)
|
382
|
+
context = Seahorse::Client::RequestContext.new(
|
383
|
+
operation_name: operation_name,
|
384
|
+
operation: config.api.operation(operation_name),
|
385
|
+
client: self,
|
386
|
+
params: params,
|
387
|
+
config: config)
|
388
|
+
context[:gem_name] = 'aws-sdk-autoscalingplans'
|
389
|
+
context[:gem_version] = '1.0.0'
|
390
|
+
Seahorse::Client::Request.new(handlers, context)
|
391
|
+
end
|
392
|
+
|
393
|
+
# @api private
|
394
|
+
# @deprecated
|
395
|
+
def waiter_names
|
396
|
+
[]
|
397
|
+
end
|
398
|
+
|
399
|
+
class << self
|
400
|
+
|
401
|
+
# @api private
|
402
|
+
attr_reader :identifier
|
403
|
+
|
404
|
+
# @api private
|
405
|
+
def errors_module
|
406
|
+
Errors
|
407
|
+
end
|
408
|
+
|
409
|
+
end
|
410
|
+
end
|
411
|
+
end
|