aws-sdk 1.13.0 → 1.14.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 (42) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +3 -3
  3. data/lib/aws/api_config/OpsWorks-2013-02-18.yml +55 -0
  4. data/lib/aws/api_config/SNS-2010-03-31.yml +0 -3
  5. data/lib/aws/api_config/SimpleWorkflow-2012-01-25.yml +30 -0
  6. data/lib/aws/auto_scaling/client.rb +0 -530
  7. data/lib/aws/cloud_formation/client.rb +0 -356
  8. data/lib/aws/cloud_front/client.rb +0 -1567
  9. data/lib/aws/cloud_search/client.rb +0 -578
  10. data/lib/aws/cloud_watch/client.rb +0 -445
  11. data/lib/aws/data_pipeline/client.rb +0 -396
  12. data/lib/aws/direct_connect/client.rb +0 -248
  13. data/lib/aws/dynamo_db.rb +0 -1
  14. data/lib/aws/dynamo_db/client.rb +70 -1
  15. data/lib/aws/dynamo_db/client_v2.rb +1 -1
  16. data/lib/aws/ec2/client.rb +0 -3942
  17. data/lib/aws/ec2/reserved_instances_offering_collection.rb +9 -3
  18. data/lib/aws/ec2/tag_collection.rb +1 -1
  19. data/lib/aws/elastic_beanstalk/client.rb +0 -898
  20. data/lib/aws/elastic_transcoder/client.rb +0 -1755
  21. data/lib/aws/elasticache/client.rb +0 -947
  22. data/lib/aws/elb/client.rb +0 -509
  23. data/lib/aws/emr/client.rb +0 -314
  24. data/lib/aws/glacier/client.rb +0 -278
  25. data/lib/aws/iam/client.rb +0 -1155
  26. data/lib/aws/import_export/client.rb +0 -96
  27. data/lib/aws/ops_works/client.rb +0 -1255
  28. data/lib/aws/rds/client.rb +0 -2367
  29. data/lib/aws/redshift/client.rb +0 -1458
  30. data/lib/aws/route_53/client.rb +0 -420
  31. data/lib/aws/simple_db/client.rb +2 -250
  32. data/lib/aws/simple_email_service/client.rb +0 -282
  33. data/lib/aws/simple_workflow/client.rb +0 -1248
  34. data/lib/aws/sns/client.rb +0 -283
  35. data/lib/aws/sns/message.rb +1 -1
  36. data/lib/aws/sqs/client.rb +0 -255
  37. data/lib/aws/storage_gateway/client.rb +0 -582
  38. data/lib/aws/sts/client.rb +0 -183
  39. data/lib/aws/support/client.rb +0 -232
  40. data/lib/aws/version.rb +1 -1
  41. metadata +2 -3
  42. data/lib/aws/dynamo_db/client_base.rb +0 -92
@@ -16,14 +16,19 @@ module AWS
16
16
  class ReservedInstancesOfferingCollection < Collection
17
17
 
18
18
  include TaggedCollection
19
+ include Core::Collection::WithLimitAndNextToken
19
20
 
20
21
  def member_class
21
22
  ReservedInstancesOffering
22
23
  end
23
24
 
24
- def each &block
25
- response = filtered_request(:describe_reserved_instances_offerings)
26
- response.reserved_instances_offerings_set.each do |item|
25
+ protected
26
+
27
+ def _each_item(next_token, max_results, options = {}, &block)
28
+ options[:next_token] = next_token if next_token
29
+ options[:max_results] = max_results if max_results
30
+ resp = filtered_request(:describe_reserved_instances_offerings, options)
31
+ resp.reserved_instances_offerings_set.each do |item|
27
32
 
