aws-sdk 1.5.8 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. data/lib/aws.rb +2 -0
  2. data/lib/aws/api_config/Route53-2012-02-29.yml +348 -0
  3. data/lib/aws/auto_scaling/client.rb +362 -588
  4. data/lib/aws/cloud_formation/client.rb +155 -224
  5. data/lib/aws/cloud_watch/client.rb +156 -229
  6. data/lib/aws/core.rb +67 -52
  7. data/lib/aws/core/client.rb +81 -82
  8. data/lib/aws/core/collection/with_limit_and_next_token.rb +2 -2
  9. data/lib/aws/core/configuration.rb +75 -72
  10. data/lib/aws/core/http/net_http_handler.rb +3 -3
  11. data/lib/aws/core/http/request.rb +107 -138
  12. data/lib/aws/core/inflection.rb +3 -3
  13. data/lib/aws/core/json_client.rb +106 -0
  14. data/lib/aws/core/option_grammar.rb +10 -1
  15. data/lib/aws/core/options/validator.rb +140 -0
  16. data/lib/aws/core/options/xml_serializer.rb +98 -0
  17. data/lib/aws/core/query_client.rb +131 -0
  18. data/lib/aws/core/rest_client.rb +90 -0
  19. data/lib/aws/core/rest_client/input_handler.rb +145 -0
  20. data/lib/aws/core/rest_client/output_handler.rb +43 -0
  21. data/lib/aws/core/signature/version_2.rb +7 -7
  22. data/lib/aws/core/signature/version_3.rb +5 -1
  23. data/lib/aws/core/signature/version_3_https.rb +51 -0
  24. data/lib/aws/core/signature/version_4.rb +5 -22
  25. data/lib/aws/core/signer.rb +1 -1
  26. data/lib/aws/core/uri_escape.rb +2 -0
  27. data/lib/aws/core/xml/frame.rb +8 -8
  28. data/lib/aws/core/xml/grammar.rb +8 -3
  29. data/lib/aws/dynamo_db/client.rb +600 -662
  30. data/lib/aws/ec2/client.rb +2688 -3492
  31. data/lib/aws/ec2/request.rb +0 -1
  32. data/lib/aws/elb/client.rb +280 -407
  33. data/lib/aws/emr/client.rb +7 -7
  34. data/lib/aws/iam/client.rb +822 -1268
  35. data/lib/aws/route_53.rb +71 -0
  36. data/lib/aws/route_53/client.rb +272 -0
  37. data/lib/aws/route_53/config.rb +18 -0
  38. data/lib/aws/route_53/errors.rb +22 -0
  39. data/lib/aws/route_53/request.rb +23 -0
  40. data/lib/aws/s3/object_version_collection.rb +6 -6
  41. data/lib/aws/s3/paginated_collection.rb +1 -1
  42. data/lib/aws/s3/request.rb +10 -5
  43. data/lib/aws/simple_db/client.rb +184 -234
  44. data/lib/aws/simple_email_service/client.rb +147 -238
  45. data/lib/aws/simple_workflow/client.rb +997 -1191
  46. data/lib/aws/sns/client.rb +176 -264
  47. data/lib/aws/sqs/client.rb +162 -253
  48. data/lib/aws/sqs/queue.rb +1 -1
  49. data/lib/aws/sqs/request.rb +4 -0
  50. data/lib/aws/sts/client.rb +57 -66
  51. metadata +95 -71
  52. data/lib/aws/core/client/query_json.rb +0 -112
  53. data/lib/aws/core/client/query_xml.rb +0 -122
data/lib/aws/ec2/request.rb CHANGED
@@ -13,7 +13,6 @@
13
13
 
14
14
  module AWS
15
15
  class EC2
16
-
17
16
  # @private
18
17
  class Request < Core::Http::Request
19
18
  include Core::Signature::Version2
data/lib/aws/elb/client.rb CHANGED
@@ -19,7 +19,7 @@ module AWS
19
19
 
20
20
  API_VERSION = '2011-08-15'
21
21
 
22
- extend Core::Client::QueryXML
22
+ extend Core::QueryClient
23
23
 
24
24
  # @private
25
25
  CACHEABLE_REQUESTS = Set[]
@@ -28,508 +28,381 @@ module AWS
28
28
 
29
29
  # Calls the ConfigureHealthCheck API operation.
30
30
  # @method configure_health_check(options = {})
