aws-sdk 1.13.0 → 1.14.0

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -31,451 +31,6 @@ module AWS
31
31
 
32
32
  class Client::V20100801 < Client
33
33
 
34
- # client methods #
35
-
36
- # @!method delete_alarms(options = {})
37
- # Calls the DeleteAlarms API operation.
38
- # @param [Hash] options
39
- #
40
- # * `:alarm_names` - *required* - (Array<String>) A list of alarms to
41
- # be deleted.
42
- # @return [Core::Response]
43
-
44
- # @!method describe_alarm_history(options = {})
45
- # Calls the DescribeAlarmHistory API operation.
46
- # @param [Hash] options
47
- #
48
- # * `:alarm_name` - (String) The name of the alarm.
49
- # * `:history_item_type` - (String) The type of alarm histories to
50
- # retrieve. Valid values include:
51
- # * `ConfigurationUpdate`
52
- # * `StateUpdate`
53
- # * `Action`
54
- # * `:start_date` - (String<ISO8601 datetime>) The starting date to
55
- # retrieve alarm history.
56
- # * `:end_date` - (String<ISO8601 datetime>) The ending date to
57
- # retrieve alarm history.
58
- # * `:max_records` - (Integer) The maximum number of alarm history
59
- # records to retrieve.
60
- # * `:next_token` - (String) The token returned by a previous call to
61
- # indicate that there is more data available.
62
- # @return [Core::Response]
63
- # The #data method of the response object returns
64
- # a hash with the following structure:
65
- #
66
- # * `:alarm_history_items` - (Array<Hash>)
67
- # * `:alarm_name` - (String)
68
- # * `:timestamp` - (Time)
69
- # * `:history_item_type` - (String)
70
- # * `:history_summary` - (String)
71
- # * `:history_data` - (String)
72
- # * `:next_token` - (String)
73
-
74
- # @!method describe_alarms(options = {})
75
- # Calls the DescribeAlarms API operation.
76
- # @param [Hash] options
77
- #
78
- # * `:alarm_names` - (Array<String>) A list of alarm names to retrieve
79
- # information for.
80
- # * `:alarm_name_prefix` - (String) The alarm name prefix. AlarmNames
81
- # cannot be specified if this parameter is specified.
82
- # * `:state_value` - (String) The state value to be used in matching
83
- # alarms. Valid values include:
84
- # * `OK`
85
- # * `ALARM`
86
- # * `INSUFFICIENT_DATA`
87
- # * `:action_prefix` - (String) The action name prefix.
88
- # * `:max_records` - (Integer) The maximum number of alarm descriptions
89
- # to retrieve.
90
- # * `:next_token` - (String) The token returned by a previous call to
91
- # indicate that there is more data available.
92
- # @return [Core::Response]
93
- # The #data method of the response object returns
94
- # a hash with the following structure:
95
- #
96
- # * `:metric_alarms` - (Array<Hash>)
97
- # * `:alarm_name` - (String)
98
- # * `:alarm_arn` - (String)
99
- # * `:alarm_description` - (String)
100
- # * `:alarm_configuration_updated_timestamp` - (Time)
101
- # * `:actions_enabled` - (Boolean)
102
- # * `:ok_actions` - (Array<String>)
103
- # * `:alarm_actions` - (Array<String>)
104
- # * `:insufficient_data_actions` - (Array<String>)
105
- # * `:state_value` - (String)
106
- # * `:state_reason` - (String)
107
- # * `:state_reason_data` - (String)
108
- # * `:state_updated_timestamp` - (Time)
109
- # * `:metric_name` - (String)
110
- # * `:namespace` - (String)
111
- # * `:statistic` - (String)
112
- # * `:dimensions` - (Array<Hash>)
113
- # * `:name` - (String)
114
- # * `:value` - (String)
115
- # * `:period` - (Integer)
116
- # * `:unit` - (String)
117
- # * `:evaluation_periods` - (Integer)
118
- # * `:threshold` - (Numeric)
119
- # * `:comparison_operator` - (String)
120
- # * `:next_token` - (String)
121
-
122
- # @!method describe_alarms_for_metric(options = {})
123
- # Calls the DescribeAlarmsForMetric API operation.
124
- # @param [Hash] options
125
- #
126
- # * `:metric_name` - *required* - (String) The name of the metric.
127
- # * `:namespace` - *required* - (String) The namespace of the metric.
128
- # * `:statistic` - (String) The statistic for the metric. Valid values
129
- # include:
130
- # * `SampleCount`
131
- # * `Average`
132
- # * `Sum`
133
- # * `Minimum`
134
- # * `Maximum`
135
- # * `:dimensions` - (Array<Hash>) The list of dimensions associated
136
- # with the metric.
137
- # * `:name` - *required* - (String) The name of the dimension.
138
- # * `:value` - *required* - (String) The value representing the
139
- # dimension measurement
140
- # * `:period` - (Integer) The period in seconds over which the
141
- # statistic is applied.
142
- # * `:unit` - (String) The unit for the metric. Valid values include:
143
- # * `Seconds`
144
- # * `Microseconds`
145
- # * `Milliseconds`
146
- # * `Bytes`
147
- # * `Kilobytes`
148
- # * `Megabytes`
149
- # * `Gigabytes`
150
- # * `Terabytes`
151
- # * `Bits`
152
- # * `Kilobits`
153
- # * `Megabits`
154
- # * `Gigabits`
155
- # * `Terabits`
156
- # * `Percent`
157
- # * `Count`
158
- # * `Bytes/Second`
159
- # * `Kilobytes/Second`
160
- # * `Megabytes/Second`
161
- # * `Gigabytes/Second`
162
- # * `Terabytes/Second`
163
- # * `Bits/Second`
164
- # * `Kilobits/Second`
165
- # * `Megabits/Second`
166
- # * `Gigabits/Second`
167
- # * `Terabits/Second`
168
- # * `Count/Second`
169
- # * `None`
170
- # @return [Core::Response]
171
- # The #data method of the response object returns
172
- # a hash with the following structure:
173
- #
174
- # * `:metric_alarms` - (Array<Hash>)
175
- # * `:alarm_name` - (String)
176
- # * `:alarm_arn` - (String)
177
- # * `:alarm_description` - (String)
178
- # * `:alarm_configuration_updated_timestamp` - (Time)
179
- # * `:actions_enabled` - (Boolean)
180
- # * `:ok_actions` - (Array<String>)
181
- # * `:alarm_actions` - (Array<String>)
182
- # * `:insufficient_data_actions` - (Array<String>)
183
- # * `:state_value` - (String)
184
- # * `:state_reason` - (String)
185
- # * `:state_reason_data` - (String)
186
- # * `:state_updated_timestamp` - (Time)
187
- # * `:metric_name` - (String)
188
- # * `:namespace` - (String)
189
- # * `:statistic` - (String)
190
- # * `:dimensions` - (Array<Hash>)
191
- # * `:name` - (String)
192
- # * `:value` - (String)
193
- # * `:period` - (Integer)
194
- # * `:unit` - (String)
195
- # * `:evaluation_periods` - (Integer)
196
- # * `:threshold` - (Numeric)
197
- # * `:comparison_operator` - (String)
198
-
199
- # @!method disable_alarm_actions(options = {})
200
- # Calls the DisableAlarmActions API operation.
201
- # @param [Hash] options
202
- #
203
- # * `:alarm_names` - *required* - (Array<String>) The names of the
204
- # alarms to disable actions for.
205
- # @return [Core::Response]
206
-
207
- # @!method enable_alarm_actions(options = {})
208
- # Calls the EnableAlarmActions API operation.
209
- # @param [Hash] options
210
- #
211
- # * `:alarm_names` - *required* - (Array<String>) The names of the
212
- # alarms to enable actions for.
213
- # @return [Core::Response]
214
-
215
- # @!method get_metric_statistics(options = {})
216
- # Calls the GetMetricStatistics API operation.
217
- # @param [Hash] options
218
- #
219
- # * `:namespace` - *required* - (String) The namespace of the metric.
220
- # * `:metric_name` - *required* - (String) The name of the metric.
221
- # * `:dimensions` - (Array<Hash>) A list of dimensions describing
222
- # qualities of the metric.
223
- # * `:name` - *required* - (String) The name of the dimension.
224
- # * `:value` - *required* - (String) The value representing the
225
- # dimension measurement
226
- # * `:start_time` - *required* - (String<ISO8601 datetime>) The time
227
- # stamp to use for determining the first datapoint to return. The
228
- # value specified is inclusive; results include datapoints with the
229
- # time stamp specified. The specified start time is rounded down to
230
- # the nearest value. Datapoints are returned for start times up to
231
- # two weeks in the past. Specified start times that are more than two
232
- # weeks in the past will not return datapoints for metrics that are
233
- # older than two weeks.
234
- # * `:end_time` - *required* - (String<ISO8601 datetime>) The time
235
- # stamp to use for determining the last datapoint to return. The
236
- # value specified is exclusive; results will include datapoints up to
237
- # the time stamp specified.
238
- # * `:period` - *required* - (Integer) The granularity, in seconds, of
239
- # the returned datapoints. Period must be at least 60 seconds and
240
- # must be a multiple of 60. The default value is 60.
241
- # * `:statistics` - *required* - (Array<String>) The metric statistics
242
- # to return.
243
- # * `:unit` - (String) The unit for the metric. Valid values include:
244
- # * `Seconds`
245
- # * `Microseconds`
246
- # * `Milliseconds`
247
- # * `Bytes`
248
- # * `Kilobytes`
249
- # * `Megabytes`
250
- # * `Gigabytes`
251
- # * `Terabytes`
252
- # * `Bits`
253
- # * `Kilobits`
254
- # * `Megabits`
255
- # * `Gigabits`
256
- # * `Terabits`
257
- # * `Percent`
258
- # * `Count`
259
- # * `Bytes/Second`
260
- # * `Kilobytes/Second`
261
- # * `Megabytes/Second`
262
- # * `Gigabytes/Second`
263
- # * `Terabytes/Second`
264
- # * `Bits/Second`
265
- # * `Kilobits/Second`
266
- # * `Megabits/Second`
267
- # * `Gigabits/Second`
268
- # * `Terabits/Second`
269
- # * `Count/Second`
270
- # * `None`
271
- # @return [Core::Response]
272
- # The #data method of the response object returns
273
- # a hash with the following structure:
274
- #
275
- # * `:label` - (String)
276
- # * `:datapoints` - (Array<Hash>)
277
- # * `:timestamp` - (Time)
278
- # * `:sample_count` - (Numeric)
279
- # * `:average` - (Numeric)
280
- # * `:sum` - (Numeric)
281
- # * `:minimum` - (Numeric)
282
- # * `:maximum` - (Numeric)
283
- # * `:unit` - (String)
284
-
285
- # @!method list_metrics(options = {})
286
- # Calls the ListMetrics API operation.
287
- # @param [Hash] options
288
- #
289
- # * `:namespace` - (String) The namespace to filter against.
290
- # * `:metric_name` - (String) The name of the metric to filter against.
291
- # * `:dimensions` - (Array<Hash>) A list of dimensions to filter
292
- # against.
293
- # * `:name` - *required* - (String) The dimension name to be matched.
294
- # * `:value` - (String) The value of the dimension to be matched.
295
- # Specifying a Name without specifying a Value returns all values
296
- # associated with that Name.
297
- # * `:next_token` - (String) The token returned by a previous call to
298
- # indicate that there is more data available.
299
- # @return [Core::Response]
300
- # The #data method of the response object returns
301
- # a hash with the following structure:
302
- #
303
- # * `:metrics` - (Array<Hash>)
304
- # * `:namespace` - (String)
305
- # * `:metric_name` - (String)
306
- # * `:dimensions` - (Array<Hash>)
307
- # * `:name` - (String)
308
- # * `:value` - (String)
309
- # * `:next_token` - (String)
310
-
311
- # @!method put_metric_alarm(options = {})
312
- # Calls the PutMetricAlarm API operation.
313
- # @param [Hash] options
314
- #
315
- # * `:alarm_name` - *required* - (String) The descriptive name for the
316
- # alarm. This name must be unique within the user's AWS account
317
- # * `:alarm_description` - (String) The description for the alarm.
318
- # * `:actions_enabled` - (Boolean) Indicates whether or not actions
319
- # should be executed during any changes to the alarm's state.
320
- # * `:ok_actions` - (Array<String>) The list of actions to execute when
321
- # this alarm transitions into an OK state from any other state. Each
322
- # action is specified as an Amazon Resource Number (ARN). Currently
323
- # the only action supported is publishing to an Amazon SNS topic or
324
- # an Amazon Auto Scaling policy.
325
- # * `:alarm_actions` - (Array<String>) The list of actions to execute
326
- # when this alarm transitions into an ALARM state from any other
327
- # state. Each action is specified as an Amazon Resource Number (ARN).
328
- # Currently the only action supported is publishing to an Amazon SNS
329
- # topic or an Amazon Auto Scaling policy.
330
- # * `:insufficient_data_actions` - (Array<String>) The list of actions
331
- # to execute when this alarm transitions into an INSUFFICIENT_DATA
332
- # state from any other state. Each action is specified as an Amazon
333
- # Resource Number (ARN). Currently the only action supported is
334
- # publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.
335
- # * `:metric_name` - *required* - (String) The name for the alarm's
336
- # associated metric.
337
- # * `:namespace` - *required* - (String) The namespace for the alarm's
338
- # associated metric.
339
- # * `:statistic` - *required* - (String) The statistic to apply to the
340
- # alarm's associated metric. Valid values include:
341
- # * `SampleCount`
342
- # * `Average`
343
- # * `Sum`
344
- # * `Minimum`
345
- # * `Maximum`
346
- # * `:dimensions` - (Array<Hash>) The dimensions for the alarm's
347
- # associated metric.
348
- # * `:name` - *required* - (String) The name of the dimension.
349
- # * `:value` - *required* - (String) The value representing the
350
- # dimension measurement
351
- # * `:period` - *required* - (Integer) The period in seconds over which
352
- # the specified statistic is applied.
353
- # * `:unit` - (String) The unit for the alarm's associated metric.
354
- # Valid values include:
355
- # * `Seconds`
356
- # * `Microseconds`
357
- # * `Milliseconds`
358
- # * `Bytes`
359
- # * `Kilobytes`
360
- # * `Megabytes`
361
- # * `Gigabytes`
362
- # * `Terabytes`
363
- # * `Bits`
364
- # * `Kilobits`
365
- # * `Megabits`
366
- # * `Gigabits`
367
- # * `Terabits`
368
- # * `Percent`
369
- # * `Count`
370
- # * `Bytes/Second`
371
- # * `Kilobytes/Second`
372
- # * `Megabytes/Second`
373
- # * `Gigabytes/Second`
374
- # * `Terabytes/Second`
375
- # * `Bits/Second`
376
- # * `Kilobits/Second`
377
- # * `Megabits/Second`
378
- # * `Gigabits/Second`
379
- # * `Terabits/Second`
380
- # * `Count/Second`
381
- # * `None`
382
- # * `:evaluation_periods` - *required* - (Integer) The number of
383
- # periods over which data is compared to the specified threshold.
384
- # * `:threshold` - *required* - (Float) The value against which the
385
- # specified statistic is compared.
386
- # * `:comparison_operator` - *required* - (String) The arithmetic
387
- # operation to use when comparing the specified Statistic and
388
- # Threshold. The specified Statistic value is used as the first
389
- # operand. Valid values include:
390
- # * `GreaterThanOrEqualToThreshold`
391
- # * `GreaterThanThreshold`
392
- # * `LessThanThreshold`
393
- # * `LessThanOrEqualToThreshold`
394
- # @return [Core::Response]
395
-
396
- # @!method put_metric_data(options = {})
397
- # Calls the PutMetricData API operation.
398
- # @param [Hash] options
399
- #
400
- # * `:namespace` - *required* - (String) The namespace for the metric
401
- # data.
402
- # * `:metric_data` - *required* - (Array<Hash>) A list of data
403
- # describing the metric.
404
- # * `:metric_name` - *required* - (String) The name of the metric.
405
- # * `:dimensions` - (Array<Hash>) A list of dimensions associated
406
- # with the metric.
407
- # * `:name` - *required* - (String) The name of the dimension.
408
- # * `:value` - *required* - (String) The value representing the
409
- # dimension measurement
410
- # * `:timestamp` - (String<ISO8601 datetime>) The time stamp used for
411
- # the metric. If not specified, the default value is set to the
412
- # time the metric data was received.
413
- # * `:value` - (Float) The value for the metric. Although the Value
414
- # parameter accepts numbers of type Double, Amazon CloudWatch
415
- # truncates values with very large exponents. Values with base-10
416
- # exponents greater than 126 (1 x 10^126) are truncated. Likewise,
417
- # values with base-10 exponents less than -130 (1 x 10^-130) are
418
- # also truncated.
419
- # * `:statistic_values` - (Hash) A set of statistical values
420
- # describing the metric.
421
- # * `:sample_count` - *required* - (Float) The number of samples
422
- # used for the statistic set.
423
- # * `:sum` - *required* - (Float) The sum of values for the sample
424
- # set.
425
- # * `:minimum` - *required* - (Float) The minimum value of the
426
- # sample set.
427
- # * `:maximum` - *required* - (Float) The maximum value of the
428
- # sample set.
429
- # * `:unit` - (String) The unit of the metric. Valid values include:
430
- # * `Seconds`
431
- # * `Microseconds`
432
- # * `Milliseconds`
433
- # * `Bytes`
434
- # * `Kilobytes`
435
- # * `Megabytes`
436
- # * `Gigabytes`
437
- # * `Terabytes`
438
- # * `Bits`
439
- # * `Kilobits`
440
- # * `Megabits`
441
- # * `Gigabits`
442
- # * `Terabits`
443
- # * `Percent`
444
- # * `Count`
445
- # * `Bytes/Second`
446
- # * `Kilobytes/Second`
447
- # * `Megabytes/Second`
448
- # * `Gigabytes/Second`
449
- # * `Terabytes/Second`
450
- # * `Bits/Second`
451
- # * `Kilobits/Second`
452
- # * `Megabits/Second`
453
- # * `Gigabits/Second`
454
- # * `Terabits/Second`
455
- # * `Count/Second`
456
- # * `None`
457
- # @return [Core::Response]
458
-
459
- # @!method set_alarm_state(options = {})
460
- # Calls the SetAlarmState API operation.
461
- # @param [Hash] options
462
- #
463
- # * `:alarm_name` - *required* - (String) The descriptive name for the
464
- # alarm. This name must be unique within the user's AWS account. The
465
- # maximum length is 255 characters.
466
- # * `:state_value` - *required* - (String) The value of the state.
467
- # Valid values include:
468
- # * `OK`
469
- # * `ALARM`
470
- # * `INSUFFICIENT_DATA`
471
- # * `:state_reason` - *required* - (String) The reason that this alarm
472
- # is set to this specific state (in human-readable text format)
473
- # * `:state_reason_data` - (String) The reason that this alarm is set
474
- # to this specific state (in machine-readable JSON format)
475
- # @return [Core::Response]
476
-
477
- # end client methods #
478
-
479
34
  define_client_methods('2010-08-01')
