aws-sdk-v1 1.52.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (560) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +7 -0
  3. data/LICENSE.txt +12 -0
  4. data/README.md +337 -0
  5. data/bin/aws-rb +179 -0
  6. data/ca-bundle.crt +3554 -0
  7. data/endpoints.json +1671 -0
  8. data/lib/aws-sdk-v1.rb +2 -0
  9. data/lib/aws-sdk.rb +1 -0
  10. data/lib/aws.rb +14 -0
  11. data/lib/aws/api_config/AutoScaling-2011-01-01.yml +1070 -0
  12. data/lib/aws/api_config/CloudFormation-2010-05-15.yml +372 -0
  13. data/lib/aws/api_config/CloudFront-2013-05-12.yml +2448 -0
  14. data/lib/aws/api_config/CloudFront-2013-08-26.yml +2599 -0
  15. data/lib/aws/api_config/CloudFront-2013-09-27.yml +2765 -0
  16. data/lib/aws/api_config/CloudFront-2013-11-11.yml +2886 -0
  17. data/lib/aws/api_config/CloudFront-2013-11-22.yml +2918 -0
  18. data/lib/aws/api_config/CloudFront-2014-01-31.yml +2934 -0
  19. data/lib/aws/api_config/CloudFront-2014-05-31.yml +3100 -0
  20. data/lib/aws/api_config/CloudSearch-2011-02-01.yml +681 -0
  21. data/lib/aws/api_config/CloudSearch-2013-01-01.yml +1164 -0
  22. data/lib/aws/api_config/CloudTrail-2013-11-01.yml +130 -0
  23. data/lib/aws/api_config/CloudWatch-2010-08-01.yml +433 -0
  24. data/lib/aws/api_config/DataPipeline-2012-10-29.yml +422 -0
  25. data/lib/aws/api_config/DirectConnect-2012-10-25.yml +735 -0
  26. data/lib/aws/api_config/DynamoDB-2011-12-05.yml +1168 -0
  27. data/lib/aws/api_config/DynamoDB-2012-08-10.yml +2105 -0
  28. data/lib/aws/api_config/EC2-2013-08-15.yml +4708 -0
  29. data/lib/aws/api_config/EC2-2013-10-01.yml +4726 -0
  30. data/lib/aws/api_config/EC2-2013-10-15.yml +4651 -0
  31. data/lib/aws/api_config/EC2-2014-02-01.yml +4755 -0
  32. data/lib/aws/api_config/EC2-2014-05-01.yml +4812 -0
  33. data/lib/aws/api_config/ELB-2012-06-01.yml +766 -0
  34. data/lib/aws/api_config/EMR-2009-03-31.yml +972 -0
  35. data/lib/aws/api_config/ElastiCache-2013-06-15.yml +1188 -0
  36. data/lib/aws/api_config/ElastiCache-2014-03-24.yml +1375 -0
  37. data/lib/aws/api_config/ElastiCache-2014-07-15.yml +1385 -0
  38. data/lib/aws/api_config/ElasticBeanstalk-2010-12-01.yml +854 -0
  39. data/lib/aws/api_config/ElasticTranscoder-2012-09-25.yml +3082 -0
  40. data/lib/aws/api_config/Glacier-2012-06-01.yml +649 -0
  41. data/lib/aws/api_config/IAM-2010-05-08.yml +1339 -0
  42. data/lib/aws/api_config/ImportExport-2010-06-01.yml +109 -0
  43. data/lib/aws/api_config/Kinesis-2013-12-02.yml +201 -0
  44. data/lib/aws/api_config/OpsWorks-2013-02-18.yml +2025 -0
  45. data/lib/aws/api_config/RDS-2013-05-15.yml +2464 -0
  46. data/lib/aws/api_config/RDS-2013-09-09.yml +2640 -0
  47. data/lib/aws/api_config/Redshift-2012-12-01.yml +2161 -0
  48. data/lib/aws/api_config/Route53-2012-12-12.yml +547 -0
  49. data/lib/aws/api_config/Route53-2013-04-01.yml +889 -0
  50. data/lib/aws/api_config/SNS-2010-03-31.yml +448 -0
  51. data/lib/aws/api_config/SQS-2012-11-05.yml +404 -0
  52. data/lib/aws/api_config/STS-2011-06-15.yml +151 -0
  53. data/lib/aws/api_config/SimpleDB-2009-04-15.yml +306 -0
  54. data/lib/aws/api_config/SimpleEmailService-2010-12-01.yml +346 -0
  55. data/lib/aws/api_config/SimpleWorkflow-2012-01-25.yml +2388 -0
  56. data/lib/aws/api_config/StorageGateway-2012-06-30.yml +748 -0
  57. data/lib/aws/api_config/StorageGateway-2013-06-30.yml +1025 -0
  58. data/lib/aws/api_config/Support-2013-04-15.yml +489 -0
  59. data/lib/aws/auto_scaling.rb +163 -0
  60. data/lib/aws/auto_scaling/activity.rb +102 -0
  61. data/lib/aws/auto_scaling/activity_collection.rb +81 -0
  62. data/lib/aws/auto_scaling/client.rb +48 -0
  63. data/lib/aws/auto_scaling/config.rb +18 -0
  64. data/lib/aws/auto_scaling/errors.rb +22 -0
  65. data/lib/aws/auto_scaling/group.rb +421 -0
  66. data/lib/aws/auto_scaling/group_collection.rb +96 -0
  67. data/lib/aws/auto_scaling/group_options.rb +155 -0
  68. data/lib/aws/auto_scaling/instance.rb +192 -0
  69. data/lib/aws/auto_scaling/instance_collection.rb +63 -0
  70. data/lib/aws/auto_scaling/launch_configuration.rb +162 -0
  71. data/lib/aws/auto_scaling/launch_configuration_collection.rb +160 -0
  72. data/lib/aws/auto_scaling/notification_configuration.rb +89 -0
  73. data/lib/aws/auto_scaling/notification_configuration_collection.rb +183 -0
  74. data/lib/aws/auto_scaling/scaling_policy.rb +142 -0
  75. data/lib/aws/auto_scaling/scaling_policy_collection.rb +72 -0
  76. data/lib/aws/auto_scaling/scaling_policy_options.rb +65 -0
  77. data/lib/aws/auto_scaling/scheduled_action.rb +141 -0
  78. data/lib/aws/auto_scaling/scheduled_action_collection.rb +202 -0
  79. data/lib/aws/auto_scaling/tag.rb +59 -0
  80. data/lib/aws/auto_scaling/tag_collection.rb +114 -0
  81. data/lib/aws/cloud_formation.rb +272 -0
  82. data/lib/aws/cloud_formation/client.rb +48 -0
  83. data/lib/aws/cloud_formation/config.rb +18 -0
  84. data/lib/aws/cloud_formation/errors.rb +22 -0
  85. data/lib/aws/cloud_formation/stack.rb +266 -0
  86. data/lib/aws/cloud_formation/stack_collection.rb +232 -0
  87. data/lib/aws/cloud_formation/stack_event.rb +73 -0
  88. data/lib/aws/cloud_formation/stack_event_collection.rb +47 -0
  89. data/lib/aws/cloud_formation/stack_options.rb +72 -0
  90. data/lib/aws/cloud_formation/stack_output.rb +53 -0
  91. data/lib/aws/cloud_formation/stack_resource.rb +117 -0
  92. data/lib/aws/cloud_formation/stack_resource_collection.rb +83 -0
  93. data/lib/aws/cloud_formation/stack_resource_summary_collection.rb +64 -0
  94. data/lib/aws/cloud_formation/stack_summary_collection.rb +123 -0
  95. data/lib/aws/cloud_front.rb +72 -0
  96. data/lib/aws/cloud_front/client.rb +57 -0
  97. data/lib/aws/cloud_front/config.rb +18 -0
  98. data/lib/aws/cloud_front/errors.rb +22 -0
  99. data/lib/aws/cloud_search.rb +73 -0
  100. data/lib/aws/cloud_search/client.rb +40 -0
  101. data/lib/aws/cloud_search/config.rb +18 -0
  102. data/lib/aws/cloud_search/errors.rb +22 -0
  103. data/lib/aws/cloud_trail.rb +72 -0
  104. data/lib/aws/cloud_trail/client.rb +35 -0
  105. data/lib/aws/cloud_trail/config.rb +18 -0
  106. data/lib/aws/cloud_trail/errors.rb +22 -0
  107. data/lib/aws/cloud_watch.rb +118 -0
  108. data/lib/aws/cloud_watch/alarm.rb +293 -0
  109. data/lib/aws/cloud_watch/alarm_collection.rb +153 -0
  110. data/lib/aws/cloud_watch/alarm_history_item.rb +50 -0
  111. data/lib/aws/cloud_watch/alarm_history_item_collection.rb +84 -0
  112. data/lib/aws/cloud_watch/client.rb +40 -0
  113. data/lib/aws/cloud_watch/config.rb +18 -0
  114. data/lib/aws/cloud_watch/errors.rb +22 -0
  115. data/lib/aws/cloud_watch/metric.rb +135 -0
  116. data/lib/aws/cloud_watch/metric_alarm_collection.rb +160 -0
  117. data/lib/aws/cloud_watch/metric_collection.rb +129 -0
  118. data/lib/aws/cloud_watch/metric_statistics.rb +69 -0
  119. data/lib/aws/core.rb +716 -0
  120. data/lib/aws/core/async_handle.rb +90 -0
  121. data/lib/aws/core/cacheable.rb +77 -0
  122. data/lib/aws/core/client.rb +787 -0
  123. data/lib/aws/core/collection.rb +263 -0
  124. data/lib/aws/core/collection/simple.rb +82 -0
  125. data/lib/aws/core/collection/with_limit_and_next_token.rb +71 -0
  126. data/lib/aws/core/collection/with_next_token.rb +97 -0
  127. data/lib/aws/core/configuration.rb +542 -0
  128. data/lib/aws/core/credential_providers.rb +639 -0
  129. data/lib/aws/core/data.rb +247 -0
  130. data/lib/aws/core/deprecations.rb +84 -0
  131. data/lib/aws/core/endpoints.rb +37 -0
  132. data/lib/aws/core/http/connection_pool.rb +369 -0
  133. data/lib/aws/core/http/curb_handler.rb +148 -0
  134. data/lib/aws/core/http/handler.rb +89 -0
  135. data/lib/aws/core/http/net_http_handler.rb +144 -0
  136. data/lib/aws/core/http/patch.rb +102 -0
  137. data/lib/aws/core/http/request.rb +259 -0
  138. data/lib/aws/core/http/response.rb +81 -0
  139. data/lib/aws/core/indifferent_hash.rb +88 -0
  140. data/lib/aws/core/inflection.rb +56 -0
  141. data/lib/aws/core/ini_parser.rb +42 -0
  142. data/lib/aws/core/json_client.rb +47 -0
  143. data/lib/aws/core/json_parser.rb +76 -0
  144. data/lib/aws/core/json_request_builder.rb +35 -0
  145. data/lib/aws/core/json_response_parser.rb +79 -0
  146. data/lib/aws/core/lazy_error_classes.rb +108 -0
  147. data/lib/aws/core/log_formatter.rb +428 -0
  148. data/lib/aws/core/managed_file.rb +32 -0
  149. data/lib/aws/core/meta_utils.rb +45 -0
  150. data/lib/aws/core/model.rb +62 -0
  151. data/lib/aws/core/naming.rb +30 -0
  152. data/lib/aws/core/option_grammar.rb +738 -0
  153. data/lib/aws/core/options/json_serializer.rb +82 -0
  154. data/lib/aws/core/options/validator.rb +155 -0
  155. data/lib/aws/core/options/xml_serializer.rb +118 -0
  156. data/lib/aws/core/page_result.rb +75 -0
  157. data/lib/aws/core/policy.rb +941 -0
  158. data/lib/aws/core/query_client.rb +41 -0
  159. data/lib/aws/core/query_error_parser.rb +24 -0
  160. data/lib/aws/core/query_request_builder.rb +47 -0
  161. data/lib/aws/core/query_response_parser.rb +35 -0
  162. data/lib/aws/core/region.rb +85 -0
  163. data/lib/aws/core/region_collection.rb +80 -0
  164. data/lib/aws/core/resource.rb +413 -0
  165. data/lib/aws/core/resource_cache.rb +40 -0
  166. data/lib/aws/core/response.rb +215 -0
  167. data/lib/aws/core/response_cache.rb +50 -0
  168. data/lib/aws/core/rest_error_parser.rb +24 -0
  169. data/lib/aws/core/rest_json_client.rb +40 -0
  170. data/lib/aws/core/rest_request_builder.rb +154 -0
  171. data/lib/aws/core/rest_response_parser.rb +66 -0
  172. data/lib/aws/core/rest_xml_client.rb +47 -0
  173. data/lib/aws/core/service_interface.rb +83 -0
  174. data/lib/aws/core/signers/base.rb +46 -0
  175. data/lib/aws/core/signers/cloud_front.rb +56 -0
  176. data/lib/aws/core/signers/s3.rb +159 -0
  177. data/lib/aws/core/signers/version_2.rb +72 -0
  178. data/lib/aws/core/signers/version_3.rb +86 -0
  179. data/lib/aws/core/signers/version_3_https.rb +61 -0
  180. data/lib/aws/core/signers/version_4.rb +228 -0
  181. data/lib/aws/core/signers/version_4/chunk_signed_stream.rb +191 -0
  182. data/lib/aws/core/uri_escape.rb +44 -0
  183. data/lib/aws/core/xml/frame.rb +245 -0
  184. data/lib/aws/core/xml/frame_stack.rb +85 -0
  185. data/lib/aws/core/xml/grammar.rb +307 -0
  186. data/lib/aws/core/xml/parser.rb +70 -0
  187. data/lib/aws/core/xml/root_frame.rb +65 -0
  188. data/lib/aws/core/xml/sax_handlers/libxml.rb +47 -0
  189. data/lib/aws/core/xml/sax_handlers/nokogiri.rb +56 -0
  190. data/lib/aws/core/xml/sax_handlers/ox.rb +41 -0
  191. data/lib/aws/core/xml/sax_handlers/rexml.rb +47 -0
  192. data/lib/aws/core/xml/stub.rb +123 -0
  193. data/lib/aws/data_pipeline.rb +72 -0
  194. data/lib/aws/data_pipeline/client.rb +36 -0
  195. data/lib/aws/data_pipeline/config.rb +18 -0
  196. data/lib/aws/data_pipeline/errors.rb +20 -0
  197. data/lib/aws/direct_connect.rb +73 -0
  198. data/lib/aws/direct_connect/client.rb +36 -0
  199. data/lib/aws/direct_connect/config.rb +18 -0
  200. data/lib/aws/direct_connect/errors.rb +22 -0
  201. data/lib/aws/dynamo_db.rb +230 -0
  202. data/lib/aws/dynamo_db/attribute_collection.rb +456 -0
  203. data/lib/aws/dynamo_db/batch_get.rb +213 -0
  204. data/lib/aws/dynamo_db/batch_write.rb +254 -0
  205. data/lib/aws/dynamo_db/binary.rb +35 -0
  206. data/lib/aws/dynamo_db/client.rb +129 -0
  207. data/lib/aws/dynamo_db/client/v20111205.rb +1266 -0
  208. data/lib/aws/dynamo_db/client/v20120810.rb +1409 -0
  209. data/lib/aws/dynamo_db/client_v2.rb +44 -0
  210. data/lib/aws/dynamo_db/config.rb +24 -0
  211. data/lib/aws/dynamo_db/errors.rb +20 -0
  212. data/lib/aws/dynamo_db/expectations.rb +40 -0
  213. data/lib/aws/dynamo_db/item.rb +133 -0
  214. data/lib/aws/dynamo_db/item_collection.rb +856 -0
  215. data/lib/aws/dynamo_db/item_data.rb +31 -0
  216. data/lib/aws/dynamo_db/keys.rb +41 -0
  217. data/lib/aws/dynamo_db/primary_key_element.rb +48 -0
  218. data/lib/aws/dynamo_db/resource.rb +33 -0
  219. data/lib/aws/dynamo_db/table.rb +492 -0
  220. data/lib/aws/dynamo_db/table_collection.rb +165 -0
  221. data/lib/aws/dynamo_db/types.rb +111 -0
  222. data/lib/aws/ec2.rb +428 -0
  223. data/lib/aws/ec2/attachment.rb +135 -0
  224. data/lib/aws/ec2/attachment_collection.rb +54 -0
  225. data/lib/aws/ec2/availability_zone.rb +86 -0
  226. data/lib/aws/ec2/availability_zone_collection.rb +43 -0
  227. data/lib/aws/ec2/block_device_mappings.rb +53 -0
  228. data/lib/aws/ec2/client.rb +154 -0
  229. data/lib/aws/ec2/collection.rb +36 -0
  230. data/lib/aws/ec2/config.rb +21 -0
  231. data/lib/aws/ec2/customer_gateway.rb +90 -0
  232. data/lib/aws/ec2/customer_gateway_collection.rb +73 -0
  233. data/lib/aws/ec2/dhcp_options.rb +106 -0
  234. data/lib/aws/ec2/dhcp_options_collection.rb +87 -0
  235. data/lib/aws/ec2/elastic_ip.rb +209 -0
  236. data/lib/aws/ec2/elastic_ip_collection.rb +93 -0
  237. data/lib/aws/ec2/errors.rb +32 -0
  238. data/lib/aws/ec2/export_task.rb +120 -0
  239. data/lib/aws/ec2/export_task_collection.rb +67 -0
  240. data/lib/aws/ec2/filtered_collection.rb +87 -0
  241. data/lib/aws/ec2/has_permissions.rb +44 -0
  242. data/lib/aws/ec2/image.rb +270 -0
  243. data/lib/aws/ec2/image_collection.rb +219 -0
  244. data/lib/aws/ec2/instance.rb +803 -0
  245. data/lib/aws/ec2/instance_collection.rb +402 -0
  246. data/lib/aws/ec2/internet_gateway.rb +122 -0
  247. data/lib/aws/ec2/internet_gateway/attachment.rb +78 -0
  248. data/lib/aws/ec2/internet_gateway_collection.rb +54 -0
  249. data/lib/aws/ec2/key_pair.rb +82 -0
  250. data/lib/aws/ec2/key_pair_collection.rb +99 -0
  251. data/lib/aws/ec2/network_acl.rb +256 -0
  252. data/lib/aws/ec2/network_acl/association.rb +56 -0
  253. data/lib/aws/ec2/network_acl/entry.rb +147 -0
  254. data/lib/aws/ec2/network_acl_collection.rb +64 -0
  255. data/lib/aws/ec2/network_interface.rb +237 -0
  256. data/lib/aws/ec2/network_interface/attachment.rb +100 -0
  257. data/lib/aws/ec2/network_interface_collection.rb +103 -0
  258. data/lib/aws/ec2/permission_collection.rb +174 -0
  259. data/lib/aws/ec2/region.rb +106 -0
  260. data/lib/aws/ec2/region_collection.rb +51 -0
  261. data/lib/aws/ec2/reserved_instances.rb +57 -0
  262. data/lib/aws/ec2/reserved_instances_collection.rb +40 -0
  263. data/lib/aws/ec2/reserved_instances_offering.rb +60 -0
  264. data/lib/aws/ec2/reserved_instances_offering_collection.rb +45 -0
  265. data/lib/aws/ec2/resource.rb +161 -0
  266. data/lib/aws/ec2/resource_tag_collection.rb +211 -0
  267. data/lib/aws/ec2/route_table.rb +205 -0
  268. data/lib/aws/ec2/route_table/association.rb +119 -0
  269. data/lib/aws/ec2/route_table/route.rb +119 -0
  270. data/lib/aws/ec2/route_table_collection.rb +72 -0
  271. data/lib/aws/ec2/security_group.rb +482 -0
  272. data/lib/aws/ec2/security_group/ip_permission.rb +135 -0
  273. data/lib/aws/ec2/security_group/ip_permission_collection.rb +82 -0
  274. data/lib/aws/ec2/security_group_collection.rb +133 -0
  275. data/lib/aws/ec2/snapshot.rb +143 -0
  276. data/lib/aws/ec2/snapshot_collection.rb +131 -0
  277. data/lib/aws/ec2/subnet.rb +161 -0
  278. data/lib/aws/ec2/subnet_collection.rb +119 -0
  279. data/lib/aws/ec2/tag.rb +81 -0
  280. data/lib/aws/ec2/tag_collection.rb +107 -0
  281. data/lib/aws/ec2/tagged_collection.rb +67 -0
  282. data/lib/aws/ec2/tagged_item.rb +85 -0
  283. data/lib/aws/ec2/volume.rb +185 -0
  284. data/lib/aws/ec2/volume_collection.rb +102 -0
  285. data/lib/aws/ec2/vpc.rb +174 -0
  286. data/lib/aws/ec2/vpc_collection.rb +70 -0
  287. data/lib/aws/ec2/vpn_connection.rb +99 -0
  288. data/lib/aws/ec2/vpn_connection/telemetry.rb +49 -0
  289. data/lib/aws/ec2/vpn_connection_collection.rb +96 -0
  290. data/lib/aws/ec2/vpn_gateway.rb +123 -0
  291. data/lib/aws/ec2/vpn_gateway/attachment.rb +45 -0
  292. data/lib/aws/ec2/vpn_gateway_collection.rb +77 -0
  293. data/lib/aws/elastic_beanstalk.rb +49 -0
  294. data/lib/aws/elastic_beanstalk/client.rb +36 -0
  295. data/lib/aws/elastic_beanstalk/config.rb +18 -0
  296. data/lib/aws/elastic_beanstalk/errors.rb +22 -0
  297. data/lib/aws/elastic_transcoder.rb +29 -0
  298. data/lib/aws/elastic_transcoder/client.rb +48 -0
  299. data/lib/aws/elastic_transcoder/config.rb +18 -0
  300. data/lib/aws/elastic_transcoder/errors.rb +23 -0
  301. data/lib/aws/elasticache.rb +49 -0
  302. data/lib/aws/elasticache/client.rb +41 -0
  303. data/lib/aws/elasticache/config.rb +18 -0
  304. data/lib/aws/elasticache/errors.rb +22 -0
  305. data/lib/aws/elb.rb +66 -0
  306. data/lib/aws/elb/availability_zone_collection.rb +138 -0
  307. data/lib/aws/elb/backend_server_policy_collection.rb +139 -0
  308. data/lib/aws/elb/client.rb +35 -0
  309. data/lib/aws/elb/config.rb +18 -0
  310. data/lib/aws/elb/errors.rb +26 -0
  311. data/lib/aws/elb/instance_collection.rb +168 -0
  312. data/lib/aws/elb/listener.rb +190 -0
  313. data/lib/aws/elb/listener_collection.rb +113 -0
  314. data/lib/aws/elb/listener_opts.rb +45 -0
  315. data/lib/aws/elb/load_balancer.rb +280 -0
  316. data/lib/aws/elb/load_balancer_collection.rb +146 -0
  317. data/lib/aws/elb/load_balancer_policy.rb +93 -0
  318. data/lib/aws/elb/load_balancer_policy_collection.rb +208 -0
  319. data/lib/aws/emr.rb +87 -0
  320. data/lib/aws/emr/client.rb +35 -0
  321. data/lib/aws/emr/config.rb +18 -0
  322. data/lib/aws/emr/errors.rb +22 -0
  323. data/lib/aws/emr/instance_group.rb +138 -0
  324. data/lib/aws/emr/instance_group_collection.rb +82 -0
  325. data/lib/aws/emr/job_flow.rb +307 -0
  326. data/lib/aws/emr/job_flow_collection.rb +183 -0
  327. data/lib/aws/errors.rb +162 -0
  328. data/lib/aws/glacier.rb +79 -0
  329. data/lib/aws/glacier/archive.rb +56 -0
  330. data/lib/aws/glacier/archive_collection.rb +146 -0
  331. data/lib/aws/glacier/client.rb +49 -0
  332. data/lib/aws/glacier/config.rb +19 -0
  333. data/lib/aws/glacier/errors.rb +22 -0
  334. data/lib/aws/glacier/resource.rb +30 -0
  335. data/lib/aws/glacier/vault.rb +145 -0
  336. data/lib/aws/glacier/vault_collection.rb +75 -0
  337. data/lib/aws/glacier/vault_notification_configuration.rb +29 -0
  338. data/lib/aws/iam.rb +408 -0
  339. data/lib/aws/iam/access_key.rb +185 -0
  340. data/lib/aws/iam/access_key_collection.rb +128 -0
  341. data/lib/aws/iam/account_alias_collection.rb +79 -0
  342. data/lib/aws/iam/client.rb +49 -0
  343. data/lib/aws/iam/collection.rb +83 -0
  344. data/lib/aws/iam/config.rb +18 -0
  345. data/lib/aws/iam/errors.rb +22 -0
  346. data/lib/aws/iam/group.rb +111 -0
  347. data/lib/aws/iam/group_collection.rb +132 -0
  348. data/lib/aws/iam/group_policy_collection.rb +47 -0
  349. data/lib/aws/iam/group_user_collection.rb +84 -0
  350. data/lib/aws/iam/login_profile.rb +111 -0
  351. data/lib/aws/iam/mfa_device.rb +52 -0
  352. data/lib/aws/iam/mfa_device_collection.rb +127 -0
  353. data/lib/aws/iam/policy.rb +46 -0
  354. data/lib/aws/iam/policy_collection.rb +188 -0
  355. data/lib/aws/iam/resource.rb +62 -0
  356. data/lib/aws/iam/server_certificate.rb +148 -0
  357. data/lib/aws/iam/server_certificate_collection.rb +138 -0
  358. data/lib/aws/iam/signing_certificate.rb +186 -0
  359. data/lib/aws/iam/signing_certificate_collection.rb +131 -0
  360. data/lib/aws/iam/user.rb +200 -0
  361. data/lib/aws/iam/user_collection.rb +133 -0
  362. data/lib/aws/iam/user_group_collection.rb +98 -0
  363. data/lib/aws/iam/user_policy.rb +90 -0
  364. data/lib/aws/iam/user_policy_collection.rb +45 -0
  365. data/lib/aws/iam/virtual_mfa_device.rb +139 -0
  366. data/lib/aws/iam/virtual_mfa_device_collection.rb +73 -0
  367. data/lib/aws/import_export.rb +73 -0
  368. data/lib/aws/import_export/client.rb +35 -0
  369. data/lib/aws/import_export/config.rb +19 -0
  370. data/lib/aws/import_export/errors.rb +22 -0
  371. data/lib/aws/kinesis.rb +53 -0
  372. data/lib/aws/kinesis/client.rb +35 -0
  373. data/lib/aws/kinesis/config.rb +18 -0
  374. data/lib/aws/kinesis/errors.rb +20 -0
  375. data/lib/aws/ops_works.rb +29 -0
  376. data/lib/aws/ops_works/client.rb +35 -0
  377. data/lib/aws/ops_works/config.rb +18 -0
  378. data/lib/aws/ops_works/errors.rb +20 -0
  379. data/lib/aws/rails.rb +195 -0
  380. data/lib/aws/rds.rb +70 -0
  381. data/lib/aws/rds/client.rb +42 -0
  382. data/lib/aws/rds/config.rb +18 -0
  383. data/lib/aws/rds/db_instance.rb +215 -0
  384. data/lib/aws/rds/db_instance_collection.rb +75 -0
  385. data/lib/aws/rds/db_snapshot.rb +163 -0
  386. data/lib/aws/rds/db_snapshot_collection.rb +89 -0
  387. data/lib/aws/rds/errors.rb +22 -0
  388. data/lib/aws/record.rb +139 -0
  389. data/lib/aws/record/abstract_base.rb +689 -0
  390. data/lib/aws/record/attributes.rb +388 -0
  391. data/lib/aws/record/conversion.rb +38 -0
  392. data/lib/aws/record/dirty_tracking.rb +287 -0
  393. data/lib/aws/record/errors.rb +143 -0
  394. data/lib/aws/record/exceptions.rb +51 -0
  395. data/lib/aws/record/hash_model.rb +204 -0
  396. data/lib/aws/record/hash_model/attributes.rb +195 -0
  397. data/lib/aws/record/hash_model/finder_methods.rb +172 -0
  398. data/lib/aws/record/hash_model/scope.rb +108 -0
  399. data/lib/aws/record/model.rb +453 -0
  400. data/lib/aws/record/model/attributes.rb +377 -0
  401. data/lib/aws/record/model/finder_methods.rb +232 -0
  402. data/lib/aws/record/model/scope.rb +212 -0
  403. data/lib/aws/record/naming.rb +31 -0
  404. data/lib/aws/record/scope.rb +203 -0
  405. data/lib/aws/record/validations.rb +694 -0
  406. data/lib/aws/record/validator.rb +246 -0
  407. data/lib/aws/record/validators/acceptance.rb +49 -0
  408. data/lib/aws/record/validators/block.rb +36 -0
  409. data/lib/aws/record/validators/confirmation.rb +41 -0
  410. data/lib/aws/record/validators/count.rb +106 -0
  411. data/lib/aws/record/validators/exclusion.rb +41 -0
  412. data/lib/aws/record/validators/format.rb +55 -0
  413. data/lib/aws/record/validators/inclusion.rb +54 -0
  414. data/lib/aws/record/validators/length.rb +105 -0
  415. data/lib/aws/record/validators/method.rb +31 -0
  416. data/lib/aws/record/validators/numericality.rb +136 -0
  417. data/lib/aws/record/validators/presence.rb +43 -0
  418. data/lib/aws/redshift.rb +51 -0
  419. data/lib/aws/redshift/client.rb +35 -0
  420. data/lib/aws/redshift/config.rb +18 -0
  421. data/lib/aws/redshift/errors.rb +22 -0
  422. data/lib/aws/route_53.rb +86 -0
  423. data/lib/aws/route_53/change_batch.rb +161 -0
  424. data/lib/aws/route_53/change_info.rb +72 -0
  425. data/lib/aws/route_53/client.rb +38 -0
  426. data/lib/aws/route_53/config.rb +18 -0
  427. data/lib/aws/route_53/errors.rb +22 -0
  428. data/lib/aws/route_53/hosted_zone.rb +134 -0
  429. data/lib/aws/route_53/hosted_zone_collection.rb +101 -0
  430. data/lib/aws/route_53/resource_record_set.rb +251 -0
  431. data/lib/aws/route_53/resource_record_set_collection.rb +110 -0
  432. data/lib/aws/s3.rb +156 -0
  433. data/lib/aws/s3/access_control_list.rb +265 -0
  434. data/lib/aws/s3/acl_object.rb +264 -0
  435. data/lib/aws/s3/acl_options.rb +204 -0
  436. data/lib/aws/s3/bucket.rb +742 -0
  437. data/lib/aws/s3/bucket_collection.rb +162 -0
  438. data/lib/aws/s3/bucket_lifecycle_configuration.rb +473 -0
  439. data/lib/aws/s3/bucket_tag_collection.rb +111 -0
  440. data/lib/aws/s3/bucket_version_collection.rb +79 -0
  441. data/lib/aws/s3/cipher_io.rb +120 -0
  442. data/lib/aws/s3/client.rb +2067 -0
  443. data/lib/aws/s3/client/xml.rb +266 -0
  444. data/lib/aws/s3/config.rb +48 -0
  445. data/lib/aws/s3/cors_rule.rb +108 -0
  446. data/lib/aws/s3/cors_rule_collection.rb +194 -0
  447. data/lib/aws/s3/data_options.rb +191 -0
  448. data/lib/aws/s3/encryption_utils.rb +146 -0
  449. data/lib/aws/s3/errors.rb +94 -0
  450. data/lib/aws/s3/multipart_upload.rb +353 -0
  451. data/lib/aws/s3/multipart_upload_collection.rb +76 -0
  452. data/lib/aws/s3/object_collection.rb +353 -0
  453. data/lib/aws/s3/object_metadata.rb +103 -0
  454. data/lib/aws/s3/object_upload_collection.rb +77 -0
  455. data/lib/aws/s3/object_version.rb +154 -0
  456. data/lib/aws/s3/object_version_collection.rb +89 -0
  457. data/lib/aws/s3/paginated_collection.rb +75 -0
  458. data/lib/aws/s3/policy.rb +74 -0
  459. data/lib/aws/s3/prefix_and_delimiter_collection.rb +47 -0
  460. data/lib/aws/s3/prefixed_collection.rb +85 -0
  461. data/lib/aws/s3/presign_v4.rb +136 -0
  462. data/lib/aws/s3/presigned_post.rb +554 -0
  463. data/lib/aws/s3/request.rb +62 -0
  464. data/lib/aws/s3/s3_object.rb +1784 -0
  465. data/lib/aws/s3/tree.rb +116 -0
  466. data/lib/aws/s3/tree/branch_node.rb +68 -0
  467. data/lib/aws/s3/tree/child_collection.rb +104 -0
  468. data/lib/aws/s3/tree/leaf_node.rb +94 -0
  469. data/lib/aws/s3/tree/node.rb +22 -0
  470. data/lib/aws/s3/tree/parent.rb +87 -0
  471. data/lib/aws/s3/uploaded_part.rb +82 -0
  472. data/lib/aws/s3/uploaded_part_collection.rb +84 -0
  473. data/lib/aws/s3/website_configuration.rb +102 -0
  474. data/lib/aws/simple_db.rb +218 -0
  475. data/lib/aws/simple_db/attribute.rb +156 -0
  476. data/lib/aws/simple_db/attribute_collection.rb +240 -0
  477. data/lib/aws/simple_db/client.rb +67 -0
  478. data/lib/aws/simple_db/config.rb +20 -0
  479. data/lib/aws/simple_db/consistent_read_option.rb +42 -0
  480. data/lib/aws/simple_db/delete_attributes.rb +62 -0
  481. data/lib/aws/simple_db/domain.rb +123 -0
  482. data/lib/aws/simple_db/domain_collection.rb +86 -0
  483. data/lib/aws/simple_db/domain_metadata.rb +110 -0
  484. data/lib/aws/simple_db/errors.rb +55 -0
  485. data/lib/aws/simple_db/expect_condition_option.rb +45 -0
  486. data/lib/aws/simple_db/item.rb +93 -0
  487. data/lib/aws/simple_db/item_collection.rb +654 -0
  488. data/lib/aws/simple_db/item_data.rb +73 -0
  489. data/lib/aws/simple_db/put_attributes.rb +60 -0
  490. data/lib/aws/simple_email_service.rb +443 -0
  491. data/lib/aws/simple_email_service/client.rb +37 -0
  492. data/lib/aws/simple_email_service/config.rb +18 -0
  493. data/lib/aws/simple_email_service/email_address_collection.rb +69 -0
  494. data/lib/aws/simple_email_service/errors.rb +22 -0
  495. data/lib/aws/simple_email_service/identity.rb +230 -0
  496. data/lib/aws/simple_email_service/identity_collection.rb +81 -0
  497. data/lib/aws/simple_email_service/quotas.rb +66 -0
  498. data/lib/aws/simple_workflow.rb +227 -0
  499. data/lib/aws/simple_workflow/activity_task.rb +178 -0
  500. data/lib/aws/simple_workflow/activity_task_collection.rb +123 -0
  501. data/lib/aws/simple_workflow/activity_type.rb +131 -0
  502. data/lib/aws/simple_workflow/activity_type_collection.rb +93 -0
  503. data/lib/aws/simple_workflow/client.rb +69 -0
  504. data/lib/aws/simple_workflow/config.rb +18 -0
  505. data/lib/aws/simple_workflow/count.rb +49 -0
  506. data/lib/aws/simple_workflow/decision_task.rb +603 -0
  507. data/lib/aws/simple_workflow/decision_task_collection.rb +223 -0
  508. data/lib/aws/simple_workflow/domain.rb +122 -0
  509. data/lib/aws/simple_workflow/domain_collection.rb +169 -0
  510. data/lib/aws/simple_workflow/errors.rb +20 -0
  511. data/lib/aws/simple_workflow/history_event.rb +276 -0
  512. data/lib/aws/simple_workflow/history_event_collection.rb +76 -0
  513. data/lib/aws/simple_workflow/option_formatters.rb +82 -0
  514. data/lib/aws/simple_workflow/resource.rb +94 -0
  515. data/lib/aws/simple_workflow/type.rb +89 -0
  516. data/lib/aws/simple_workflow/type_collection.rb +140 -0
  517. data/lib/aws/simple_workflow/workflow_execution.rb +384 -0
  518. data/lib/aws/simple_workflow/workflow_execution_collection.rb +617 -0
  519. data/lib/aws/simple_workflow/workflow_type.rb +177 -0
  520. data/lib/aws/simple_workflow/workflow_type_collection.rb +91 -0
  521. data/lib/aws/sns.rb +76 -0
  522. data/lib/aws/sns/client.rb +35 -0
  523. data/lib/aws/sns/config.rb +18 -0
  524. data/lib/aws/sns/errors.rb +22 -0
  525. data/lib/aws/sns/has_delivery_policy.rb +68 -0
  526. data/lib/aws/sns/message.rb +204 -0
  527. data/lib/aws/sns/originators/from_auto_scaling.rb +68 -0
  528. data/lib/aws/sns/policy.rb +47 -0
  529. data/lib/aws/sns/subscription.rb +165 -0
  530. data/lib/aws/sns/subscription_collection.rb +78 -0
  531. data/lib/aws/sns/topic.rb +403 -0
  532. data/lib/aws/sns/topic_collection.rb +62 -0
  533. data/lib/aws/sns/topic_subscription_collection.rb +54 -0
  534. data/lib/aws/sqs.rb +80 -0
  535. data/lib/aws/sqs/client.rb +53 -0
  536. data/lib/aws/sqs/config.rb +20 -0
  537. data/lib/aws/sqs/errors.rb +125 -0
  538. data/lib/aws/sqs/policy.rb +48 -0
  539. data/lib/aws/sqs/queue.rb +856 -0
  540. data/lib/aws/sqs/queue_collection.rb +186 -0
  541. data/lib/aws/sqs/received_message.rb +190 -0
  542. data/lib/aws/sqs/received_sns_message.rb +116 -0
  543. data/lib/aws/storage_gateway.rb +72 -0
  544. data/lib/aws/storage_gateway/client.rb +42 -0
  545. data/lib/aws/storage_gateway/config.rb +18 -0
  546. data/lib/aws/storage_gateway/errors.rb +22 -0
  547. data/lib/aws/sts.rb +164 -0
  548. data/lib/aws/sts/client.rb +55 -0
  549. data/lib/aws/sts/config.rb +18 -0
  550. data/lib/aws/sts/errors.rb +22 -0
  551. data/lib/aws/sts/federated_session.rb +56 -0
  552. data/lib/aws/sts/policy.rb +30 -0
  553. data/lib/aws/sts/session.rb +48 -0
  554. data/lib/aws/support.rb +29 -0
  555. data/lib/aws/support/client.rb +35 -0
  556. data/lib/aws/support/config.rb +18 -0
  557. data/lib/aws/support/errors.rb +20 -0
  558. data/lib/aws/version.rb +17 -0
  559. data/rails/init.rb +15 -0
  560. metadata +634 -0