31
- #
32
- # === Options:
33
- #
34
- # * +:load_balancer_name+ - *required* - (String) The mnemonic name
35
- # associated with the LoadBalancer. This name must be unique within the
36
- # client AWS account.
37
- # * +:health_check+ - *required* - (Hash) A structure containing the
38
- # configuration information for the new healthcheck.
39
- # * +:target+ - *required* - (String) Specifies the instance being
40
- # checked. The protocol is either TCP or HTTP. The range of valid
41
- # ports is one (1) through 65535. TCP is the default, specified as a
42
- # TCP: port pair, for example "TCP:5000". In this case a healthcheck
43
- # simply attempts to open a TCP connection to the instance on the
44
- # specified port. Failure to connect within the configured timeout is
45
- # considered unhealthy. For HTTP, the situation is different. HTTP is
46
- # specified as a HTTP:port;/;PathToPing; grouping, for example
47
- # "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request
48
- # is issued to the instance on the given port and path. Any answer
49
- # other than "200 OK" within the timeout period is considered
50
- # unhealthy. The total length of the HTTP ping target needs to be
51
- # 1024 16-bit Unicode characters or less.
52
- # * +:interval+ - *required* - (Integer) Specifies the approximate
53
- # interval, in seconds, between health checks of an individual
54
- # instance.
55
- # * +:timeout+ - *required* - (Integer) Specifies the amount of time,
56
- # in seconds, during which no response means a failed health probe.
57
- # This value must be less than the Interval value.
58
- # * +:unhealthy_threshold+ - *required* - (Integer) Specifies the
59
- # number of consecutive health probe failures required before moving
60
- # the instance to the Unhealthy state.
61
- # * +:healthy_threshold+ - *required* - (Integer) Specifies the number
62
- # of consecutive health probe successes required before moving the
63
- # instance to the Healthy state.
64
- #
65
- # === Response Structure:
66
- #
67
- # * +:health_check+ - (Hash)
68
- # * +:target+ - (String)
69
- # * +:interval+ - (Integer)
70
- # * +:timeout+ - (Integer)
71
- # * +:unhealthy_threshold+ - (Integer)
72
- # * +:healthy_threshold+ - (Integer)
73
- #
31
+ # @param [Hash] options
32
+ # * +:load_balancer_name+ - *required* - (String) The mnemonic name
33
+ # associated with the LoadBalancer. This name must be unique within
34
+ # the client AWS account.
35
+ # * +:health_check+ - *required* - (Hash) A structure containing the
36
+ # configuration information for the new healthcheck.
37
+ # * +:target+ - *required* - (String) Specifies the instance being
38
+ # checked. The protocol is either TCP or HTTP. The range of valid
39
+ # ports is one (1) through 65535. TCP is the default, specified as
40
+ # a TCP: port pair, for example "TCP:5000". In this case a
41
+ # healthcheck simply attempts to open a TCP connection to the
42
+ # instance on the specified port. Failure to connect within the
43
+ # configured timeout is considered unhealthy. For HTTP, the
44
+ # situation is different. HTTP is specified as a
45
+ # HTTP:port;/;PathToPing; grouping, for example
46
+ # "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request
47
+ # is issued to the instance on the given port and path. Any answer
48
+ # other than "200 OK" within the timeout period is considered
49
+ # unhealthy. The total length of the HTTP ping target needs to be
50
+ # 1024 16-bit Unicode characters or less.
51
+ # * +:interval+ - *required* - (Integer) Specifies the approximate
52
+ # interval, in seconds, between health checks of an individual
53
+ # instance.
54
+ # * +:timeout+ - *required* - (Integer) Specifies the amount of time,
55
+ # in seconds, during which no response means a failed health probe.
56
+ # This value must be less than the Interval value.
57
+ # * +:unhealthy_threshold+ - *required* - (Integer) Specifies the
58
+ # number of consecutive health probe failures required before
59
+ # moving the instance to the Unhealthy state.
60
+ # * +:healthy_threshold+ - *required* - (Integer) Specifies the
61
+ # number of consecutive health probe successes required before
62
+ # moving the instance to the Healthy state.
74
63
  # @return [Core::Response]
75
- #
64
+ # The #data method of the response object returns
65
+ # a hash with the following structure:
66
+ # * +:health_check+ - (Hash)
67
+ # * +:target+ - (String)
68
+ # * +:interval+ - (Integer)
69
+ # * +:timeout+ - (Integer)
70
+ # * +:unhealthy_threshold+ - (Integer)
71
+ # * +:healthy_threshold+ - (Integer)
76
72
  define_client_method :configure_health_check, 'ConfigureHealthCheck'
77
73
 
78
74
  # Calls the CreateAppCookieStickinessPolicy API operation.
79
75
  # @method create_app_cookie_stickiness_policy(options = {})
80
- #
81
- # === Options:
82
- #
83
- # * +:load_balancer_name+ - *required* - (String) The name associated
84
- # with the LoadBalancer. The name must be unique within the client AWS
85
- # account.
86
- # * +:policy_name+ - *required* - (String) The name of the policy being
87
- # created. The name must be unique within the set of policies for this
88
- # Load Balancer.
89
- # * +:cookie_name+ - *required* - (String) Name of the application cookie
90
- # used for stickiness.
91
- #
92
- # === Response Structure:
93
- #
94
- # This method returns no response data.
95
- #
76
+ # @param [Hash] options
77
+ # * +:load_balancer_name+ - *required* - (String) The name associated
78
+ # with the LoadBalancer. The name must be unique within the client
79
+ # AWS account.
80
+ # * +:policy_name+ - *required* - (String) The name of the policy being
81
+ # created. The name must be unique within the set of policies for
82
+ # this Load Balancer.
83
+ # * +:cookie_name+ - *required* - (String) Name of the application
84
+ # cookie used for stickiness.
96
85
  # @return [Core::Response]
97
- #
98
86
  define_client_method :create_app_cookie_stickiness_policy, 'CreateAppCookieStickinessPolicy'
99
87
 
100
88
  # Calls the CreateLBCookieStickinessPolicy API operation.
101
89
  # @method create_lb_cookie_stickiness_policy(options = {})