480
35
 
481
36
  end
@@ -26,402 +26,6 @@ module AWS
26
26
 
27
27
  class Client::V20121029 < Client
28
28
 
29
- # client methods #
30
-
31
- # @!method activate_pipeline(options = {})
32
- # Calls the ActivatePipeline API operation.
33
- # @param [Hash] options
34
- #
35
- # * `:pipeline_id` - *required* - (String) The identifier of the
36
- # pipeline to activate.
37
- # @return [Core::Response]
38
-
39
- # @!method create_pipeline(options = {})
40
- # Calls the CreatePipeline API operation.
41
- # @param [Hash] options
42
- #
43
- # * `:name` - *required* - (String) The name of the new pipeline. You
44
- # can use the same name for multiple pipelines associated with your
45
- # AWS account, because AWS Data Pipeline assigns each new pipeline a
46
- # unique pipeline identifier.
47
- # * `:unique_id` - *required* - (String) A unique identifier that you
48
- # specify. This identifier is not the same as the pipeline identifier
49
- # assigned by AWS Data Pipeline. You are responsible for defining the
50
- # format and ensuring the uniqueness of this identifier. You use this
51
- # parameter to ensure idempotency during repeated calls to
52
- # CreatePipeline. For example, if the first call to CreatePipeline
53
- # does not return a clear success, you can pass in the same unique
54
- # identifier and pipeline name combination on a subsequent call to
55
- # CreatePipeline. CreatePipeline ensures that if a pipeline already
56
- # exists with the same name and unique identifier, a new pipeline
57
- # will not be created. Instead, you'll receive the pipeline
58
- # identifier from the previous attempt. The uniqueness of the name
59
- # and unique identifier combination is scoped to the AWS account or
60
- # IAM user credentials.
61
- # * `:description` - (String) The description of the new pipeline.
62
- # @return [Core::Response]
63
- # The #data method of the response object returns
64
- # a hash with the following structure:
65
- #
66
- # * `:pipeline_id` - (String)
67
-
68
- # @!method delete_pipeline(options = {})
69
- # Calls the DeletePipeline API operation.
70
- # @param [Hash] options
71
- #
72
- # * `:pipeline_id` - *required* - (String) The identifier of the
73
- # pipeline to be deleted.
74
- # @return [Core::Response]
75
-
76
- # @!method describe_objects(options = {})
77
- # Calls the DescribeObjects API operation.
78
- # @param [Hash] options
79
- #
80
- # * `:pipeline_id` - *required* - (String) Identifier of the pipeline
81
- # that contains the object definitions.
82
- # * `:object_ids` - *required* - (Array<String>) Identifiers of the
83
- # pipeline objects that contain the definitions to be described. You
84
- # can pass as many as 25 identifiers in a single call to
85
- # DescribeObjects
86
- # * `:evaluate_expressions` - (Boolean)
87
- # * `:marker` - (String) The starting point for the results to be
88
- # returned. The first time you call DescribeObjects, this value
89
- # should be empty. As long as the action returns HasMoreResults as
90
- # True, you can call DescribeObjects again and pass the marker value
91
- # from the response to retrieve the next set of results.
92
- # @return [Core::Response]
93
- # The #data method of the response object returns
94
- # a hash with the following structure:
95
- #
96
- # * `:pipeline_objects` - (Array<Hash>)
97
- # * `:id` - (String)
98
- # * `:name` - (String)
99
- # * `:fields` - (Array<Hash>)
100
- # * `:key` - (String)
101
- # * `:string_value` - (String)
102
- # * `:ref_value` - (String)
103
- # * `:marker` - (String)
104
- # * `:has_more_results` - (Boolean)
105
-
106
- # @!method describe_pipelines(options = {})
107
- # Calls the DescribePipelines API operation.
108
- # @param [Hash] options
109
- #
110
- # * `:pipeline_ids` - *required* - (Array<String>) Identifiers of the
111
- # pipelines to describe. You can pass as many as 25 identifiers in a
112
- # single call to DescribePipelines. You can obtain pipeline
113
- # identifiers by calling ListPipelines.
114
- # @return [Core::Response]
115
- # The #data method of the response object returns
116
- # a hash with the following structure:
117
- #
118
- # * `:pipeline_description_list` - (Array<Hash>)
119
- # * `:pipeline_id` - (String)
120
- # * `:name` - (String)
121
- # * `:fields` - (Array<Hash>)
122
- # * `:key` - (String)
123
- # * `:string_value` - (String)
124
- # * `:ref_value` - (String)
125
- # * `:description` - (String)
126
-
127
- # @!method evaluate_expression(options = {})
128
- # Calls the EvaluateExpression API operation.
129
- # @param [Hash] options
130
- #
131
- # * `:pipeline_id` - *required* - (String) The identifier of the
132
- # pipeline.
133
- # * `:object_id` - *required* - (String) The identifier of the object.
134
- # * `:expression` - *required* - (String) The expression to evaluate.
135
- # @return [Core::Response]
136
- # The #data method of the response object returns
137
- # a hash with the following structure:
138
- #
139
- # * `:evaluated_expression` - (String)
140
-
141
- # @!method get_pipeline_definition(options = {})
142
- # Calls the GetPipelineDefinition API operation.
143
- # @param [Hash] options
144
- #
145
- # * `:pipeline_id` - *required* - (String) The identifier of the
146
- # pipeline.
147
- # * `:version` - (String) The version of the pipeline definition to
148
- # retrieve.
149
- # @return [Core::Response]
150
- # The #data method of the response object returns
151
- # a hash with the following structure:
152
- #
153
- # * `:pipeline_objects` - (Array<Hash>)
154
- # * `:id` - (String)
155
- # * `:name` - (String)
156
- # * `:fields` - (Array<Hash>)
157
- # * `:key` - (String)
158
- # * `:string_value` - (String)
159
- # * `:ref_value` - (String)
160
-
161
- # @!method list_pipelines(options = {})
162
- # Calls the ListPipelines API operation.
163
- # @param [Hash] options
164
- #
165
- # * `:marker` - (String) The starting point for the results to be
166
- # returned. The first time you call ListPipelines, this value should
167
- # be empty. As long as the action returns HasMoreResults as True, you
168
- # can call ListPipelines again and pass the marker value from the
169
- # response to retrieve the next set of results.
170
- # @return [Core::Response]
171
- # The #data method of the response object returns
172
- # a hash with the following structure:
173
- #
174
- # * `:pipeline_id_list` - (Array<Hash>)
175
- # * `:id` - (String)
176
- # * `:name` - (String)
177
- # * `:marker` - (String)
178
- # * `:has_more_results` - (Boolean)
179
-
180
- # @!method poll_for_task(options = {})
181
- # Calls the PollForTask API operation.
182
- # @param [Hash] options
183
- #
184
- # * `:worker_group` - *required* - (String) Indicates the type of task
185
- # the task runner is configured to accept and process. The worker
186
- # group is set as a field on objects in the pipeline when they are
187
- # created. You can only specify a single value for workerGroup in the
188
- # call to PollForTask. There are no wildcard values permitted in
189
- # workerGroup, the string must be an exact, case-sensitive, match.
190
- # * `:hostname` - (String) The public DNS name of the calling task
191
- # runner.
192
- # * `:instance_identity` - (Hash) Identity information for the Amazon
193
- # EC2 instance that is hosting the task runner. You can get this
194
- # value by calling the URI,
195
- # http://169.254.169.254/latest/meta-data/instance-id, from the EC2
196
- # instance. For more information, go to Instance Metadata in the
197
- # Amazon Elastic Compute Cloud User Guide. Passing in this value
198
- # proves that your task runner is running on an EC2 instance, and
199
- # ensures the proper AWS Data Pipeline service charges are applied to
200
- # your pipeline.
201
- # * `:document` - (String) A description of an Amazon EC2 instance
202
- # that is generated when the instance is launched and exposed to
203
- # the instance via the instance meta-data service in the form of a
204
- # JSON representation of an object.
205
- # * `:signature` - (String) A signature which can be used to verify
206
- # the accuracy and authenticity of the information provided in the
207
- # instance identity document.
208
- # @return [Core::Response]
209
- # The #data method of the response object returns
210
- # a hash with the following structure:
211
- #
212
- # * `:task_object` - (Hash)
213
- # * `:task_id` - (String)
214
- # * `:pipeline_id` - (String)
215
- # * `:attempt_id` - (String)
216
- # * `:objects` - (Hash<String,Hash>)
217
- # * `:id` - (String)
218
- # * `:name` - (String)
219
- # * `:fields` - (Array<Hash>)
220
- # * `:key` - (String)
221
- # * `:string_value` - (String)
222
- # * `:ref_value` - (String)
223
-
224
- # @!method put_pipeline_definition(options = {})
225
- # Calls the PutPipelineDefinition API operation.
226
- # @param [Hash] options
227
- #
228
- # * `:pipeline_id` - *required* - (String) The identifier of the
229
- # pipeline to be configured.
230
- # * `:pipeline_objects` - *required* - (Array<Hash>) The objects that
231
- # define the pipeline. These will overwrite the existing pipeline
232
- # definition.
233
- # * `:id` - *required* - (String) Identifier of the object.
234
- # * `:name` - *required* - (String) Name of the object.
235
- # * `:fields` - *required* - (Array<Hash>) Key-value pairs that
236
- # define the properties of the object.
237
- # * `:key` - *required* - (String) The field identifier.
238
- # * `:string_value` - (String) The field value, expressed as a
239
- # String.
240
- # * `:ref_value` - (String) The field value, expressed as the
241
- # identifier of another object.
242
- # @return [Core::Response]
243
- # The #data method of the response object returns
244
- # a hash with the following structure:
245
- #
246
- # * `:validation_errors` - (Array<Hash>)
247
- # * `:id` - (String)
248
- # * `:errors` - (Array<String>)
249
- # * `:errored` - (Boolean)
250
-
251
- # @!method query_objects(options = {})
252
- # Calls the QueryObjects API operation.
253
- # @param [Hash] options
254
- #
255
- # * `:pipeline_id` - *required* - (String) Identifier of the pipeline
256
- # to be queried for object names.
257
- # * `:query` - (Hash) Query that defines the objects to be returned.
258
- # The Query object can contain a maximum of ten selectors. The
259
- # conditions in the query are limited to top-level String fields in
260
- # the object. These filters can be applied to components, instances,
261
- # and attempts.
262
- # * `:selectors` - (Array<Hash>) List of selectors that define the
263
- # query. An object must satisfy all of the selectors to match the
264
- # query.
265
- # * `:field_name` - (String) The name of the field that the
266
- # operator will be applied to. The field name is the "key"
267
- # portion of the field definition in the pipeline definition
268
- # syntax that is used by the AWS Data Pipeline API. If the field
269
- # is not set on the object, the condition fails.
270
- # * `:operator` - (Hash)
271
- # * `:type` - (String) The logical operation to be performed:
272
- # equal (EQ), equal reference (REF_EQ), less than or equal
273
- # (LE), greater than or equal (GE), or between (BETWEEN). Equal
274
- # reference (REF_EQ) can be used only with reference fields.
275
- # The other comparison types can be used only with String
276
- # fields. The comparison types you can use apply only to
277
- # certain object fields, as detailed below. The comparison
278
- # operators EQ and REF_EQ act on the following fields: name
279
- # @sphere parent @componentParent @instanceParent @status
280
- # @scheduledStartTime @scheduledEndTime @actualStartTime
281
- # @actualEndTime The comparison operators GE, LE, and BETWEEN
282
- # act on the following fields: @scheduledStartTime
283
- # @scheduledEndTime @actualStartTime @actualEndTime Note that
284
- # fields beginning with the at sign (@) are read-only and set
285
- # by the web service. When you name fields, you should choose
286
- # names containing only alpha-numeric values, as symbols may be
287
- # reserved by AWS Data Pipeline. A best practice for
288
- # user-defined fields that you add to a pipeline is to prefix
289
- # their name with the string "my". Valid values include:
290
- # * `EQ`
291
- # * `REF_EQ`
292
- # * `LE`
293
- # * `GE`
294
- # * `BETWEEN`
295
- # * `:values` - (Array<String>) The value that the actual field
296
- # value will be compared with.
297
- # * `:sphere` - *required* - (String) Specifies whether the query
298
- # applies to components or instances. Allowable values: COMPONENT,
299
- # INSTANCE, ATTEMPT.
300
- # * `:marker` - (String) The starting point for the results to be
301
- # returned. The first time you call QueryObjects, this value should
302
- # be empty. As long as the action returns HasMoreResults as True, you
303
- # can call QueryObjects again and pass the marker value from the
304
- # response to retrieve the next set of results.
305
- # * `:limit` - (Integer) Specifies the maximum number of object names
306
- # that QueryObjects will return in a single call. The default value
307
- # is 100.
308
- # @return [Core::Response]
309
- # The #data method of the response object returns
310
- # a hash with the following structure:
311
- #
312
- # * `:ids` - (Array<String>)
313
- # * `:marker` - (String)
314
- # * `:has_more_results` - (Boolean)
315
-
316
- # @!method report_task_progress(options = {})
317
- # Calls the ReportTaskProgress API operation.
318
- # @param [Hash] options
319
- #
320
- # * `:task_id` - *required* - (String) Identifier of the task assigned
321
- # to the task runner. This value is provided in the TaskObject that
322
- # the service returns with the response for the PollForTask action.
323
- # @return [Core::Response]
324
- # The #data method of the response object returns
325
- # a hash with the following structure:
326
- #
327
- # * `:canceled` - (Boolean)
328
-
329
- # @!method report_task_runner_heartbeat(options = {})
330
- # Calls the ReportTaskRunnerHeartbeat API operation.
331
- # @param [Hash] options
332
- #
333
- # * `:taskrunner_id` - *required* - (String) The identifier of the task
334
- # runner. This value should be unique across your AWS account. In the
335
- # case of AWS Data Pipeline Task Runner launched on a resource
336
- # managed by AWS Data Pipeline, the web service provides a unique
337
- # identifier when it launches the application. If you have written a
338
- # custom task runner, you should assign a unique identifier for the
339
- # task runner.
340
- # * `:worker_group` - (String) Indicates the type of task the task
341
- # runner is configured to accept and process. The worker group is set
342
- # as a field on objects in the pipeline when they are created. You
343
- # can only specify a single value for workerGroup in the call to
344
- # ReportTaskRunnerHeartbeat. There are no wildcard values permitted
345
- # in workerGroup, the string must be an exact, case-sensitive, match.
346
- # * `:hostname` - (String) The public DNS name of the calling task
347
- # runner.
348
- # @return [Core::Response]
349
- # The #data method of the response object returns
350
- # a hash with the following structure:
351
- #
352
- # * `:terminate` - (Boolean)
353
-
354
- # @!method set_status(options = {})
355
- # Calls the SetStatus API operation.
356
- # @param [Hash] options
357
- #
358
- # * `:pipeline_id` - *required* - (String) Identifies the pipeline that
359
- # contains the objects.
360
- # * `:object_ids` - *required* - (Array<String>) Identifies an array of
361
- # objects. The corresponding objects can be either physical or
362
- # components, but not a mix of both types.
363
- # * `:status` - *required* - (String) Specifies the status to be set on
364
- # all the objects in objectIds. For components, this can be either
365
- # PAUSE or RESUME. For instances, this can be either CANCEL, RERUN,
366
- # or MARK_FINISHED.
367
- # @return [Core::Response]
368
-
369
- # @!method set_task_status(options = {})
370
- # Calls the SetTaskStatus API operation.
371
- # @param [Hash] options
372
- #
373
- # * `:task_id` - *required* - (String) Identifies the task assigned to
374
- # the task runner. This value is set in the TaskObject that is
375
- # returned by the PollForTask action.
376
- # * `:task_status` - *required* - (String) If FINISHED, the task
377
- # successfully completed. If FAILED the task ended unsuccessfully.
378
- # The FALSE value is used by preconditions. Valid values include:
379
- # * `FINISHED`
380
- # * `FAILED`
381
- # * `FALSE`
382
- # * `:error_code` - (Integer) If an error occurred during the task,
383
- # specifies a numerical value that represents the error. This value
384
- # is set on the physical attempt object. It is used to display error
385
- # information to the user. The web service does not parse this value.
386
- # * `:error_message` - (String) If an error occurred during the task,
387
- # specifies a text description of the error. This value is set on the
388
- # physical attempt object. It is used to display error information to
389
- # the user. The web service does not parse this value.
390
- # * `:error_stack_trace` - (String) If an error occurred during the
391
- # task, specifies the stack trace associated with the error. This
392
- # value is set on the physical attempt object. It is used to display
393
- # error information to the user. The web service does not parse this
394
- # value.
395
- # @return [Core::Response]
396
-
397
- # @!method validate_pipeline_definition(options = {})
398
- # Calls the ValidatePipelineDefinition API operation.
399
- # @param [Hash] options
400
- #
401
- # * `:pipeline_id` - *required* - (String) Identifies the pipeline
402
- # whose definition is to be validated.
403
- # * `:pipeline_objects` - *required* - (Array<Hash>) A list of objects
404
- # that define the pipeline changes to validate against the pipeline.
405
- # * `:id` - *required* - (String) Identifier of the object.
406
- # * `:name` - *required* - (String) Name of the object.
407
- # * `:fields` - *required* - (Array<Hash>) Key-value pairs that
408
- # define the properties of the object.
409
- # * `:key` - *required* - (String) The field identifier.
410
- # * `:string_value` - (String) The field value, expressed as a
411
- # String.
412
- # * `:ref_value` - (String) The field value, expressed as the
413
- # identifier of another object.
414
- # @return [Core::Response]
415
- # The #data method of the response object returns
416
- # a hash with the following structure:
417
- #
418
- # * `:validation_errors` - (Array<Hash>)
419
- # * `:id` - (String)
420
- # * `:errors` - (Array<String>)
421
- # * `:errored` - (Boolean)
422
-
423
- # end client methods #
424
-
425
29
  define_client_methods('2012-10-29')
426
30
 
427
31
  end