28
33
  reserved_instance_offering = ReservedInstancesOffering.new_from(
29
34
  :describe_reserved_instances_offerings, item,
@@ -32,6 +37,7 @@ module AWS
32
37
  yield(reserved_instance_offering)
33
38
 
34
39
  end
40
+ resp[:next_token]
35
41
  end
36
42
 
37
43
  end
@@ -50,7 +50,7 @@ module AWS
50
50
  #
51
51
  # @example tagging with names (keys) and values
52
52
  #
53
- # ec2.tags.create(instance, 'stage', 'production')
53
+ # ec2.tags.create(instance, 'stage', :value => 'production')
54
54
  #
55
55
  # @param [Object] resource The item to tag. This should be a taggable
56
56
  # EC2 resource, like an instance, security group, etc.
@@ -26,904 +26,6 @@ module AWS
26
26
 
27
27
  class Client::V20101201 < Client
28
28
 
29
- # client methods #
30
-
31
- # @!method check_dns_availability(options = {})
32
- # Calls the CheckDNSAvailability API operation.
33
- # @param [Hash] options
34
- #
35
- # * `:cname_prefix` - *required* - (String) The prefix used when this
36
- # CNAME is reserved.
37
- # @return [Core::Response]
38
- # The #data method of the response object returns
39
- # a hash with the following structure:
40
- #
41
- # * `:available` - (Boolean)
42
- # * `:fully_qualified_cname` - (String)
43
-
44
- # @!method create_application(options = {})
45
- # Calls the CreateApplication API operation.
46
- # @param [Hash] options
47
- #
48
- # * `:application_name` - *required* - (String) The name of the
49
- # application. Constraint: This name must be unique within your
50
- # account. If the specified name already exists, the action returns
51
- # an InvalidParameterValue error.
52
- # * `:description` - (String) Describes the application.
53
- # @return [Core::Response]
54
- # The #data method of the response object returns
55
- # a hash with the following structure:
56
- #
57
- # * `:application` - (Hash)
58
- # * `:application_name` - (String)
59
- # * `:description` - (String)
60
- # * `:date_created` - (Time)
61
- # * `:date_updated` - (Time)
62
- # * `:versions` - (Array<String>)
63
- # * `:configuration_templates` - (Array<String>)
64
-
65
- # @!method create_application_version(options = {})
66
- # Calls the CreateApplicationVersion API operation.
67
- # @param [Hash] options
68
- #
69
- # * `:application_name` - *required* - (String) The name of the
70
- # application. If no application is found with this name, and
71
- # AutoCreateApplication is `false` , returns an InvalidParameterValue
72
- # error.
73
- # * `:version_label` - *required* - (String) A label identifying this
74
- # version. Constraint: Must be unique per application. If an
75
- # application version already exists with this label for the
76
- # specified application, AWS Elastic Beanstalk returns an
77
- # InvalidParameterValue error.
78
- # * `:description` - (String) Describes this version.
79
- # * `:source_bundle` - (Hash) The Amazon S3 bucket and key that
80
- # identify the location of the source bundle for this version. If
81
- # data found at the Amazon S3 location exceeds the maximum allowed
82
- # source bundle size, AWS Elastic Beanstalk returns an
83
- # InvalidParameterValue error. Default: If not specified, AWS Elastic
84
- # Beanstalk uses a sample application. If only partially specified
85
- # (for example, a bucket is provided but not the key) or if no data
86
- # is found at the Amazon S3 location, AWS Elastic Beanstalk returns
87
- # an InvalidParameterCombination error.
88
- # * `:s3_bucket` - (String) The Amazon S3 bucket where the data is
89
- # located.
90
- # * `:s3_key` - (String) The Amazon S3 key where the data is located.
91
- # * `:auto_create_application` - (Boolean) Determines how the system
92
- # behaves if the specified application for this version does not
93
- # already exist: `true` : Automatically creates the specified
94
- # application for this version if it does not already exist. `false`
95
- # : Returns an InvalidParameterValue if the specified application for
96
- # this version does not already exist. `true` : Automatically creates
97
- # the specified application for this release if it does not already
98
- # exist. `false` : Throws an InvalidParameterValue if the specified
99
- # application for this release does not already exist. Default:
100
- # `false` Valid Values: `true` | `false`
101
- # @return [Core::Response]
102
- # The #data method of the response object returns
103
- # a hash with the following structure:
104
- #
105
- # * `:application_version` - (Hash)
106
- # * `:application_name` - (String)
107
- # * `:description` - (String)
108
- # * `:version_label` - (String)
109
- # * `:source_bundle` - (Hash)
110
- # * `:s3_bucket` - (String)
111
- # * `:s3_key` - (String)
112
- # * `:date_created` - (Time)
113
- # * `:date_updated` - (Time)
114
-
115
- # @!method create_configuration_template(options = {})
116
- # Calls the CreateConfigurationTemplate API operation.
117
- # @param [Hash] options
118
- #
119
- # * `:application_name` - *required* - (String) The name of the
120
- # application to associate with this configuration template. If no
121
- # application is found with this name, AWS Elastic Beanstalk returns
122
- # an InvalidParameterValue error.
123
- # * `:template_name` - *required* - (String) The name of the
124
- # configuration template. Constraint: This name must be unique per
125
- # application. Default: If a configuration template already exists
126
- # with this name, AWS Elastic Beanstalk returns an
127
- # InvalidParameterValue error.
128
- # * `:solution_stack_name` - (String) The name of the solution stack
129
- # used by this configuration. The solution stack specifies the
130
- # operating system, architecture, and application server for a
131
- # configuration template. It determines the set of configuration
132
- # options as well as the possible and default values. Use
133
- # ListAvailableSolutionStacks to obtain a list of available solution
134
- # stacks. Default: If the SolutionStackName is not specified and the
135
- # source configuration parameter is blank, AWS Elastic Beanstalk uses
136
- # the default solution stack. If not specified and the source
137
- # configuration parameter is specified, AWS Elastic Beanstalk uses
138
- # the same solution stack as the source configuration template.
139
- # * `:source_configuration` - (Hash) If specified, AWS Elastic
140
- # Beanstalk uses the configuration values from the specified
141
- # configuration template to create a new configuration. Values
142
- # specified in the OptionSettings parameter of this call overrides
143
- # any values obtained from the SourceConfiguration. If no
144
- # configuration template is found, returns an InvalidParameterValue
145
- # error. Constraint: If both the solution stack name parameter and
146
- # the source configuration parameters are specified, the solution
147
- # stack of the source configuration template must match the specified
148
- # solution stack name or else AWS Elastic Beanstalk returns an
149
- # InvalidParameterCombination error.
150
- # * `:application_name` - (String) The name of the application
151
- # associated with the configuration.
152
- # * `:template_name` - (String) The name of the configuration
153
- # template.
154
- # * `:environment_id` - (String) The ID of the environment used with
155
- # this configuration template.
156
- # * `:description` - (String) Describes this configuration.
157
- # * `:option_settings` - (Array<Hash>) If specified, AWS Elastic
158
- # Beanstalk sets the specified configuration option to the requested
159
- # value. The new value overrides the value obtained from the solution
160
- # stack or the source configuration template.
161
- # * `:namespace` - (String) A unique namespace identifying the
162
- # option's associated AWS resource.
163
- # * `:option_name` - (String) The name of the configuration option.
164
- # * `:value` - (String) The current value for the configuration
165
- # option.
166
- # @return [Core::Response]
167
- # The #data method of the response object returns
168
- # a hash with the following structure:
169
- #
170
- # * `:solution_stack_name` - (String)
171
- # * `:application_name` - (String)
172
- # * `:template_name` - (String)
173
- # * `:description` - (String)
174
- # * `:environment_name` - (String)
175
- # * `:deployment_status` - (String)
176
- # * `:date_created` - (Time)
177
- # * `:date_updated` - (Time)
178
- # * `:option_settings` - (Array<Hash>)
179
- # * `:namespace` - (String)
180
- # * `:option_name` - (String)
181
- # * `:value` - (String)
182
-
183
- # @!method create_environment(options = {})
184
- # Calls the CreateEnvironment API operation.
185
- # @param [Hash] options
186
- #
187
- # * `:application_name` - *required* - (String) The name of the
188
- # application that contains the version to be deployed. If no
189
- # application is found with this name, CreateEnvironment returns an
190
- # InvalidParameterValue error.
191
- # * `:version_label` - (String) The name of the application version to
192
- # deploy. If the specified application has no associated application
193
- # versions, AWS Elastic Beanstalk UpdateEnvironment returns an
194
- # InvalidParameterValue error. Default: If not specified, AWS Elastic
195
- # Beanstalk attempts to launch the most recently created application
196
- # version.
197
- # * `:environment_name` - *required* - (String) A unique name for the
198
- # deployment environment. Used in the application URL. Constraint:
199
- # Must be from 4 to 23 characters in length. The name can contain
200
- # only letters, numbers, and hyphens. It cannot start or end with a
201
- # hyphen. This name must be unique in your account. If the specified
202
- # name already exists, AWS Elastic Beanstalk returns an
203
- # InvalidParameterValue error. Default: If the CNAME parameter is not
204
- # specified, the environment name becomes part of the CNAME, and
205
- # therefore part of the visible URL for your application.
206
- # * `:template_name` - (String) The name of the configuration template
207
- # to use in deployment. If no configuration template is found with
208
- # this name, AWS Elastic Beanstalk returns an InvalidParameterValue
209
- # error. Condition: You must specify either this parameter or a
210
- # SolutionStackName, but not both. If you specify both, AWS Elastic
211
- # Beanstalk returns an InvalidParameterCombination error. If you do
212
- # not specify either, AWS Elastic Beanstalk returns a
213
- # MissingRequiredParameter error.
214
- # * `:solution_stack_name` - (String) This is an alternative to
215
- # specifying a configuration name. If specified, AWS Elastic
216
- # Beanstalk sets the configuration values to the default values
217
- # associated with the specified solution stack. Condition: You must
218
- # specify either this or a TemplateName, but not both. If you specify
219
- # both, AWS Elastic Beanstalk returns an InvalidParameterCombination
220
- # error. If you do not specify either, AWS Elastic Beanstalk returns
221
- # a MissingRequiredParameter error.
222
- # * `:cname_prefix` - (String) If specified, the environment attempts
223
- # to use this value as the prefix for the CNAME. If not specified,
224
- # the environment uses the environment name.
225
- # * `:description` - (String) Describes this environment.
226
- # * `:option_settings` - (Array<Hash>) If specified, AWS Elastic
227
- # Beanstalk sets the specified configuration options to the requested
228
- # value in the configuration set for the new environment. These
229
- # override the values obtained from the solution stack or the
230
- # configuration template.
231
- # * `:namespace` - (String) A unique namespace identifying the
232
- # option's associated AWS resource.
233
- # * `:option_name` - (String) The name of the configuration option.
234
- # * `:value` - (String) The current value for the configuration
235
- # option.
236
- # * `:options_to_remove` - (Array<Hash>) A list of custom user-defined
237
- # configuration options to remove from the configuration set for this
238
- # new environment.
239
- # * `:namespace` - (String) A unique namespace identifying the
240
- # option's associated AWS resource.
241
- # * `:option_name` - (String) The name of the configuration option.
242
- # @return [Core::Response]
243
- # The #data method of the response object returns
244
- # a hash with the following structure:
245
- #
246
- # * `:environment_name` - (String)
247
- # * `:environment_id` - (String)
248
- # * `:application_name` - (String)
249
- # * `:version_label` - (String)
250
- # * `:solution_stack_name` - (String)
251
- # * `:template_name` - (String)
252
- # * `:description` - (String)
253
- # * `:endpoint_url` - (String)
254
- # * `:cname` - (String)
255
- # * `:date_created` - (Time)
256
- # * `:date_updated` - (Time)
257
- # * `:status` - (String)
258
- # * `:health` - (String)
259
- # * `:resources` - (Hash)
260
- # * `:load_balancer` - (Hash)
261
- # * `:load_balancer_name` - (String)
262
- # * `:domain` - (String)
263
- # * `:listeners` - (Array<Hash>)
264
- # * `:protocol` - (String)
265
- # * `:port` - (Integer)
266
-
267
- # @!method create_storage_location(options = {})
268
- # Calls the CreateStorageLocation API operation.
269
- # @param [Hash] options
270
- #
271
- # @return [Core::Response]
272
- # The #data method of the response object returns
273
- # a hash with the following structure:
274
- #
275
- # * `:s3_bucket` - (String)
276
-
277
- # @!method delete_application(options = {})
278
- # Calls the DeleteApplication API operation.
279
- # @param [Hash] options
280
- #
281
- # * `:application_name` - *required* - (String) The name of the
282
- # application to delete.
283
- # @return [Core::Response]
284
-
285
- # @!method delete_application_version(options = {})
286
- # Calls the DeleteApplicationVersion API operation.
287
- # @param [Hash] options
288
- #
289
- # * `:application_name` - *required* - (String) The name of the
290
- # application to delete releases from.
291
- # * `:version_label` - *required* - (String) The label of the version
292
- # to delete.
293
- # * `:delete_source_bundle` - (Boolean) Indicates whether to delete the
294
- # associated source bundle from Amazon S3: `true` : An attempt is
295
- # made to delete the associated Amazon S3 source bundle specified at
296
- # time of creation. `false` : No action is taken on the Amazon S3
297
- # source bundle specified at time of creation. Valid Values: `true` |
298
- # `false`
299
- # @return [Core::Response]
300
-
301
- # @!method delete_configuration_template(options = {})
302
- # Calls the DeleteConfigurationTemplate API operation.
303
- # @param [Hash] options
304
- #
305
- # * `:application_name` - *required* - (String) The name of the
306
- # application to delete the configuration template from.
307
- # * `:template_name` - *required* - (String) The name of the
308
- # configuration template to delete.
309
- # @return [Core::Response]
310
-
311
- # @!method delete_environment_configuration(options = {})
312
- # Calls the DeleteEnvironmentConfiguration API operation.
313
- # @param [Hash] options
314
- #
315
- # * `:application_name` - *required* - (String) The name of the
316
- # application the environment is associated with.
317
- # * `:environment_name` - *required* - (String) The name of the
318
- # environment to delete the draft configuration from.
319
- # @return [Core::Response]
320
-
321
- # @!method describe_application_versions(options = {})
322
- # Calls the DescribeApplicationVersions API operation.
323
- # @param [Hash] options
324
- #
325
- # * `:application_name` - (String) If specified, AWS Elastic Beanstalk
326
- # restricts the returned descriptions to only include ones that are
327
- # associated with the specified application.
328
- # * `:version_labels` - (Array<String>) If specified, restricts the
329
- # returned descriptions to only include ones that have the specified
330
- # version labels.
331
- # @return [Core::Response]
332
- # The #data method of the response object returns
333
- # a hash with the following structure:
334
- #
335
- # * `:application_versions` - (Array<Hash>)
336
- # * `:application_name` - (String)
337
- # * `:description` - (String)
338
- # * `:version_label` - (String)
339
- # * `:source_bundle` - (Hash)
340
- # * `:s3_bucket` - (String)
341
- # * `:s3_key` - (String)
342
- # * `:date_created` - (Time)
343
- # * `:date_updated` - (Time)
344
-
345
- # @!method describe_applications(options = {})
346
- # Calls the DescribeApplications API operation.
347
- # @param [Hash] options
348
- #
349
- # * `:application_names` - (Array<String>) If specified, AWS Elastic
350
- # Beanstalk restricts the returned descriptions to only include those
351
- # with the specified names.
352
- # @return [Core::Response]
353
- # The #data method of the response object returns
354
- # a hash with the following structure:
355
- #
356
- # * `:applications` - (Array<Hash>)
357
- # * `:application_name` - (String)
358
- # * `:description` - (String)
359
- # * `:date_created` - (Time)
360
- # * `:date_updated` - (Time)
361
- # * `:versions` - (Array<String>)
362
- # * `:configuration_templates` - (Array<String>)
363
-
364
- # @!method describe_configuration_options(options = {})
365
- # Calls the DescribeConfigurationOptions API operation.
366
- # @param [Hash] options
367
- #
368
- # * `:application_name` - (String) The name of the application
369
- # associated with the configuration template or environment. Only
370
- # needed if you want to describe the configuration options associated
371
- # with either the configuration template or environment.
372
- # * `:template_name` - (String) The name of the configuration template
373
- # whose configuration options you want to describe.
374
- # * `:environment_name` - (String) The name of the environment whose
375
- # configuration options you want to describe.
376
- # * `:solution_stack_name` - (String) The name of the solution stack
377
- # whose configuration options you want to describe.
378
- # * `:options` - (Array<Hash>) If specified, restricts the descriptions
379
- # to only the specified options.
380
- # * `:namespace` - (String) A unique namespace identifying the
381
- # option's associated AWS resource.
382
- # * `:option_name` - (String) The name of the configuration option.
383
- # @return [Core::Response]
384
- # The #data method of the response object returns
385
- # a hash with the following structure:
386
- #
387
- # * `:solution_stack_name` - (String)
388
- # * `:options` - (Array<Hash>)
389
- # * `:namespace` - (String)
390
- # * `:name` - (String)
391
- # * `:default_value` - (String)
392
- # * `:change_severity` - (String)
393
- # * `:user_defined` - (Boolean)
394
- # * `:value_type` - (String)
395
- # * `:value_options` - (Array<String>)
396
- # * `:min_value` - (Integer)
397
- # * `:max_value` - (Integer)
398
- # * `:max_length` - (Integer)
399
- # * `:regex` - (Hash)
400
- # * `:pattern` - (String)
401
- # * `:label` - (String)
402
-
403
- # @!method describe_configuration_settings(options = {})
404
- # Calls the DescribeConfigurationSettings API operation.
405
- # @param [Hash] options
406
- #
407
- # * `:application_name` - *required* - (String) The application for the
408
- # environment or configuration template.
409
- # * `:template_name` - (String) The name of the configuration template
410
- # to describe. Conditional: You must specify either this parameter or
411
- # an EnvironmentName, but not both. If you specify both, AWS Elastic
412
- # Beanstalk returns an InvalidParameterCombination error. If you do
413
- # not specify either, AWS Elastic Beanstalk returns a
414
- # MissingRequiredParameter error.
415
- # * `:environment_name` - (String) The name of the environment to
416
- # describe. Condition: You must specify either this or a
417
- # TemplateName, but not both. If you specify both, AWS Elastic
418
- # Beanstalk returns an InvalidParameterCombination error. If you do
419
- # not specify either, AWS Elastic Beanstalk returns
420
- # MissingRequiredParameter error.
421
- # @return [Core::Response]
422
- # The #data method of the response object returns
423
- # a hash with the following structure:
424
- #
425
- # * `:configuration_settings` - (Array<Hash>)
426
- # * `:solution_stack_name` - (String)
427
- # * `:application_name` - (String)
428
- # * `:template_name` - (String)
429
- # * `:description` - (String)
430
- # * `:environment_name` - (String)
431
- # * `:deployment_status` - (String)
432
- # * `:date_created` - (Time)
433
- # * `:date_updated` - (Time)
434
- # * `:option_settings` - (Array<Hash>)
435
- # * `:namespace` - (String)
436
- # * `:option_name` - (String)
437
- # * `:value` - (String)
438
-
439
- # @!method describe_environment_resources(options = {})
440
- # Calls the DescribeEnvironmentResources API operation.
441
- # @param [Hash] options
442
- #
443
- # * `:environment_id` - (String) The ID of the environment to retrieve
444
- # AWS resource usage data. Condition: You must specify either this or
445
- # an EnvironmentName, or both. If you do not specify either, AWS
446
- # Elastic Beanstalk returns MissingRequiredParameter error.
447
- # * `:environment_name` - (String) The name of the environment to
448
- # retrieve AWS resource usage data. Condition: You must specify
449
- # either this or an EnvironmentId, or both. If you do not specify
450
- # either, AWS Elastic Beanstalk returns MissingRequiredParameter
451
- # error.
452
- # @return [Core::Response]
453
- # The #data method of the response object returns
454
- # a hash with the following structure:
455
- #
456
- # * `:environment_resources` - (Hash)
457
- # * `:environment_name` - (String)
458
- # * `:auto_scaling_groups` - (Array<Hash>)
459
- # * `:name` - (String)
460
- # * `:instances` - (Array<Hash>)
461
- # * `:id` - (String)
462
- # * `:launch_configurations` - (Array<Hash>)
463
- # * `:name` - (String)
464
- # * `:load_balancers` - (Array<Hash>)
465
- # * `:name` - (String)
466
- # * `:triggers` - (Array<Hash>)
467
- # * `:name` - (String)
468
-
469
- # @!method describe_environments(options = {})
470
- # Calls the DescribeEnvironments API operation.
471
- # @param [Hash] options
472
- #
473
- # * `:application_name` - (String) If specified, AWS Elastic Beanstalk
474
- # restricts the returned descriptions to include only those that are
475
- # associated with this application.
476
- # * `:version_label` - (String) If specified, AWS Elastic Beanstalk
477
- # restricts the returned descriptions to include only those that are
478
- # associated with this application version.
479
- # * `:environment_ids` - (Array<String>) If specified, AWS Elastic
480
- # Beanstalk restricts the returned descriptions to include only those
481
- # that have the specified IDs.
482
- # * `:environment_names` - (Array<String>) If specified, AWS Elastic
483
- # Beanstalk restricts the returned descriptions to include only those
484
- # that have the specified names.
485
- # * `:include_deleted` - (Boolean) Indicates whether to include deleted
486
- # environments: `true` : Environments that have been deleted after
487
- # IncludedDeletedBackTo are displayed. `false` : Do not include
488
- # deleted environments.
489
- # * `:included_deleted_back_to` - (String<ISO8601 datetime>) If
490
- # specified when IncludeDeleted is set to `true` , then environments
491
- # deleted after this date are displayed.
492
- # @return [Core::Response]
493
- # The #data method of the response object returns
494
- # a hash with the following structure:
495
- #
496
- # * `:environments` - (Array<Hash>)
497
- # * `:environment_name` - (String)
498
- # * `:environment_id` - (String)
499
- # * `:application_name` - (String)
500
- # * `:version_label` - (String)
501
- # * `:solution_stack_name` - (String)
502
- # * `:template_name` - (String)
503
- # * `:description` - (String)
504
- # * `:endpoint_url` - (String)
505
- # * `:cname` - (String)
506
- # * `:date_created` - (Time)
507
- # * `:date_updated` - (Time)
508
- # * `:status` - (String)
509
- # * `:health` - (String)
510
- # * `:resources` - (Hash)
511
- # * `:load_balancer` - (Hash)
512
- # * `:load_balancer_name` - (String)
513
- # * `:domain` - (String)
514
- # * `:listeners` - (Array<Hash>)
515
- # * `:protocol` - (String)
516
- # * `:port` - (Integer)
517
-
518
- # @!method describe_events(options = {})
519
- # Calls the DescribeEvents API operation.
520
- # @param [Hash] options
521
- #
522
- # * `:application_name` - (String) If specified, AWS Elastic Beanstalk
523
- # restricts the returned descriptions to include only those
524
- # associated with this application.
525
- # * `:version_label` - (String) If specified, AWS Elastic Beanstalk
526
- # restricts the returned descriptions to those associated with this
527
- # application version.
528
- # * `:template_name` - (String) If specified, AWS Elastic Beanstalk
529
- # restricts the returned descriptions to those that are associated
530
- # with this environment configuration.
531
- # * `:environment_id` - (String) If specified, AWS Elastic Beanstalk
532
- # restricts the returned descriptions to those associated with this
533
- # environment.
534
- # * `:environment_name` - (String) If specified, AWS Elastic Beanstalk
535
- # restricts the returned descriptions to those associated with this
536
- # environment.
537
- # * `:request_id` - (String) If specified, AWS Elastic Beanstalk
538
- # restricts the described events to include only those associated
539
- # with this request ID.
540
- # * `:severity` - (String) If specified, limits the events returned
541
- # from this call to include only those with the specified severity or
542
- # higher. Valid values include:
543
- # * `TRACE`
544
- # * `DEBUG`
545
- # * `INFO`
546
- # * `WARN`
547
- # * `ERROR`
548
- # * `FATAL`
549
- # * `:start_time` - (String<ISO8601 datetime>) If specified, AWS
550
- # Elastic Beanstalk restricts the returned descriptions to those that
551
- # occur on or after this time.
552
- # * `:end_time` - (String<ISO8601 datetime>) If specified, AWS Elastic
553
- # Beanstalk restricts the returned descriptions to those that occur
554
- # up to, but not including, the EndTime.
555
- # * `:max_records` - (Integer) Specifies the maximum number of events
556
- # that can be returned, beginning with the most recent event.
557
- # * `:next_token` - (String) Pagination token. If specified, the events
558
- # return the next batch of results.
559
- # @return [Core::Response]
560
- # The #data method of the response object returns
561
- # a hash with the following structure:
562
- #
563
- # * `:events` - (Array<Hash>)
564
- # * `:event_date` - (Time)
565
- # * `:message` - (String)
566
- # * `:application_name` - (String)
567
- # * `:version_label` - (String)
568
- # * `:template_name` - (String)
569
- # * `:environment_name` - (String)
570
- # * `:request_id` - (String)
571
- # * `:severity` - (String)
572
- # * `:next_token` - (String)
573
-
574
- # @!method list_available_solution_stacks(options = {})
575
- # Calls the ListAvailableSolutionStacks API operation.
576
- # @param [Hash] options
577
- #
578
- # @return [Core::Response]
579
- # The #data method of the response object returns
580
- # a hash with the following structure:
581
- #
582
- # * `:solution_stacks` - (Array<String>)
583
- # * `:solution_stack_details` - (Array<Hash>)
584
- # * `:solution_stack_name` - (String)
585
- # * `:permitted_file_types` - (Array<String>)
586
-
587
- # @!method rebuild_environment(options = {})
588
- # Calls the RebuildEnvironment API operation.
589
- # @param [Hash] options
590
- #
591
- # * `:environment_id` - (String) The ID of the environment to rebuild.
592
- # Condition: You must specify either this or an EnvironmentName, or
593
- # both. If you do not specify either, AWS Elastic Beanstalk returns
594
- # MissingRequiredParameter error.
595
- # * `:environment_name` - (String) The name of the environment to
596
- # rebuild. Condition: You must specify either this or an
597
- # EnvironmentId, or both. If you do not specify either, AWS Elastic
598
- # Beanstalk returns MissingRequiredParameter error.
599
- # @return [Core::Response]
600
-
601
- # @!method request_environment_info(options = {})
602
- # Calls the RequestEnvironmentInfo API operation.
603
- # @param [Hash] options
604
- #
605
- # * `:environment_id` - (String) The ID of the environment of the
606
- # requested data. If no such environment is found,
607
- # RequestEnvironmentInfo returns an InvalidParameterValue error.
608
- # Condition: You must specify either this or an EnvironmentName, or
609
- # both. If you do not specify either, AWS Elastic Beanstalk returns
610
- # MissingRequiredParameter error.
611
- # * `:environment_name` - (String) The name of the environment of the
612
- # requested data. If no such environment is found,
613
- # RequestEnvironmentInfo returns an InvalidParameterValue error.
614
- # Condition: You must specify either this or an EnvironmentId, or
615
- # both. If you do not specify either, AWS Elastic Beanstalk returns
616
- # MissingRequiredParameter error.
617
- # * `:info_type` - *required* - (String) The type of information to
618
- # request. Valid values include:
619
- # * `tail`
620
- # @return [Core::Response]
621
-
622
- # @!method restart_app_server(options = {})
623
- # Calls the RestartAppServer API operation.
624
- # @param [Hash] options
625
- #
626
- # * `:environment_id` - (String) The ID of the environment to restart
627
- # the server for. Condition: You must specify either this or an
628
- # EnvironmentName, or both. If you do not specify either, AWS Elastic
629
- # Beanstalk returns MissingRequiredParameter error.
630
- # * `:environment_name` - (String) The name of the environment to
631
- # restart the server for. Condition: You must specify either this or
632
- # an EnvironmentId, or both. If you do not specify either, AWS
633
- # Elastic Beanstalk returns MissingRequiredParameter error.
634
- # @return [Core::Response]
635
-
636
- # @!method retrieve_environment_info(options = {})
637
- # Calls the RetrieveEnvironmentInfo API operation.
638
- # @param [Hash] options
639
- #
640
- # * `:environment_id` - (String) The ID of the data's environment. If
641
- # no such environment is found, returns an InvalidParameterValue
642
- # error. Condition: You must specify either this or an
643
- # EnvironmentName, or both. If you do not specify either, AWS Elastic
644
- # Beanstalk returns MissingRequiredParameter error.
645
- # * `:environment_name` - (String) The name of the data's environment.
646
- # If no such environment is found, returns an InvalidParameterValue
647
- # error. Condition: You must specify either this or an EnvironmentId,
648
- # or both. If you do not specify either, AWS Elastic Beanstalk
649
- # returns MissingRequiredParameter error.
650
- # * `:info_type` - *required* - (String) The type of information to
651
- # retrieve. Valid values include:
652
- # * `tail`
653
- # @return [Core::Response]
654
- # The #data method of the response object returns
655
- # a hash with the following structure:
656
- #
657
- # * `:environment_info` - (Array<Hash>)
658
- # * `:info_type` - (String)
659
- # * `:ec2_instance_id` - (String)
660
- # * `:sample_timestamp` - (Time)
661
- # * `:message` - (String)
662
-
663
- # @!method swap_environment_cnam_es(options = {})
664
- # Calls the SwapEnvironmentCNAMEs API operation.
665
- # @param [Hash] options
666
- #
667
- # * `:source_environment_id` - (String) The ID of the source
668
- # environment. Condition: You must specify at least the
669
- # SourceEnvironmentID or the SourceEnvironmentName. You may also
670
- # specify both. If you specify the SourceEnvironmentId, you must
671
- # specify the DestinationEnvironmentId.
672
- # * `:source_environment_name` - (String) The name of the source
673
- # environment. Condition: You must specify at least the
674
- # SourceEnvironmentID or the SourceEnvironmentName. You may also
675
- # specify both. If you specify the SourceEnvironmentName, you must
676
- # specify the DestinationEnvironmentName.
677
- # * `:destination_environment_id` - (String) The ID of the destination
678
- # environment. Condition: You must specify at least the
679
- # DestinationEnvironmentID or the DestinationEnvironmentName. You may
680
- # also specify both. You must specify the SourceEnvironmentId with
681
- # the DestinationEnvironmentId.
682
- # * `:destination_environment_name` - (String) The name of the
683
- # destination environment. Condition: You must specify at least the
684
- # DestinationEnvironmentID or the DestinationEnvironmentName. You may
685
- # also specify both. You must specify the SourceEnvironmentName with
686
- # the DestinationEnvironmentName.
687
- # @return [Core::Response]
688
-
689
- # @!method terminate_environment(options = {})
690
- # Calls the TerminateEnvironment API operation.
691
- # @param [Hash] options
692
- #
693
- # * `:environment_id` - (String) The ID of the environment to
694
- # terminate. Condition: You must specify either this or an
695
- # EnvironmentName, or both. If you do not specify either, AWS Elastic
696
- # Beanstalk returns MissingRequiredParameter error.
697
- # * `:environment_name` - (String) The name of the environment to
698
- # terminate. Condition: You must specify either this or an
699
- # EnvironmentId, or both. If you do not specify either, AWS Elastic
700
- # Beanstalk returns MissingRequiredParameter error.
701
- # * `:terminate_resources` - (Boolean) Indicates whether the associated
702
- # AWS resources should shut down when the environment is terminated:
703
- # `true` : (default) The user AWS resources (for example, the Auto
704
- # Scaling group, LoadBalancer, etc.) are terminated along with the
705
- # environment. `false` : The environment is removed from the AWS
706
- # Elastic Beanstalk but the AWS resources continue to operate. `true`
707
- # : The specified environment as well as the associated AWS
708
- # resources, such as Auto Scaling group and LoadBalancer, are
709
- # terminated. `false` : AWS Elastic Beanstalk resource management is
710
- # removed from the environment, but the AWS resources continue to
711
- # operate. For more information, see the AWS Elastic Beanstalk User
712
- # Guide. Default: `true` Valid Values: `true` | `false`
713
- # @return [Core::Response]
714
- # The #data method of the response object returns
715
- # a hash with the following structure:
716
- #
717
- # * `:environment_name` - (String)
718
- # * `:environment_id` - (String)
719
- # * `:application_name` - (String)
720
- # * `:version_label` - (String)
721
- # * `:solution_stack_name` - (String)
722
- # * `:template_name` - (String)
723
- # * `:description` - (String)
724
- # * `:endpoint_url` - (String)
725
- # * `:cname` - (String)
726
- # * `:date_created` - (Time)
727
- # * `:date_updated` - (Time)
728
- # * `:status` - (String)
729
- # * `:health` - (String)
730
- # * `:resources` - (Hash)
731
- # * `:load_balancer` - (Hash)
732
- # * `:load_balancer_name` - (String)
733
- # * `:domain` - (String)
734
- # * `:listeners` - (Array<Hash>)
735
- # * `:protocol` - (String)
736
- # * `:port` - (Integer)
737
-
738
- # @!method update_application(options = {})
739
- # Calls the UpdateApplication API operation.
740
- # @param [Hash] options
741
- #
742
- # * `:application_name` - *required* - (String) The name of the
743
- # application to update. If no such application is found,
744
- # UpdateApplication returns an InvalidParameterValue error.
745
- # * `:description` - (String) A new description for the application.
746
- # Default: If not specified, AWS Elastic Beanstalk does not update
747
- # the description.
748
- # @return [Core::Response]
749
- # The #data method of the response object returns
750
- # a hash with the following structure:
751
- #
752
- # * `:application` - (Hash)
753
- # * `:application_name` - (String)
754
- # * `:description` - (String)
755
- # * `:date_created` - (Time)
756
- # * `:date_updated` - (Time)
757
- # * `:versions` - (Array<String>)
758
- # * `:configuration_templates` - (Array<String>)
759
-
760
- # @!method update_application_version(options = {})
761
- # Calls the UpdateApplicationVersion API operation.
762
- # @param [Hash] options
763
- #
764
- # * `:application_name` - *required* - (String) The name of the
765
- # application associated with this version. If no application is
766
- # found with this name, UpdateApplication returns an
767
- # InvalidParameterValue error.
768
- # * `:version_label` - *required* - (String) The name of the version to
769
- # update. If no application version is found with this label,
770
- # UpdateApplication returns an InvalidParameterValue error.
771
- # * `:description` - (String) A new description for this release.
772
- # @return [Core::Response]
773
- # The #data method of the response object returns
774
- # a hash with the following structure:
775
- #
776
- # * `:application_version` - (Hash)
777
- # * `:application_name` - (String)
778
- # * `:description` - (String)
779
- # * `:version_label` - (String)
780
- # * `:source_bundle` - (Hash)
781
- # * `:s3_bucket` - (String)
782
- # * `:s3_key` - (String)
783
- # * `:date_created` - (Time)
784
- # * `:date_updated` - (Time)
785
-
786
- # @!method update_configuration_template(options = {})
787
- # Calls the UpdateConfigurationTemplate API operation.
788
- # @param [Hash] options
789
- #
790
- # * `:application_name` - *required* - (String) The name of the
791
- # application associated with the configuration template to update.
792
- # If no application is found with this name,
793
- # UpdateConfigurationTemplate returns an InvalidParameterValue error.
794
- # * `:template_name` - *required* - (String) The name of the
795
- # configuration template to update. If no configuration template is
796
- # found with this name, UpdateConfigurationTemplate returns an
797
- # InvalidParameterValue error.
798
- # * `:description` - (String) A new description for the configuration.
799
- # * `:option_settings` - (Array<Hash>) A list of configuration option
800
- # settings to update with the new specified option value.
801
- # * `:namespace` - (String) A unique namespace identifying the
802
- # option's associated AWS resource.
803
- # * `:option_name` - (String) The name of the configuration option.
804
- # * `:value` - (String) The current value for the configuration
805
- # option.
806
- # * `:options_to_remove` - (Array<Hash>) A list of configuration
807
- # options to remove from the configuration set. Constraint: You can
808
- # remove only UserDefined configuration options.
809
- # * `:namespace` - (String) A unique namespace identifying the
810
- # option's associated AWS resource.
811
- # * `:option_name` - (String) The name of the configuration option.
812
- # @return [Core::Response]
813
- # The #data method of the response object returns
814
- # a hash with the following structure:
815
- #
816
- # * `:solution_stack_name` - (String)
817
- # * `:application_name` - (String)
818
- # * `:template_name` - (String)
819
- # * `:description` - (String)
820
- # * `:environment_name` - (String)
821
- # * `:deployment_status` - (String)
822
- # * `:date_created` - (Time)
823
- # * `:date_updated` - (Time)
824
- # * `:option_settings` - (Array<Hash>)
825
- # * `:namespace` - (String)
826
- # * `:option_name` - (String)
827
- # * `:value` - (String)
828
-
829
- # @!method update_environment(options = {})
830
- # Calls the UpdateEnvironment API operation.
831
- # @param [Hash] options
832
- #
833
- # * `:environment_id` - (String) The ID of the environment to update.
834
- # If no environment with this ID exists, AWS Elastic Beanstalk
835
- # returns an InvalidParameterValue error. Condition: You must specify
836
- # either this or an EnvironmentName, or both. If you do not specify
837
- # either, AWS Elastic Beanstalk returns MissingRequiredParameter
838
- # error.
839
- # * `:environment_name` - (String) The name of the environment to
840
- # update. If no environment with this name exists, AWS Elastic
841
- # Beanstalk returns an InvalidParameterValue error. Condition: You
842
- # must specify either this or an EnvironmentId, or both. If you do
843
- # not specify either, AWS Elastic Beanstalk returns
844
- # MissingRequiredParameter error.
845
- # * `:version_label` - (String) If this parameter is specified, AWS
846
- # Elastic Beanstalk deploys the named application version to the
847
- # environment. If no such application version is found, returns an
848
- # InvalidParameterValue error.
849
- # * `:template_name` - (String) If this parameter is specified, AWS
850
- # Elastic Beanstalk deploys this configuration template to the
851
- # environment. If no such configuration template is found, AWS
852
- # Elastic Beanstalk returns an InvalidParameterValue error.
853
- # * `:description` - (String) If this parameter is specified, AWS
854
- # Elastic Beanstalk updates the description of this environment.
855
- # * `:option_settings` - (Array<Hash>) If specified, AWS Elastic
856
- # Beanstalk updates the configuration set associated with the running
857
- # environment and sets the specified configuration options to the
858
- # requested value.
859
- # * `:namespace` - (String) A unique namespace identifying the
860
- # option's associated AWS resource.
861
- # * `:option_name` - (String) The name of the configuration option.
862
- # * `:value` - (String) The current value for the configuration
863
- # option.
864
- # * `:options_to_remove` - (Array<Hash>) A list of custom user-defined
865
- # configuration options to remove from the configuration set for this
866
- # environment.
867
- # * `:namespace` - (String) A unique namespace identifying the
868
- # option's associated AWS resource.
869
- # * `:option_name` - (String) The name of the configuration option.
870
- # @return [Core::Response]
871
- # The #data method of the response object returns
872
- # a hash with the following structure:
873
- #
874
- # * `:environment_name` - (String)
875
- # * `:environment_id` - (String)
876
- # * `:application_name` - (String)
877
- # * `:version_label` - (String)
878
- # * `:solution_stack_name` - (String)
879
- # * `:template_name` - (String)
880
- # * `:description` - (String)
881
- # * `:endpoint_url` - (String)
882
- # * `:cname` - (String)
883
- # * `:date_created` - (Time)
884
- # * `:date_updated` - (Time)
885
- # * `:status` - (String)
886
- # * `:health` - (String)
887
- # * `:resources` - (Hash)
888
- # * `:load_balancer` - (Hash)
889
- # * `:load_balancer_name` - (String)
890
- # * `:domain` - (String)
891
- # * `:listeners` - (Array<Hash>)
892
- # * `:protocol` - (String)
893
- # * `:port` - (Integer)
894
-
895
- # @!method validate_configuration_settings(options = {})
896
- # Calls the ValidateConfigurationSettings API operation.
897
- # @param [Hash] options
898
- #
899
- # * `:application_name` - *required* - (String) The name of the
900
- # application that the configuration template or environment belongs
901
- # to.
902
- # * `:template_name` - (String) The name of the configuration template
903
- # to validate the settings against. Condition: You cannot specify
904
- # both this and an environment name.
905
- # * `:environment_name` - (String) The name of the environment to
906
- # validate the settings against. Condition: You cannot specify both
907
- # this and a configuration template name.
908
- # * `:option_settings` - *required* - (Array<Hash>) A list of the
909
- # options and desired values to evaluate.
910
- # * `:namespace` - (String) A unique namespace identifying the
911
- # option's associated AWS resource.
912
- # * `:option_name` - (String) The name of the configuration option.
913
- # * `:value` - (String) The current value for the configuration
914
- # option.
915
- # @return [Core::Response]
916
- # The #data method of the response object returns
917
- # a hash with the following structure:
918
- #
919
- # * `:messages` - (Array<Hash>)
920
- # * `:message` - (String)
921
- # * `:severity` - (String)
922
- # * `:namespace` - (String)
923
- # * `:option_name` - (String)
924
-
925
- # end client methods #
926
-
927
29
  define_client_methods('2010-12-01')
928
30
 
929
31
  end