102
- #
103
- # === Options:
104
- #
105
- # * +:load_balancer_name+ - *required* - (String) The name associated
106
- # with the LoadBalancer. The name must be unique within the client AWS
107
- # account.
108
- # * +:policy_name+ - *required* - (String) The name of the policy being
109
- # created. The name must be unique within the set of policies for this
110
- # Load Balancer.
111
- # * +:cookie_expiration_period+ - (Integer) The time period in seconds
112
- # after which the cookie should be considered stale. Not specifying
113
- # this parameter indicates that the sticky session will last for the
114
- # duration of the browser session.
115
- #
116
- # === Response Structure:
117
- #
118
- # This method returns no response data.
119
- #
90
+ # @param [Hash] options
91
+ # * +:load_balancer_name+ - *required* - (String) The name associated
92
+ # with the LoadBalancer. The name must be unique within the client
93
+ # AWS account.
94
+ # * +:policy_name+ - *required* - (String) The name of the policy being
95
+ # created. The name must be unique within the set of policies for
96
+ # this Load Balancer.
97
+ # * +:cookie_expiration_period+ - (Integer) The time period in seconds
98
+ # after which the cookie should be considered stale. Not specifying
99
+ # this parameter indicates that the sticky session will last for the
100
+ # duration of the browser session.
120
101
  # @return [Core::Response]
121
- #
122
102
  define_client_method :create_lb_cookie_stickiness_policy, 'CreateLBCookieStickinessPolicy'
123
103
 
124
104
  # Calls the CreateLoadBalancer API operation.
125
105
  # @method create_load_balancer(options = {})
126
- #
127
- # === Options:
128
- #
129
- # * +:load_balancer_name+ - *required* - (String) The name associated
130
- # with the LoadBalancer. The name must be unique within your set of
131
- # LoadBalancers.
132
- # * +:listeners+ - *required* - (Array<Hash>) A list of the following
133
- # tuples: LoadBalancerPort, InstancePort, and Protocol.
134
- # * +:protocol+ - *required* - (String) Specifies the LoadBalancer
135
- # transport protocol to use for routing - TCP or HTTP. This property
136
- # cannot be modified for the life of the LoadBalancer.
137
- # * +:load_balancer_port+ - *required* - (Integer) Specifies the
138
- # external LoadBalancer port number. This property cannot be modified
139
- # for the life of the LoadBalancer.
140
- # * +:instance_protocol+ - (String)
141
- # * +:instance_port+ - *required* - (Integer) Specifies the TCP port on
142
- # which the instance server is listening. This property cannot be
143
- # modified for the life of the LoadBalancer.
144
- # * +:ssl_certificate_id+ - (String) The ID of the SSL certificate
145
- # chain to use. For more information on SSL certificates, see
146
- # Managing Keys and Certificates in the AWS Identity and Access
147
- # Management documentation.
148
- # * +:availability_zones+ - *required* - (Array<String>) A list of
149
- # Availability Zones. At least one Availability Zone must be specified.
150
- # Specified Availability Zones must be in the same EC2 Region as the
151
- # LoadBalancer. Traffic will be equally distributed across all zones.
152
- # This list can be modified after the creation of the LoadBalancer.
153
- #
154
- # === Response Structure:
155
- #
156
- # * +:dns_name+ - (String)
157
- #
106
+ # @param [Hash] options
107
+ # * +:load_balancer_name+ - *required* - (String) The name associated
108
+ # with the LoadBalancer. The name must be unique within your set of
109
+ # LoadBalancers.
110
+ # * +:listeners+ - *required* - (Array<Hash>) A list of the following
111
+ # tuples: LoadBalancerPort, InstancePort, and Protocol.
112
+ # * +:protocol+ - *required* - (String) Specifies the LoadBalancer
113
+ # transport protocol to use for routing - TCP or HTTP. This
114
+ # property cannot be modified for the life of the LoadBalancer.
115
+ # * +:load_balancer_port+ - *required* - (Integer) Specifies the
116
+ # external LoadBalancer port number. This property cannot be
117
+ # modified for the life of the LoadBalancer.
118
+ # * +:instance_protocol+ - (String)
119
+ # * +:instance_port+ - *required* - (Integer) Specifies the TCP port
120
+ # on which the instance server is listening. This property cannot
121
+ # be modified for the life of the LoadBalancer.
122
+ # * +:ssl_certificate_id+ - (String) The ID of the SSL certificate
123
+ # chain to use. For more information on SSL certificates, see
124
+ # Managing Keys and Certificates in the AWS Identity and Access
125
+ # Management documentation.
126
+ # * +:availability_zones+ - *required* - (Array<String>) A list of
127
+ # Availability Zones. At least one Availability Zone must be
128
+ # specified. Specified Availability Zones must be in the same EC2
129
+ # Region as the LoadBalancer. Traffic will be equally distributed
130
+ # across all zones. This list can be modified after the creation of
131
+ # the LoadBalancer.
158
132
  # @return [Core::Response]
159
- #
133
+ # The #data method of the response object returns
134
+ # a hash with the following structure:
135
+ # * +:dns_name+ - (String)
160
136
  define_client_method :create_load_balancer, 'CreateLoadBalancer'
161
137
 
162
138
  # Calls the CreateLoadBalancerListeners API operation.
163
139
  # @method create_load_balancer_listeners(options = {})