@@ -0,0 +1,617 @@
1
+ # Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License"). You
4
+ # may not use this file except in compliance with the License. A copy of
5
+ # the License is located at
6
+ #
7
+ # http://aws.amazon.com/apache2.0/
8
+ #
9
+ # or in the "license" file accompanying this file. This file is
10
+ # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
11
+ # ANY KIND, either express or implied. See the License for the specific
12
+ # language governing permissions and limitations under the License.
13
+
14
+ require 'time'
15
+
16
+ module AWS
17
+ class SimpleWorkflow
18
+
19
+ # A collection that enumerates workflow executions.
20
+ #
21
+ # domain.workflow_executions.each do |execution|
22
+ # # ...
23
+ # end
24
+ #
25
+ # ## Filtering Executions
26
+ #
27
+ # By default, all open workflow executions are enumerated.
28
+ #
29
+ class WorkflowExecutionCollection
30
+
31
+ # @api private
32
+ FILTERS = [
33
+ :status,
34
+ :workflow_type,
35
+ :workflow_id,
36
+ :tagged,
37
+ :started_before,
38
+ :started_after,
39
+ :closed_before,
40
+ :closed_after,
41
+ ]
42
+
43
+ include Core::Collection::WithLimitAndNextToken
44
+ include OptionFormatters
45
+
46
+ # @api private
47
+ def initialize domain, options = {}
48
+
49
+ @domain = domain
50
+
51
+ @reverse_order = !!options[:reverse_order]
52
+
53
+ @defaults = FILTERS.inject({}) do |defaults,opt|
54
+ defaults[opt] = options[opt] if options.has_key?(opt)
55
+ defaults
56
+ end
57
+
58
+ super
59
+
60
+ end
61
+
62
+ # @return [Domain] Returns the domain this execution was started in.
63
+ attr_reader :domain
64
+
65
+ # Returns the workflow execution with the given `workflow_id` and
66
+ # `run_id`.
67
+ #
68
+ # # get a reference to a single workflow execution
69
+ # domain.workflow_executions['workflow-id', 'run-id']
70
+ # domain.workflow_executions.at('workflow-id', 'run-id')
71
+ #
72
+ # @param [String] workflow_id The workflow execution id.
73
+ #
74
+ # @param [String] run_id The workflow execution run id.
75
+ #
76
+ # @return [WorkflowExecution
77
+ #
78
+ def at workflow_id, run_id
79
+ WorkflowExecution.new(domain, workflow_id, run_id)
80
+ end
81
+ alias_method :[], :at
82
+
83
+ # Records a WorkflowExecutionSignaled event in the workflow execution
84
+ # history and creates a decision task for the workflow execution.
85
+ #
86
+ # domain.signal_workflow_execution('workflowid', 'newdata', :input => '...')
87
+ #
88
+ # @param [String] workflow_id The id of the workflow execution to signal.
89
+ #
90
+ # @param [String] signal_name The name of the signal. This name must be
91
+ # meaningful to the target workflow.
92
+ #
93
+ # @param [Hash] options
94
+ #
95
+ # @option options [String] :input (nil) Data to attach to the
96
+ # WorkflowExecutionSignaled event in the target workflow
97
+ # execution's history.
98
+ #
99
+ # @option options [String] :run_id (nil) The run id of the workflow
100
+ # execution to signal.
101
+ #
102
+ # If `:run_id` is not specified, then the WorkflowExecutionSignaled
103
+ # event is recorded in the history of the current open workflow
104
+ # with the matching workflow_id in the domain.
105
+ #
106
+ # @return [nil]
107
+ #
108
+ def signal workflow_id, signal_name, options = {}
109
+ options[:domain] = domain.name
110
+ options[:workflow_id] = workflow_id
111
+ options[:signal_name] = signal_name
112
+ client.signal_workflow_execution(options)
113
+ nil
114
+ end
115
+
116
+ # Records a WorkflowExecutionCancelRequested event in the currently
117
+ # running workflow execution identified. This logically requests
118
+ # the cancellation of the workflow execution as a whole.
119
+ # It is up to the decider to take appropriate actions when it receives
120
+ # an execution history with this event.
121
+ #
122
+ # @note If the `:run_id` is not specified, the
123
+ # WorkflowExecutionCancelRequested event is recorded in the history
124
+ # of the current open workflow execution with the specified
125
+ # `workflow_id` in the domain.
126
+ #
127
+ # @note Because this action allows the workflow to properly clean up
128
+ # and gracefully close, it should be used instead of {#terminate}
129
+ # when possible.
130
+ #
131
+ # @param [String] workflow_id The id of the workflow execution to cancel.
132
+ #
133
+ # @param [Hash] options
134
+ #
135
+ # @option options [String] :run_id (nil) The run id of the workflow
136
+ # execution to cancel.
137
+ #
138
+ # @return [nil]
139
+ #
140
+ def request_cancel workflow_id, options = {}
141
+ options[:domain] = domain.name
142
+ options[:workflow_id] = workflow_id
143
+ client.request_cancel_workflow_execution(options)
144
+ nil
145
+ end
146
+
147
+ # Records a WorkflowExecutionTerminated event and forces closure of
148
+ # the workflow execution identified. The child policy, registered
149
+ # with the workflow type or specified when starting this execution,
150
+ # is applied to any open child workflow executions of this workflow
151
+ # execution.
152
+ #
153
+ # @note If the workflow execution was in progress, it is terminated
154
+ # immediately.
155
+ #
156
+ # @note If a `:run_id` is not specified, then the
157
+ # WorkflowExecutionTerminated event is recorded in the history of
158
+ # the current open workflow with the matching workflowId in the
159
+ # domain.
160
+ #
161
+ # @note You should consider canceling the workflow execution
162
+ # instead because it allows the workflow to gracefully close
163
+ # while terminate does not.
164
+ #
165
+ # @param [String] workflow_id
166
+ #
167
+ # @param [Hash] options
168
+ #
169
+ # @option options [Symbol] :child_policy (nil)
170
+ # If set, specifies the policy to use for the child workflow
171
+ # executions of the workflow execution being terminated. This
172
+ # policy overrides the default child policy. Valid policies include:
173
+ #
174
+ # * `:terminate` - the child executions will be terminated.
175
+ #
176
+ # * `:request_cancel` - a request to cancel will be attempted for each
177
+ # child execution by recording a WorkflowExecutionCancelRequested
178
+ # event in its history. It is up to the decider to take appropriate
179
+ # actions when it receives an execution history with this event.
180
+ #
181
+ # * `:abandon` - no action will be taken. The child executions will
182
+ # continue to run.
183
+ #
184
+ # @option options [String] :details Optional details for
185
+ # terminating the workflow execution.
186
+ #
187
+ # @option options [String] :reason An optional descriptive
188
+ # reason for terminating the workflow execution.
189
+ #
190
+ # @option options [String] :run_id The run id of the workflow
191
+ # execution to terminate. If a `:run_id` is not provided, then a
192
+ # WorkflowExecutionTerminated event is recorded in the history of
193
+ # the current open workflow with the matching workflow id in the
194
+ # domain.
195
+ #
196
+ # @return [nil]
197
+ #
198
+ def terminate workflow_id, options = {}
199
+ options[:domain] = domain.name
200
+ options[:workflow_id] = workflow_id
201
+ upcase_opts(options, :child_policy)
202
+ client.terminate_workflow_execution(options)
203
+ nil
204
+ end
205
+
206
+ # @param [Symbol] status Causes the returned collection to filter
207
+ # executions by the given status. Accepted statuses include:
208
+ #
209
+ # * `:open`
210
+ # * `:closed`
211
+ # * `:completed`
212
+ # * `:failed`
213
+ # * `:canceled`
214
+ # * `:terminated`
215
+ # * `:continued_as_new`
216
+ # * `:timed_out`
217
+ #
218
+ # If `:status` is anything besides `:open` or `:closed` then
219
+ # it may not be used in combination with `workflow_id`,
220
+ # `workflow_type` or `tagged`.
221
+ #
222
+ # @return [WorkflowExecutionCollection] Returns a collection
223
+ # that will only enumerate or count executions of the given
224
+ # status.
225
+ #
226
+ def with_status status
227
+ collection_with(:status => status)
228
+ end
229
+
230
+ # @param [String] workflow_id
231
+ #
232
+ # @return [WorkflowExecutionCollection] Returns a collection
233
+ # that will only enumerate or count executions that have
234
+ # the given `workflow_id`.
235
+ #
236
+ def with_workflow_id workflow_id
237
+ collection_with(:workflow_id => workflow_id)
238
+ end
239
+
240
+ # @param [WorkflowType,Hash] workflow_type Should be a {WorkflowType}
241
+ # object or a hash with `:name` and `:version` keys.
242
+ #
243
+ # @return [WorkflowExecutionCollection] Returns a collection
244
+ # that will only enumerate or count executions that have
245
+ # the given `workflow_type`.
246
+ #
247
+ def with_workflow_type workflow_type
248
+ collection_with(:workflow_type => workflow_type)
249
+ end
250
+
251
+ # @param [String] tag A tag to filter workflow executions with.
252
+ #
253
+ # @return [WorkflowExecutionCollection] Returns a collection
254
+ # that will only enumerate or count executions that have
255
+ # the given `tag`.
256
+ #
257
+ def tagged tag
258
+ collection_with(:tagged => tag)
259
+ end
260
+
261
+ # Filters workflow executions by their start date.
262
+ #
263
+ # @note It is not possible to filter by both start time and close time.
264
+ #
265
+ # @param [Time,DateTime,Date,Integer,String] oldest_time Should
266
+ # be one of the listed types. Integers are treated as timestamps
267
+ # and strings are parsed by DateTime.
268
+ #
269
+ # @param [Time,DateTime,Date,Integer,String] latest_time Should
270
+ # be one of the listed types. Integers are treated as timestamps
271
+ # and strings are parsed by DateTime.
272
+ #
273
+ # @return [WorkflowExecutionCollection] Returns a collection
274
+ # that will only enumerate or count executions that have start
275
+ # times that fall within the given range.
276
+ #
277
+ def started_between oldest_time, latest_time
278
+ started_after(oldest_time).started_before(latest_time)
279
+ end
280
+
281
+ # Filters workflow executions by their start date.
282
+ #
283
+ # # executions that started at least an hour ago
284
+ # domain.workflow_executions.started_before(Time.now - 3600)
285
+ #
286
+ # @note It is not possible to filter by both start time and close time.
287
+ #
288
+ # @param [Time,DateTime,Date,Integer,String] time Should
289
+ # be one of the listed types. Integers are treated as timestamps
290
+ # and strings are parsed by DateTime.
291
+ #
292
+ # @return [WorkflowExecutionCollection] Returns a collection
293
+ # that will only enumerate or count executions that started
294
+ # before the given time.
295
+ #
296
+ def started_before time
297
+ collection_with(:started_before => time)
298
+ end
299
+
300
+ # Filters workflow executions by their start date.
301
+ #
302
+ # # executions that started within the last hour
303
+ # domain.workflow_executions.started_after(Time.now - 3600)
304
+ #
305
+ # @note It is not possible to filter by both start time and close time.
306
+ #
307
+ # @param [Time,DateTime,Date,Integer,String] time Should
308
+ # be one of the listed types. Integers are treated as timestamps
309
+ # and strings are parsed by DateTime.
310
+ #
311
+ # @return [WorkflowExecutionCollection] Returns a collection
312
+ # that will only enumerate or count executions that started
313
+ # after the given time.
314
+ #
315
+ def started_after time
316
+ collection_with(:started_after => time)
317
+ end
318
+
319
+ # Filters workflow executions by their close date.
320
+ #
321
+ # @note It is not possible to filter by both start time and close time.
322
+ #
323
+ # @param [Time,DateTime,Date,Integer,String] oldest_time Should
324
+ # be one of the listed types. Integers are treated as timestamps
325
+ # and strings are parsed by DateTime.
326
+ #
327
+ # @param [Time,DateTime,Date,Integer,String] latest_time Should
328
+ # be one of the listed types. Integers are treated as timestamps
329
+ # and strings are parsed by DateTime.
330
+ #
331
+ # @return [WorkflowExecutionCollection] Returns a collection
332
+ # that will only enumerate or count executions that closed
333
+ # between the given times.
334
+ #
335
+ def closed_between oldest_time, latest_time
336
+ closed_after(oldest_time).closed_before(latest_time)
337
+ end
338
+
339
+ # Filters workflow executions by their close date.
340
+ #
341
+ # # executions that closed more than an hour ago
342
+ # domain.workflow_executions.closed_before(Time.now - 3600)
343
+ #
344
+ # @note It is not possible to filter by both start time and close time.
345
+ #
346
+ # @param [Time,DateTime,Date,Integer,String] time Should
347
+ # be one of the listed types. Integers are treated as timestamps
348
+ # and strings are parsed by DateTime.
349
+ #
350
+ # @return [WorkflowExecutionCollection] Returns a collection
351
+ # that will only enumerate or count executions that closed
352
+ # before the given time.
353
+ #
354
+ def closed_before time
355
+ collection_with(:closed_before => time)
356
+ end
357
+
358
+ # Filters workflow executions by their close date.
359
+ #
360
+ # # executions that closed within the last hour
361
+ # domain.workflow_executions.closed_after(Time.now - 3600)
362
+ #
363
+ # @note It is not possible to filter by both start time and close time.
364
+ #
365
+ # @param [Time,DateTime,Date,Integer,String] time Should
366
+ # be one of the listed types. Integers are treated as timestamps
367
+ # and strings are parsed by DateTime.
368
+ #
369
+ # @return [WorkflowExecutionCollection] Returns a collection
370
+ # that will only enumerate or count executions that closed
371
+ # after the given time.
372
+ #
373
+ def closed_after time
374
+ collection_with(:closed_after => time)
375
+ end
376
+
377
+ # Returns a collection that enumerates workflow executions in reverse
378
+ # chronological order. By default executions are enumerated in
379
+ # ascending order of their start or close time (ordered by
380
+ # close time when filtered by #closed_between).
381
+ #
382
+ # # get the latest execution
383
+ # execution = domain.workflow_executions.reverse_order.first
384
+ #
385
+ # @return [WorkflowExecutionCollection] Returns a collection
386
+ # that enumerates workflow executions in reverse order.
387
+ #
388
+ def reverse_order
389
+ collection_with(:reverse_order => true)
390
+ end
391
+
392
+ # Returns the number of workflow executions within the domain that
393
+ # meet the specified filtering criteria. Counts can be truncated
394
+ # so you should check the return value.
395
+ #
396
+ # count = domain.workflow_executions.count
397
+ # puts(count.truncated? ? "#{count.to_i}+" : count.to_i)
398
+ #
399
+ # @note You may only pass one of the following options:
400
+ # `:workflow_id`, `:workflow_type`, `:tagged` or
401
+ # `:status` with a "closed" value (`:status` with `:open` is okay).
402
+ #
403
+ # @note This operation is eventually consistent. The results are best
404
+ # effort and may not exactly reflect recent updates and changes.
405
+ #
406
+ # @param [Hash] options
407
+ #
408
+ # @option options [Symbol] :status Filters workflow executions by the
409
+ # given status. If status is not provided then it defaults to
410
+ # `:open` unless you pass `:closed_between` (then it defaults to
411
+ # `:closed`).
412
+ #
413
+ # If `:status` is anything besides `:open` or `:closed` then
414
+ # it may not be passed with `:workflow_id`, `:workflow_type` or
415
+ # `:tagged`.
416
+ #
417
+ # Accepted values for `:status` include:
418
+ #
419
+ # * `:open`
420
+ # * `:closed`
421
+ # * `:completed`
422
+ # * `:failed`
423
+ # * `:canceled`
424
+ # * `:terminated`
425
+ # * `:continued_as_new`
426
+ # * `:timed_out`
427
+ #
428
+ # @option options [Time] :started_after Filters workflow executions
429
+ # down to those started after the given time.
430
+ #
431
+ # You may pass `:started_after` with `:started_before`, but not with
432
+ # `:closed_after` or `:closed_before`.
433
+ #
434
+ # @option options [Time] :started_before Filters workflow executions
435
+ # down to those started before the given time.
436
+ #
437
+ # You may pass `:started_after` with `:started_before`, but not with
438
+ # `:closed_after` or `:closed_before`.
439
+ #
440
+ # @option options [Time] :closed_after Filters workflow executions
441
+ # to those closed after the given time.
442
+ #
443
+ # * You may pass `:closed_after` with `:closed_before`, but not with
444
+ # `:started_after` or `:started_before`.
445
+ #
446
+ # * This option is invalid when counting or listing open executions.
447
+ #
448
+ # @option options [Time] :closed_before Filters workflow executions
449
+ # to those closed before the given time.
450
+ #
451
+ # * You may pass `:closed_after` with `:closed_before`, but not with
452
+ # `:started_after` or `:started_before`.
453
+ #
454
+ # * This option is invalid when counting or listing open executions.
455
+ #
456
+ # @option options [String] :workflow_id (nil) If specified, workflow
457
+ # executions are filtered by the provided workflow id.
458
+ #
459
+ # @option options [String] :tagged (nil) Filters workflow executions
460
+ # by the given tag.
461
+ #
462
+ # @option options [WorkflowType,Hash] :workflow_type (nil)
463
+ # Filters workflow executions with the given workflow type.
464
+ # `:workflow_type` can be a {WorkflowType} object or a hash with
465
+ # a workflow type `:name` and `:version`.
466
+ #
467
+ # @return [Count] Returns a possibly truncated count of
468
+ # workflow executions.
469
+ #
470
+ def count options = {}
471
+
472
+ open_or_closed, client_opts = handle_options(options)
473
+
474
+ client_method = :"count_#{open_or_closed}_workflow_executions"
475
+ response = client.send(client_method, client_opts)
476
+ Count.new(response.data['count'], response.data['truncated'])
477
+ end
478
+
479
+ # Enumerates workflow executions.
480
+ # @note (see #count)
481
+ # @param (see #count)
482
+ # @option (see #count)
483
+ # @option (see Core::Collection#each)
484
+ # @option options [Boolean] :reverse_order Enumerates the workflow
485
+ # execution in reverse chronological order if `true`. The date
486
+ # used will be the execution start time unless filtering by
487
+ # closed before/after (then it will sort by the closed time).
488
+ # @return (see Core::Collection#each)
489
+ def each options = {}
490
+ super
491
+ end
492
+
493
+ protected
494
+ def collection_with options = {}
495
+ defaults = @defaults.merge(:reverse_order => @reverse_order)
496
+ self.class.new(domain, defaults.merge(options))
497
+ end
498
+
499
+ protected
500
+ def _each_item next_token, limit, options = {}, &block
501
+
502
+ open_or_closed, client_opts = handle_options(options)
503
+
504
+ client_method = :"list_#{open_or_closed}_workflow_executions"
505
+
506
+ client_opts[:maximum_page_size] = limit if limit
507
+ client_opts[:next_page_token] = next_token if next_token
508
+ client_opts[:reverse_order] = @reverse_order unless
509
+ client_opts.key?(:reverse_order)
510
+
511
+ response = client.send(client_method, client_opts)
512
+ response.data['executionInfos'].each do |desc|
513
+
514
+ workflow_id = desc['execution']['workflowId']
515
+ run_id = desc['execution']['runId']
516
+
517
+ workflow_execution = WorkflowExecution.new_from(
518
+ client_method, desc, domain, workflow_id, run_id)
519
+
520
+ yield(workflow_execution)
521
+
522
+ end
523
+
524
+ response.data['nextPageToken']
525
+
526
+ end
527
+
528
+ protected
529
+ def handle_options options
530
+
531
+ options = @defaults.merge(options)
532
+
533
+ options[:domain] = domain.name
534
+
535
+ status = options.delete(:status)
536
+ status ||= (options[:closed_after] or options[:closed_before]) ?
537
+ :closed : :open
538
+
539
+ case status
540
+ when :open then open_or_closed = :open
541
+ when :closed then open_or_closed = :closed
542
+ else
543
+ open_or_closed = :closed
544
+ options[:close_status_filter] = { :status => status.to_s.upcase }
545
+ end
546
+
547
+ time_filter(open_or_closed, options)
548
+
549
+ if workflow_id = options.delete(:workflow_id)
550
+ options[:execution_filter] = {}
551
+ options[:execution_filter][:workflow_id] = workflow_id
552
+ end
553
+
554
+ if tag = options.delete(:tagged)
555
+ options[:tag_filter] = {}
556
+ options[:tag_filter][:tag] = tag
557
+ end
558
+
559
+ if type = options.delete(:workflow_type)
560
+ if type.is_a?(WorkflowType)
561
+ type = { :name => type.name, :version => type.version }
562
+ end
563
+ options[:type_filter] = type
564
+ end
565
+
566
+ [open_or_closed, options]
567
+
568
+ end
569
+
570
+ protected
571
+ def time_filter open_or_closed, options
572
+
573
+ early_2010 = Time.parse('2010-01-01').to_i
574
+
575
+ [%w(start started), %w(close closed)].each do |mode, suffixed|
576
+
577
+ after = options.delete(:"#{suffixed}_after")
578
+ before = options.delete(:"#{suffixed}_before")
579
+
580
+ next unless after or before
581
+
582
+ time_filter = {}
583
+ time_filter[:oldest_date] = to_timestamp(after || early_2010)
584
+ time_filter[:latest_date] = to_timestamp(before) if before
585
+
586
+ options[:"#{mode}_time_filter"] = time_filter
587
+
588
+ end
589
+
590
+ if options.key?(:start_time_filter) and options.key?(:close_time_filter)
591
+ raise 'You may filter by execution start or close time but not both.'
592
+ end
593
+
594
+ if options.key?(:close_time_filter) and open_or_closed == :open
595
+ raise 'Unable to filter by closed time for open workflow executions.'
596
+ end
597
+
598
+ # if the client does not filter by start or close time, then add
599
+ # a default filter that should return "everything"
600
+ unless options[:start_time_filter] or options[:close_time_filter]
601
+ options[:start_time_filter] = { :oldest_date => early_2010 }
602
+ end
603
+
604
+ end
605
+
606
+ protected
607
+ def to_timestamp time
608
+ case time
609
+ when Integer then time
610
+ when Time then time.to_i
611
+ else Time.parse(time.to_s).to_i
612
+ end
613
+ end
614
+
615
+ end
616
+ end
617
+ end