164
- #
165
- # === Options:
166
- #
167
- # * +:load_balancer_name+ - *required* - (String) The name of the new
168
- # LoadBalancer. The name must be unique within your AWS account.
169
- # * +:listeners+ - *required* - (Array<Hash>) A list of LoadBalancerPort,
170
- # InstancePort, Protocol, and SSLCertificateId items.
171
- # * +:protocol+ - *required* - (String) Specifies the LoadBalancer
172
- # transport protocol to use for routing - TCP or HTTP. This property
173
- # cannot be modified for the life of the LoadBalancer.
174
- # * +:load_balancer_port+ - *required* - (Integer) Specifies the
175
- # external LoadBalancer port number. This property cannot be modified
176
- # for the life of the LoadBalancer.
177
- # * +:instance_protocol+ - (String)
178
- # * +:instance_port+ - *required* - (Integer) Specifies the TCP port on
179
- # which the instance server is listening. This property cannot be
180
- # modified for the life of the LoadBalancer.
181
- # * +:ssl_certificate_id+ - (String) The ID of the SSL certificate
182
- # chain to use. For more information on SSL certificates, see
183
- # Managing Keys and Certificates in the AWS Identity and Access
184
- # Management documentation.
185
- #
186
- # === Response Structure:
187
- #
188
- # This method returns no response data.
189
- #
140
+ # @param [Hash] options
141
+ # * +:load_balancer_name+ - *required* - (String) The name of the new
142
+ # LoadBalancer. The name must be unique within your AWS account.
143
+ # * +:listeners+ - *required* - (Array<Hash>) A list of
144
+ # LoadBalancerPort, InstancePort, Protocol, and SSLCertificateId
145
+ # items.
146
+ # * +:protocol+ - *required* - (String) Specifies the LoadBalancer
147
+ # transport protocol to use for routing - TCP or HTTP. This
148
+ # property cannot be modified for the life of the LoadBalancer.
149
+ # * +:load_balancer_port+ - *required* - (Integer) Specifies the
150
+ # external LoadBalancer port number. This property cannot be
151
+ # modified for the life of the LoadBalancer.
152
+ # * +:instance_protocol+ - (String)
153
+ # * +:instance_port+ - *required* - (Integer) Specifies the TCP port
154
+ # on which the instance server is listening. This property cannot
155
+ # be modified for the life of the LoadBalancer.
156
+ # * +:ssl_certificate_id+ - (String) The ID of the SSL certificate
157
+ # chain to use. For more information on SSL certificates, see
158
+ # Managing Keys and Certificates in the AWS Identity and Access
159
+ # Management documentation.
190
160
  # @return [Core::Response]
191
- #
192
161
  define_client_method :create_load_balancer_listeners, 'CreateLoadBalancerListeners'
193
162
 
194
163
  # Calls the CreateLoadBalancerPolicy API operation.
195
164
  # @method create_load_balancer_policy(options = {})
196
- #
197
- # === Options:
198
- #
199
- # * +:load_balancer_name+ - *required* - (String)
200
- # * +:policy_name+ - *required* - (String)
201
- # * +:policy_type_name+ - *required* - (String)
202
- # * +:policy_attributes+ - (Array<Hash>)
203
- # * +:attribute_name+ - (String)
204
- # * +:attribute_value+ - (String)
205
- #
206
- # === Response Structure:
207
- #
208
- # This method returns no response data.
209
- #
165
+ # @param [Hash] options
166
+ # * +:load_balancer_name+ - *required* - (String)
167
+ # * +:policy_name+ - *required* - (String)
168
+ # * +:policy_type_name+ - *required* - (String)
169
+ # * +:policy_attributes+ - (Array<Hash>)
170
+ # * +:attribute_name+ - (String)
171
+ # * +:attribute_value+ - (String)
210
172
  # @return [Core::Response]
211
- #
212
173
  define_client_method :create_load_balancer_policy, 'CreateLoadBalancerPolicy'
213
174
 
214
175
  # Calls the DeleteLoadBalancer API operation.
215
176
  # @method delete_load_balancer(options = {})
216
- #
217
- # === Options:
218
- #
219
- # * +:load_balancer_name+ - *required* - (String) The name associated
220
- # with the LoadBalancer. The name must be unique within the client AWS
221
- # account.
222
- #
223
- # === Response Structure:
224
- #
225
- # This method returns no response data.
226
- #
177
+ # @param [Hash] options
178
+ # * +:load_balancer_name+ - *required* - (String) The name associated
179
+ # with the LoadBalancer. The name must be unique within the client
180
+ # AWS account.
227
181
  # @return [Core::Response]
228
- #
229
182
  define_client_method :delete_load_balancer, 'DeleteLoadBalancer'
230
183
 
231
184
  # Calls the DeleteLoadBalancerListeners API operation.
232
185
  # @method delete_load_balancer_listeners(options = {})
233
- #
234
- # === Options:
235
- #
236
- # * +:load_balancer_name+ - *required* - (String) The mnemonic name
237
- # associated with the LoadBalancer.
238
- # * +:load_balancer_ports+ - *required* - (Array<Integer>) The client
239
- # port number(s) of the LoadBalancerListener(s) to be removed.
240
- #
241
- # === Response Structure:
242
- #
243
- # This method returns no response data.
244
- #
186
+ # @param [Hash] options
187
+ # * +:load_balancer_name+ - *required* - (String) The mnemonic name
188
+ # associated with the LoadBalancer.
189
+ # * +:load_balancer_ports+ - *required* - (Array<Integer>) The client
190
+ # port number(s) of the LoadBalancerListener(s) to be removed.
245
191
  # @return [Core::Response]
246
- #
247
192
  define_client_method :delete_load_balancer_listeners, 'DeleteLoadBalancerListeners'
248
193
 
249
194
  # Calls the DeleteLoadBalancerPolicy API operation.
250
195
  # @method delete_load_balancer_policy(options = {})
251
- #
252
- # === Options:
253
- #
254
- # * +:load_balancer_name+ - *required* - (String) The mnemonic name
255
- # associated with the LoadBalancer. The name must be unique within your
256
- # AWS account.
257
- # * +:policy_name+ - *required* - (String) The mnemonic name for the
258
- # policy being deleted.
259
- #
260
- # === Response Structure:
261
- #
262
- # This method returns no response data.
263
- #
196
+ # @param [Hash] options
197
+ # * +:load_balancer_name+ - *required* - (String) The mnemonic name
198
+ # associated with the LoadBalancer. The name must be unique within
199
+ # your AWS account.
200
+ # * +:policy_name+ - *required* - (String) The mnemonic name for the
201
+ # policy being deleted.
264
202
  # @return [Core::Response]
265
- #
266
203
  define_client_method :delete_load_balancer_policy, 'DeleteLoadBalancerPolicy'
267
204
 
268
205
  # Calls the DeregisterInstancesFromLoadBalancer API operation.
269
206
  # @method deregister_instances_from_load_balancer(options = {})
270
- #
271
- # === Options:
272
- #
273
- # * +:load_balancer_name+ - *required* - (String) The name associated
274
- # with the LoadBalancer. The name must be unique within the client AWS
275
- # account.
276
- # * +:instances+ - *required* - (Array<Hash>) A list of EC2 instance IDs
277
- # consisting of all instances to be deregistered.
278
- # * +:instance_id+ - (String) Provides an EC2 instance ID.
279
- #
280
- # === Response Structure:
281
- #
282
- # * +:instances+ - (Array<Hash>)
283
- # * +:instance_id+ - (String)
284
- #
207
+ # @param [Hash] options
208
+ # * +:load_balancer_name+ - *required* - (String) The name associated
209
+ # with the LoadBalancer. The name must be unique within the client
210
+ # AWS account.
211
+ # * +:instances+ - *required* - (Array<Hash>) A list of EC2 instance
212
+ # IDs consisting of all instances to be deregistered.
213
+ # * +:instance_id+ - (String) Provides an EC2 instance ID.
285
214
  # @return [Core::Response]
286
- #
215
+ # The #data method of the response object returns
216
+ # a hash with the following structure:
217
+ # * +:instances+ - (Array<Hash>)
218
+ # * +:instance_id+ - (String)
287
219
  define_client_method :deregister_instances_from_load_balancer, 'DeregisterInstancesFromLoadBalancer'
288
220
 
289
221
  # Calls the DescribeInstanceHealth API operation.
290
222
  # @method describe_instance_health(options = {})
291
- #
292
- # === Options:
293
- #
294
- # * +:load_balancer_name+ - *required* - (String) The name associated
295
- # with the LoadBalancer. The name must be unique within the client AWS
296
- # account.
297
- # * +:instances+ - (Array<Hash>) A list of instance IDs whose states are
298
- # being queried.
299
- # * +:instance_id+ - (String) Provides an EC2 instance ID.
300
- #
301
- # === Response Structure:
302
- #
303
- # * +:instance_states+ - (Array<Hash>)
304
- # * +:instance_id+ - (String)
305
- # * +:state+ - (String)
306
- # * +:reason_code+ - (String)
307
- # * +:description+ - (String)
308
- #
223
+ # @param [Hash] options
224
+ # * +:load_balancer_name+ - *required* - (String) The name associated
225
+ # with the LoadBalancer. The name must be unique within the client
226
+ # AWS account.
227
+ # * +:instances+ - (Array<Hash>) A list of instance IDs whose states
228
+ # are being queried.
229
+ # * +:instance_id+ - (String) Provides an EC2 instance ID.
309
230
  # @return [Core::Response]
310
- #
231
+ # The #data method of the response object returns
232
+ # a hash with the following structure:
233
+ # * +:instance_states+ - (Array<Hash>)
234
+ # * +:instance_id+ - (String)
235
+ # * +:state+ - (String)
236
+ # * +:reason_code+ - (String)
237
+ # * +:description+ - (String)
311
238
  define_client_method :describe_instance_health, 'DescribeInstanceHealth'
312
239
 
313
240
  # Calls the DescribeLoadBalancerPolicies API operation.
314
241
  # @method describe_load_balancer_policies(options = {})
315
- #
316
- # === Options:
317
- #
318
- # * +:load_balancer_name+ - (String)
319
- # * +:policy_names+ - (Array<String>)
320
- #
321
- # === Response Structure:
322
- #
323
- # * +:policy_descriptions+ - (Array<Hash>)
324
- # * +:policy_name+ - (String)
325
- # * +:policy_type_name+ - (String)
326
- # * +:policy_attribute_descriptions+ - (Array<Hash>)
327
- # * +:attribute_name+ - (String)
328
- # * +:attribute_value+ - (String)
329
- #
242
+ # @param [Hash] options
243
+ # * +:load_balancer_name+ - (String)
244
+ # * +:policy_names+ - (Array<String>)
330
245
  # @return [Core::Response]
331
- #
246
+ # The #data method of the response object returns
247
+ # a hash with the following structure:
248
+ # * +:policy_descriptions+ - (Array<Hash>)
249
+ # * +:policy_name+ - (String)
250
+ # * +:policy_type_name+ - (String)
251
+ # * +:policy_attribute_descriptions+ - (Array<Hash>)
252
+ # * +:attribute_name+ - (String)
253
+ # * +:attribute_value+ - (String)
332
254
  define_client_method :describe_load_balancer_policies, 'DescribeLoadBalancerPolicies'
333
255
 
334
256
  # Calls the DescribeLoadBalancerPolicyTypes API operation.
335
257
  # @method describe_load_balancer_policy_types(options = {})
336
- #
337
- # === Options:
338
- #
339
- # * +:policy_type_names+ - (Array<String>)
340
- #
341
- # === Response Structure:
342
- #
343
- # * +:policy_type_descriptions+ - (Array<Hash>)
344
- # * +:policy_type_name+ - (String)
345
- # * +:description+ - (String)
346
- # * +:policy_attribute_type_descriptions+ - (Array<Hash>)
347
- # * +:attribute_name+ - (String)
348
- # * +:attribute_type+ - (String)
349
- # * +:description+ - (String)
350
- # * +:default_value+ - (String)
351
- # * +:cardinality+ - (String)
352
- #
258
+ # @param [Hash] options
259
+ # * +:policy_type_names+ - (Array<String>)
353
260
  # @return [Core::Response]
354
- #
261
+ # The #data method of the response object returns
262
+ # a hash with the following structure:
263
+ # * +:policy_type_descriptions+ - (Array<Hash>)
264
+ # * +:policy_type_name+ - (String)
265
+ # * +:description+ - (String)
266
+ # * +:policy_attribute_type_descriptions+ - (Array<Hash>)
267
+ # * +:attribute_name+ - (String)
268
+ # * +:attribute_type+ - (String)
269
+ # * +:description+ - (String)
270
+ # * +:default_value+ - (String)
271
+ # * +:cardinality+ - (String)
355
272
  define_client_method :describe_load_balancer_policy_types, 'DescribeLoadBalancerPolicyTypes'
356
273
 
357
274
  # Calls the DescribeLoadBalancers API operation.
358
275
  # @method describe_load_balancers(options = {})
359
- #
360
- # === Options:
361
- #
362
- # * +:load_balancer_names+ - (Array<String>) A list of names associated
363
- # with the LoadBalancers at creation time.
364
- #
365
- # === Response Structure:
366
- #
367
- # * +:load_balancer_descriptions+ - (Array<Hash>)
368
- # * +:load_balancer_name+ - (String)
369
- # * +:dns_name+ - (String)
370
- # * +:canonical_hosted_zone_name+ - (String)
371
- # * +:canonical_hosted_zone_name_id+ - (String)
372
- # * +:listener_descriptions+ - (Array<Hash>)
373
- # * +:listener+ - (Hash)
374
- # * +:protocol+ - (String)
375
- # * +:load_balancer_port+ - (Integer)
376
- # * +:instance_protocol+ - (String)
377
- # * +:instance_port+ - (Integer)
378
- # * +:ssl_certificate_id+ - (String)
379
- # * +:policy_names+ - (Array<String>)
380
- # * +:policies+ - (Hash)
381
- # * +:app_cookie_stickiness_policies+ - (Array<Hash>)
382
- # * +:policy_name+ - (String)
383
- # * +:cookie_name+ - (String)
384
- # * +:lb_cookie_stickiness_policies+ - (Array<Hash>)
385
- # * +:policy_name+ - (String)
386
- # * +:cookie_expiration_period+ - (Integer)
387
- # * +:other_policies+ - (Array<String>)
388
- # * +:backend_server_descriptions+ - (Array<Hash>)
389
- # * +:instance_port+ - (Integer)
390
- # * +:policy_names+ - (Array<String>)
391
- # * +:availability_zones+ - (Array<String>)
392
- # * +:instances+ - (Array<Hash>)
393
- # * +:instance_id+ - (String)
394
- # * +:health_check+ - (Hash)
395
- # * +:target+ - (String)
396
- # * +:interval+ - (Integer)
397
- # * +:timeout+ - (Integer)
398
- # * +:unhealthy_threshold+ - (Integer)
399
- # * +:healthy_threshold+ - (Integer)
400
- # * +:source_security_group+ - (Hash)
401
- # * +:owner_alias+ - (String)
402
- # * +:group_name+ - (String)
403
- # * +:created_time+ - (Time)
404
- #
276
+ # @param [Hash] options
277
+ # * +:load_balancer_names+ - (Array<String>) A list of names associated
278
+ # with the LoadBalancers at creation time.
405
279
  # @return [Core::Response]
406
- #
280
+ # The #data method of the response object returns
281
+ # a hash with the following structure:
282
+ # * +:load_balancer_descriptions+ - (Array<Hash>)
283
+ # * +:load_balancer_name+ - (String)
284
+ # * +:dns_name+ - (String)
285
+ # * +:canonical_hosted_zone_name+ - (String)
286
+ # * +:canonical_hosted_zone_name_id+ - (String)
287
+ # * +:listener_descriptions+ - (Array<Hash>)
288
+ # * +:listener+ - (Hash)
289
+ # * +:protocol+ - (String)
290
+ # * +:load_balancer_port+ - (Integer)
291
+ # * +:instance_protocol+ - (String)
292
+ # * +:instance_port+ - (Integer)
293
+ # * +:ssl_certificate_id+ - (String)
294
+ # * +:policy_names+ - (Array<String>)
295
+ # * +:policies+ - (Hash)
296
+ # * +:app_cookie_stickiness_policies+ - (Array<Hash>)
297
+ # * +:policy_name+ - (String)
298
+ # * +:cookie_name+ - (String)
299
+ # * +:lb_cookie_stickiness_policies+ - (Array<Hash>)
300
+ # * +:policy_name+ - (String)
301
+ # * +:cookie_expiration_period+ - (Integer)
302
+ # * +:other_policies+ - (Array<String>)
303
+ # * +:backend_server_descriptions+ - (Array<Hash>)
304
+ # * +:instance_port+ - (Integer)
305
+ # * +:policy_names+ - (Array<String>)
306
+ # * +:availability_zones+ - (Array<String>)
307
+ # * +:instances+ - (Array<Hash>)
308
+ # * +:instance_id+ - (String)
309
+ # * +:health_check+ - (Hash)
310
+ # * +:target+ - (String)
311
+ # * +:interval+ - (Integer)
312
+ # * +:timeout+ - (Integer)
313
+ # * +:unhealthy_threshold+ - (Integer)
314
+ # * +:healthy_threshold+ - (Integer)
315
+ # * +:source_security_group+ - (Hash)
316
+ # * +:owner_alias+ - (String)
317
+ # * +:group_name+ - (String)
318
+ # * +:created_time+ - (Time)
407
319
  define_client_method :describe_load_balancers, 'DescribeLoadBalancers'
408
320
 
409
321
  # Calls the DisableAvailabilityZonesForLoadBalancer API operation.
410
322
  # @method disable_availability_zones_for_load_balancer(options = {})
411
- #
412
- # === Options:
413
- #
414
- # * +:load_balancer_name+ - *required* - (String) The name associated
415
- # with the LoadBalancer. The name must be unique within the client AWS
416
- # account.
417
- # * +:availability_zones+ - *required* - (Array<String>) A list of
418
- # Availability Zones to be removed from the LoadBalancer. There must be
419
- # at least one Availability Zone registered with a LoadBalancer at all
420
- # times. The client cannot remove all the Availability Zones from a
421
- # LoadBalancer. Specified Availability Zones must be in the same
422
- # Region.
423
- #
424
- # === Response Structure:
425
- #
426
- # * +:availability_zones+ - (Array<String>)
427
- #
323
+ # @param [Hash] options
324
+ # * +:load_balancer_name+ - *required* - (String) The name associated
325
+ # with the LoadBalancer. The name must be unique within the client
326
+ # AWS account.
327
+ # * +:availability_zones+ - *required* - (Array<String>) A list of
328
+ # Availability Zones to be removed from the LoadBalancer. There must
329
+ # be at least one Availability Zone registered with a LoadBalancer at
330
+ # all times. The client cannot remove all the Availability Zones from
331
+ # a LoadBalancer. Specified Availability Zones must be in the same
332
+ # Region.
428
333
  # @return [Core::Response]
429
- #
334
+ # The #data method of the response object returns
335
+ # a hash with the following structure:
336
+ # * +:availability_zones+ - (Array<String>)
430
337
  define_client_method :disable_availability_zones_for_load_balancer, 'DisableAvailabilityZonesForLoadBalancer'
431
338
 
432
339
  # Calls the EnableAvailabilityZonesForLoadBalancer API operation.
433
340
  # @method enable_availability_zones_for_load_balancer(options = {})
434
- #
435
- # === Options:
436
- #
437
- # * +:load_balancer_name+ - *required* - (String) The name associated
438
- # with the LoadBalancer. The name must be unique within the client AWS
439
- # account.
440
- # * +:availability_zones+ - *required* - (Array<String>) A list of new
441
- # Availability Zones for the LoadBalancer. Each Availability Zone must
442
- # be in the same Region as the LoadBalancer.
443
- #
444
- # === Response Structure:
445
- #
446
- # * +:availability_zones+ - (Array<String>)
447
- #
341
+ # @param [Hash] options
342
+ # * +:load_balancer_name+ - *required* - (String) The name associated
343
+ # with the LoadBalancer. The name must be unique within the client
344
+ # AWS account.
345
+ # * +:availability_zones+ - *required* - (Array<String>) A list of new
346
+ # Availability Zones for the LoadBalancer. Each Availability Zone
347
+ # must be in the same Region as the LoadBalancer.
448
348
  # @return [Core::Response]
449
- #
349
+ # The #data method of the response object returns
350
+ # a hash with the following structure:
351
+ # * +:availability_zones+ - (Array<String>)
450
352
  define_client_method :enable_availability_zones_for_load_balancer, 'EnableAvailabilityZonesForLoadBalancer'
451
353
 
452
354
  # Calls the RegisterInstancesWithLoadBalancer API operation.
453
355
  # @method register_instances_with_load_balancer(options = {})
454
- #
455
- # === Options:
456
- #
457
- # * +:load_balancer_name+ - *required* - (String) The name associated
458
- # with the LoadBalancer. The name must be unique within the client AWS
459
- # account.
460
- # * +:instances+ - *required* - (Array<Hash>) A list of instances IDs
461
- # that should be registered with the LoadBalancer.
462
- # * +:instance_id+ - (String) Provides an EC2 instance ID.
463
- #
464
- # === Response Structure:
465
- #
466
- # * +:instances+ - (Array<Hash>)
467
- # * +:instance_id+ - (String)
468
- #
356
+ # @param [Hash] options
357
+ # * +:load_balancer_name+ - *required* - (String) The name associated
358
+ # with the LoadBalancer. The name must be unique within the client
359
+ # AWS account.
360
+ # * +:instances+ - *required* - (Array<Hash>) A list of instances IDs
361
+ # that should be registered with the LoadBalancer.
362
+ # * +:instance_id+ - (String) Provides an EC2 instance ID.
469
363
  # @return [Core::Response]
470
- #
364
+ # The #data method of the response object returns
365
+ # a hash with the following structure:
366
+ # * +:instances+ - (Array<Hash>)
367
+ # * +:instance_id+ - (String)
471
368
  define_client_method :register_instances_with_load_balancer, 'RegisterInstancesWithLoadBalancer'
472
369
 
473
370
  # Calls the SetLoadBalancerListenerSSLCertificate API operation.
474
371
  # @method set_load_balancer_listener_ssl_certificate(options = {})
475
- #
476
- # === Options:
477
- #
478
- # * +:load_balancer_name+ - *required* - (String) The name of the the
479
- # LoadBalancer.
480
- # * +:load_balancer_port+ - *required* - (Integer) The port that uses the
481
- # specified SSL certificate.
482
- # * +:ssl_certificate_id+ - *required* - (String) The ID of the SSL
483
- # certificate chain to use. For more information on SSL certificates,
484
- # see Managing Server Certificates in the AWS Identity and Access
485
- # Management documentation.
486
- #
487
- # === Response Structure:
488
- #
489
- # This method returns no response data.
490
- #
372
+ # @param [Hash] options
373
+ # * +:load_balancer_name+ - *required* - (String) The name of the the
374
+ # LoadBalancer.
375
+ # * +:load_balancer_port+ - *required* - (Integer) The port that uses
376
+ # the specified SSL certificate.
377
+ # * +:ssl_certificate_id+ - *required* - (String) The ID of the SSL
378
+ # certificate chain to use. For more information on SSL certificates,
379
+ # see Managing Server Certificates in the AWS Identity and Access
380
+ # Management documentation.
491
381
  # @return [Core::Response]
492
- #
493
382
  define_client_method :set_load_balancer_listener_ssl_certificate, 'SetLoadBalancerListenerSSLCertificate'
494
383
 
495
384
  # Calls the SetLoadBalancerPoliciesForBackendServer API operation.
496
385
  # @method set_load_balancer_policies_for_backend_server(options = {})
497
- #
498
- # === Options:
499
- #
500
- # * +:load_balancer_name+ - *required* - (String)
501
- # * +:instance_port+ - *required* - (Integer)
502
- # * +:policy_names+ - *required* - (Array<String>)
503
- #
504
- # === Response Structure:
505
- #
506
- # This method returns no response data.
507
- #
386
+ # @param [Hash] options
387
+ # * +:load_balancer_name+ - *required* - (String)
388
+ # * +:instance_port+ - *required* - (Integer)
389
+ # * +:policy_names+ - *required* - (Array<String>)
508
390
  # @return [Core::Response]
509
- #
510
391
  define_client_method :set_load_balancer_policies_for_backend_server, 'SetLoadBalancerPoliciesForBackendServer'
511
392
 
512
393
  # Calls the SetLoadBalancerPoliciesOfListener API operation.
513
394
  # @method set_load_balancer_policies_of_listener(options = {})
514
- #
515
- # === Options:
516
- #
517
- # * +:load_balancer_name+ - *required* - (String) The name associated
518
- # with the LoadBalancer. The name must be unique within the client AWS
519
- # account.
520
- # * +:load_balancer_port+ - *required* - (Integer) The external port of
521
- # the LoadBalancer with which this policy has to be associated.
522
- # * +:policy_names+ - *required* - (Array<String>) List of policies to be
523
- # associated with the listener. Currently this list can have at most
524
- # one policy. If the list is empty, the current policy is removed from
525
- # the listener.
526
- #
527
- # === Response Structure:
528
- #
529
- # This method returns no response data.
530
- #
395
+ # @param [Hash] options
396
+ # * +:load_balancer_name+ - *required* - (String) The name associated
397
+ # with the LoadBalancer. The name must be unique within the client
398
+ # AWS account.
399
+ # * +:load_balancer_port+ - *required* - (Integer) The external port of
400
+ # the LoadBalancer with which this policy has to be associated.
401
+ # * +:policy_names+ - *required* - (Array<String>) List of policies to
402
+ # be associated with the listener. Currently this list can have at
403
+ # most one policy. If the list is empty, the current policy is
404
+ # removed from the listener.
531
405
  # @return [Core::Response]
532
- #
533
406
  define_client_method :set_load_balancer_policies_of_listener, 'SetLoadBalancerPoliciesOfListener'
534
407
 
535
408
  ## end client methods ##