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,856 @@
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 'digest'
15
+
16
+ module AWS
17
+ class SQS
18
+
19
+ # Represents an Amazon SQS Queue.
20
+ #
21
+ # @example Sending a message
22
+ #
23
+ # msg = queue.send_message("HELLO")
24
+ # puts "Sent message: #{msg.id}"
25
+ #
26
+ # @example Polling for messages indefinitely
27
+ #
28
+ # queue.poll do |msg|
29
+ # puts "Got message: #{msg.body}"
30
+ # end
31
+ #
32
+ class Queue
33
+
34
+ # The default number of seconds to wait between polling requests for
35
+ # new messages.
36
+ # @deprecated No longer used by {#poll}
37
+ DEFAULT_POLL_INTERVAL = 1
38
+
39
+ # The default number of seconds to pass in as the SQS long polling
40
+ # value (`:wait_time_seconds`) in {#receive_message}.
41
+ #
42
+ # @since 1.8.0
43
+ DEFAULT_WAIT_TIME_SECONDS = 15
44
+
45
+ include Core::Model
46
+
47
+ # @return [String] The queue URL.
48
+ attr_reader :url
49
+
50
+ # @api private
51
+ def initialize(url, opts = {})
52
+ @url = url
53
+ super
54
+ end
55
+
56
+ # Deletes the queue, regardless of whether it is empty.
57
+ #
58
+ # When you delete a queue, the deletion process takes up to 60
59
+ # seconds. Requests you send involving that queue during the
60
+ # 60 seconds might succeed. For example, calling
61
+ # {#send_message} might succeed, but after the 60 seconds, the
62
+ # queue and that message you sent no longer exist.
63
+ #
64
+ # Also, when you delete a queue, you must wait at least 60 seconds
65
+ # before creating a queue with the same name.
66
+ # @return [nil]
67
+ def delete
68
+ client.delete_queue(:queue_url => url)
69
+ nil
70
+ end
71
+
72
+ # Represents a message sent using {Queue#send_message}.
73
+ class SentMessage
74
+
75
+ # @return [String] Returns the message ID.
76
+ attr_accessor :message_id
77
+
78
+ alias_method :id, :message_id
79
+
80
+ # @return [String] Returns the request ID.
81
+ attr_accessor :request_id
82
+
83
+ # @return [String] Returns an MD5 digest of the message body
84
+ # string. You can use this to verify that SQS received your
85
+ # message correctly.
86
+ attr_accessor :md5
87
+
88
+ end
89
+
90
+ # Delivers a message to this queue.
91
+ #
92
+ # @param [String] body The message to send. The maximum
93
+ # allowed message size is 64 KB. The message may only
94
+ # contain Unicode characters from the following list,
95
+ # according to the W3C XML specification (for more
96
+ # information, go to
97
+ # http://www.w3.org/TR/REC-xml/#charsets). If you send any
98
+ # characters not included in the list, your request will be
99
+ # rejected.
100
+ #
101
+ # * `#x9`
102
+ # * `#xA`
103
+ # * `#xD`
104
+ # * `#x20` to `#xD7FF`
105
+ # * `#xE000` to `#xFFFD`
106
+ # * `#x10000` to `#x10FFFF`
107
+ #
108
+ # @param [Hash] options
109
+ #
110
+ # @option options [Integer] :delay_seconds The number of seconds to
111
+ # delay the message. The message will become available for
112
+ # processing after the delay time has passed.
113
+ # If you don't specify a value, the default value for the
114
+ # queue applies. Should be from 0 to 900 (15 mins).
115
+ #
116
+ # @return [SentMessage] An object containing information about
117
+ # the message that was sent.
118
+ #
119
+ def send_message body, options = {}
120
+
121
+ client_opts = options.dup
122
+ client_opts[:queue_url] = url
123
+ client_opts[:message_body] = body
124
+
125
+ response = client.send_message(client_opts)
126
+
127
+ msg = SentMessage.new
128
+ msg.message_id = response[:message_id]
129
+ msg.request_id = (response[:response_metadata] || {})[:request_id]
130
+ msg.md5 = response[:md5_of_message_body]
131
+
132
+ verify_send_message_checksum body, msg.md5
133
+
134
+ msg
135
+
136
+ end
137
+
138
+ # Retrieves one or more messages. When a block is given, each
139
+ # message is yielded to the block and then deleted as long as
140
+ # the block exits normally. When no block is given, you must
141
+ # delete the message yourself using {ReceivedMessage#delete}.
142
+ #
143
+ # @note Due to the distributed nature of the queue, a weighted
144
+ # random set of machines is sampled on a ReceiveMessage
145
+ # call. That means only the messages on the sampled machines
146
+ # are returned. If the number of messages in the queue is
147
+ # small (less than 1000), it is likely you will get fewer
148
+ # messages than you requested per call to
149
+ # {#receive_message}. If the number of messages in the queue
150
+ # is extremely small, you might not receive any messages.
151
+ # To poll continually for messages, use the {#poll} method,
152
+ # which automatically retries the request after a
153
+ # configurable delay.
154
+ #
155
+ # @param [Hash] opts Options for receiving messages.
156
+ #
157
+ # @option opts [Integer] :limit The maximum number of messages
158
+ # to receive. By default this is 1, and the return value is
159
+ # a single message object. If this options is specified and
160
+ # is not 1, the return value is an array of message objects;
161
+ # however, the array may contain fewer objects than you
162
+ # requested. Valid values: integers from 1 to 10.
163
+ #
164
+ # Not necessarily all the messages in the queue are returned
165
+ # (for more information, see the preceding note about
166
+ # machine sampling).
167
+ #
168
+ # @option opts [Integer] :wait_time_seconds The number of seconds
169
+ # the service should wait for a response when requesting a new message.
170
+ # Defaults to the {#wait_time_seconds} attribute defined on the queue.
171
+ # See {#wait_time_seconds} to set the global long poll setting
172
+ # on the queue.
173
+ #
174
+ # @option opts [Integer] :visibility_timeout The duration (in
175
+ # seconds) that the received messages are hidden from
176
+ # subsequent retrieve requests. Valid values: integer from
177
+ # 0 to 43200 (maximum 12 hours)
178
+ #
179
+ # @option opts [Array<Symbol, String>] :attributes The
180
+ # attributes to populate in each received message. Valid values:
181
+ #
182
+ # * `:all` (to populate all attributes)
183
+ # * `:sender_id`
184
+ # * `:sent_at`
185
+ # * `:receive_count`
186
+ # * `:first_received_at`
187
+ #
188
+ # See {ReceivedMessage} for documentation on each
189
+ # attribute's meaning.
190
+ #
191
+ # @option opts [Array<String>] :message_attribute_names A list of
192
+ # message attribute names to receive. These will be available on
193
+ # the {ReceivedMessage} as `#message_attributes`.
194
+ #
195
+ # @yieldparam [ReceivedMessage] message Each message that was received.
196
+ #
197
+ # @return [ReceivedMessage] Returns the received message (or messages)
198
+ # only if a block is not given to this method.
199
+ #
200
+ def receive_message(opts = {}, &block)
201
+ resp = client.receive_message(receive_opts(opts))
202
+
203
+ failed = verify_receive_message_checksum resp
204
+
205
+ raise Errors::ChecksumError.new(failed) unless failed.empty?
206
+
207
+ messages = resp[:messages].map do |m|
208
+ ReceivedMessage.new(self, m[:message_id], m[:receipt_handle],
209
+ :body => m[:body],
210
+ :md5 => m[:md5_of_body],
211
+ :request_id => (resp[:response_metadata] || {})[:request_id],
212
+ :attributes => m[:attributes],
213
+ :message_attributes => m[:message_attributes])
214
+ end
215
+
216
+ if block
217
+ call_message_block(messages, block)
218
+ elsif opts[:limit] && opts[:limit] != 1
219
+ messages
220
+ else
221
+ messages.first
222
+ end
223
+ end
224
+ alias_method :receive_messages, :receive_message
225
+
226
+ # Polls continually for messages. For example, you can use
227
+ # this to poll indefinitely:
228
+ #
229
+ # queue.poll { |msg| puts msg.body }
230
+ #
231
+ # Or, to poll indefinitely for the first message and then
232
+ # continue polling until no message is received for a period
233
+ # of at least ten seconds:
234
+ #
235
+ # queue.poll(:initial_timeout => false,
236
+ # :idle_timeout => 10) { |msg| puts msg.body }
237
+ #
238
+ # As with the block form of {#receive_message}, this method
239
+ # automatically deletes the message then the block exits
240
+ # normally.
241
+ #
242
+ # @yieldparam [ReceivedMessage] message Each message that was received.
243
+ #
244
+ # @param [Hash] opts Options for polling.
245
+ #
246
+ # @option opts [Integer] :wait_time_seconds The number of seconds
247
+ # the service should wait for a response when requesting a new message.
248
+ # Defaults to {DEFAULT_WAIT_TIME_SECONDS}. Use `nil` to
249
+ # use the queue's global long polling wait time setting.
250
+ # See {#wait_time_seconds} to set the global long poll setting
251
+ # on the queue.
252
+ #
253
+ # @option opts [Integer] :idle_timeout The maximum number of
254
+ # seconds to spend polling while no messages are being
255
+ # returned. By default this method polls indefinitely
256
+ # whether messages are received or not.
257
+ #
258
+ # @option opts [Integer] :initial_timeout The maximum number
259
+ # of seconds to spend polling before the first message is
260
+ # received. This option defaults to the value of
261
+ # `:idle_timeout`. You can specify `false` to poll
262
+ # indefinitely for the first message when `:idle_timeout` is
263
+ # set.
264
+ #
265
+ # @option opts [Integer] :batch_size The maximum number of
266
+ # messages to retrieve in a single request. By default
267
+ # messages are received one at a time. Valid values:
268
+ # integers from 1 to 10.
269
+ #
270
+ # @option opts [Integer] :visibility_timeout The duration (in
271
+ # seconds) that the received messages are hidden from
272
+ # subsequent retrieve requests. Valid values: integer from
273
+ # 0 to 43200 (maximum 12 hours)
274
+ #
275
+ # @option opts [Array<Symbol, String>] :attributes The
276
+ # attributes to populate in each received message. Valid values:
277
+ #
278
+ # * `:all` (to populate all attributes)
279
+ # * `:sender_id`
280
+ # * `:sent_at`
281
+ # * `:receive_count`
282
+ # * `:first_received_at`
283
+ #
284
+ # See {ReceivedMessage} for documentation on each
285
+ # attribute's meaning.
286
+ #
287
+ # @option opts [Float, Integer] :poll_interval As of
288
+ # v1.7.2, this option is no longer used. See the
289
+ # `:wait_time_seconds` option for long polling instead.
290
+ #
291
+ # @return [nil]
292
+ def poll(opts = {}, &block)
293
+ opts[:limit] = opts.delete(:batch_size) if
294
+ opts.key?(:batch_size)
295
+
296
+ opts[:wait_time_seconds] = DEFAULT_WAIT_TIME_SECONDS unless
297
+ opts.has_key?(:wait_time_seconds)
298
+
299
+ last_message_at = Time.now
300
+ got_first = false
301
+ loop do
302
+ got_msg = false
303
+ receive_messages(opts) do |message|
304
+ got_msg = got_first = true
305
+ last_message_at = Time.now
306
+ yield(message)
307
+ end
308
+ unless got_msg
309
+ return if hit_timeout?(got_first, last_message_at, opts)
310
+ end
311
+ end
312
+ nil
313
+ end
314
+
315
+ # @return [Integer] The approximate number of visible messages
316
+ # in a queue. For more information, see
317
+ # [Resources Required to Process Messages](http://docs.amazonwebservices.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/IntroductionArticle.html#ApproximateNumber)
318
+ # in the Amazon SQS Developer Guide.
319
+ def approximate_number_of_messages
320
+ get_attribute("ApproximateNumberOfMessages").to_i
321
+ end
322
+ alias_method :visible_messages, :approximate_number_of_messages
323
+
324
+ # @return [Integer] The approximate number of messages that
325
+ # are not timed-out and not deleted. For more information,
326
+ # see [Resources Required to Process Messages](http://docs.amazonwebservices.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/IntroductionArticle.html#ApproximateNumber)
327
+ # in the Amazon SQS Developer Guide.
328
+ def approximate_number_of_messages_not_visible
329
+ get_attribute("ApproximateNumberOfMessagesNotVisible").to_i
330
+ end
331
+ alias_method :invisible_messages, :approximate_number_of_messages_not_visible
332
+
333
+ # @return [Integer] Returns the visibility timeout for the
334
+ # queue. For more information about visibility timeout, see
335
+ # [Visibility Timeout](http://docs.amazonwebservices.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/IntroductionArticle.html#AboutVT)
336
+ # in the Amazon SQS Developer Guide.
337
+ def visibility_timeout
338
+ get_attribute("VisibilityTimeout").to_i
339
+ end
340
+
341
+ # Sets the visibility timeout for the queue.
342
+ #
343
+ # @param [Integer] timeout The length of time (in seconds)
344
+ # that a message received from a queue will be invisible to
345
+ # other receiving components when they ask to receive
346
+ # messages. Valid values: integers from 0 to 43200 (12
347
+ # hours).
348
+ #
349
+ # @return Returns the value passed as a timeout.
350
+ def visibility_timeout=(timeout)
351
+ set_attribute("VisibilityTimeout", timeout.to_s)
352
+ timeout
353
+ end
354
+
355
+ # @return [Time] The time when the queue was created.
356
+ def created_timestamp
357
+ Time.at(get_attribute("CreatedTimestamp").to_i)
358
+ end
359
+
360
+ # @return [Time] The time when the queue was last changed.
361
+ def last_modified_timestamp
362
+ Time.at(get_attribute("LastModifiedTimestamp").to_i)
363
+ end
364
+
365
+ # @return [Integer] The limit of how many bytes a message can
366
+ # contain before Amazon SQS rejects it.
367
+ def maximum_message_size
368
+ get_attribute("MaximumMessageSize").to_i
369
+ end
370
+
371
+ # Sets the maximum message size for the queue.
372
+ #
373
+ # @param [Integer] size The limit of how many bytes a message
374
+ # can contain before Amazon SQS rejects it. This must be an
375
+ # integer from 1024 bytes (1KB) up to 65536 bytes
376
+ # (64KB). The default for this attribute is 8192 (8KB).
377
+ # @return Retuns the passed size argument.
378
+ def maximum_message_size=(size)
379
+ set_attribute("MaximumMessageSize", size.to_s)
380
+ end
381
+
382
+ # @return [Integer] The number of seconds Amazon SQS retains a
383
+ # message.
384
+ def message_retention_period
385
+ get_attribute("MessageRetentionPeriod").to_i
386
+ end
387
+
388
+ # Sets the message retention period for the queue
389
+ #
390
+ # @param [Integer] period The number of seconds Amazon SQS
391
+ # retains a message. Must be an integer from 3600 (1 hour)
392
+ # to 1209600 (14 days). The default for this attribute is
393
+ # 345600 (4 days).
394
+ # @return Returns the passed period argument.
395
+ def message_retention_period=(period)
396
+ set_attribute("MessageRetentionPeriod", period.to_s)
397
+ period
398
+ end
399
+
400
+ # @return [Integer] Gets the current default delay for messages sent
401
+ # to the queue.
402
+ def delay_seconds
403
+ get_attribute("DelaySeconds").to_i
404
+ end
405
+
406
+ # Sets the default delay for messages sent to the queue.
407
+ # @param [Integer] seconds How many seconds a message will be delayed.
408
+ def delay_seconds= seconds
409
+ set_attribute("DelaySeconds", seconds.to_s)
410
+ end
411
+
412
+ # @return [Integer] Gets the number of seconds the service will wait
413
+ # for a response when requesting a new message
414
+ # @since 1.8.0
415
+ def wait_time_seconds
416
+ get_attribute("ReceiveMessageWaitTimeSeconds").to_i
417
+ end
418
+
419
+ # Sets the number of seconds that the service should wait for a response
420
+ # when requesting a new message
421
+ # @param [Integer] seconds How many seconds to wait for a response
422
+ # @since 1.8.0
423
+ def wait_time_seconds= seconds
424
+ set_attribute("ReceiveMessageWaitTimeSeconds", seconds.to_s)
425
+ end
426
+
427
+ # @return [Integer] Returns an approximate count of messages delayed.
428
+ def approximate_number_of_messages_delayed
429
+ get_attribute("ApproximateNumberOfMessagesDelayed").to_i
430
+ end
431
+
432
+ # @return [String] The queue's Amazon resource name (ARN).
433
+ def arn
434
+ @arn ||= get_attribute("QueueArn")
435
+ end
436
+
437
+ # @return [Boolean] True if the queue exists.
438
+ #
439
+ # @note This may raise an exception if you don't have
440
+ # permission to access the queue attributes. Also, it may
441
+ # return true for up to 60 seconds after a queue has been
442
+ # deleted.
443
+ def exists?
444
+ client.get_queue_attributes(:queue_url => url,
445
+ :attribute_names => ["QueueArn"])
446
+ rescue Errors::NonExistentQueue, Errors::InvalidAddress
447
+ false
448
+ else
449
+ true
450
+ end
451
+
452
+ # @api private
453
+ module PolicyProxy
454
+
455
+ attr_accessor :queue
456
+
457
+ def change
458
+ yield(self)
459
+ queue.policy = self
460
+ end
461
+
462
+ def delete
463
+ queue.client.send(:set_attribute, 'Policy', '')
464
+ end
465
+
466
+ end
467
+
468
+ # @return [Policy] Returns the current queue policy if there is one.
469
+ # Returns `nil` otherwise.
470
+ def policy
471
+ if policy_json = get_attribute('Policy')
472
+ policy = SQS::Policy.from_json(policy_json)
473
+ policy.extend(PolicyProxy)
474
+ policy.queue = self
475
+ policy
476
+ else
477
+ nil
478
+ end
479
+ end
480
+
481
+ # Set the policy on this queue.
482
+ #
483
+ # If you pass nil or an empty string then it will have the same
484
+ # effect as deleting the policy.
485
+ #
486
+ # @param policy The policy to set. This policy can be a {Policy} object,
487
+ # a json policy string, or any other object that responds with a policy
488
+ # string when it received #to_json.
489
+ #
490
+ # @return [nil]
491
+ #
492
+ def policy= policy
493
+ policy_string = case policy
494
+ when nil, '' then ''
495
+ when String then policy
496
+ else policy.to_json
497
+ end
498
+ set_attribute('Policy', policy_string)
499
+ nil
500
+ end
501
+
502
+ # Sends a batch of up to 10 messages in a single request.
503
+ #
504
+ # queue.send_messages('message-1', 'message-2')
505
+ #
506
+ # You can also set an optional delay for all of the messages:
507
+ #
508
+ # # delay all messages 15 minutes
509
+ # queue.batch_send(msg1, msg2, :delay_seconds => 900)
510
+ #
511
+ # If you need to set a custom delay for each message you can pass
512
+ # hashes:
513
+ #
514
+ # messages = []
515
+ # messages << { :message_body => 'msg1', :delay_seconds => 60 }
516
+ # messages << { :message_body => 'msg2', :delay_seconds => 30 }
517
+ #
518
+ # queue.batch_send(messages)
519
+ #
520
+ # @param [String,Hash] messages A list of messages. Each message
521
+ # should be a string, or a hash with a `:message_body`,
522
+ # and optionally `:delay_seconds`.
523
+ #
524
+ # @raise [Errors::BatchSendError] Raises this error when one or more
525
+ # of the messages failed to send, but others did not. On the raised
526
+ # object you can access a list of the messages that failed, and
527
+ # a list of messages that succeeded.
528
+ #
529
+ # @return [Array<SentMessage>] Returns an array of sent message objects.
530
+ # Each object responds to #message_id and #md5_of_message_body.
531
+ # The message id is generated by Amazon SQS.
532
+ #
533
+ def batch_send *messages
534
+
535
+ entries = messages.flatten
536
+
537
+ unless entries.first.is_a?(Hash)
538
+ options = entries.last.is_a?(Hash) ? entries.pop : {}
539
+ entries = entries.collect{|msg| { :message_body => msg } }
540
+ if delay = options[:delay_seconds]
541
+ entries.each {|entry| entry[:delay_seconds] = delay }
542
+ end
543
+ end
544
+
545
+ entries.each_with_index {|entry,n| entry[:id] = n.to_s }
546
+
547
+ client_opts = {}
548
+ client_opts[:queue_url] = url
549
+ client_opts[:entries] = entries
550
+
551
+ response = client.send_message_batch(client_opts)
552
+
553
+ failed = batch_failures(entries, response, true)
554
+
555
+ checksum_failed = verify_send_message_batch_checksum entries, response
556
+
557
+ sent = response[:successful].collect do |sent|
558
+ msg = SentMessage.new
559
+ msg.message_id = sent[:message_id]
560
+ msg.md5 = sent[:md5_of_message_body]
561
+ msg
562
+ end
563
+
564
+ if !failed.empty? && !checksum_failed.empty?
565
+ send_error = Errors::BatchSendError.new(sent, failed)
566
+ checksum_error = Errors::ChecksumError.new(checksum_failed)
567
+ raise Errors::BatchSendMultiError.new send_error, checksum_error
568
+ elsif !failed.empty?
569
+ raise Errors::BatchSendError.new(sent, failed) unless failed.empty?
570
+ elsif !checksum_failed.empty?
571
+ raise Errors::ChecksumError.new(checksum_failed)
572
+ end
573
+
574
+ sent
575
+
576
+ end
577
+
578
+ # @param [ReceivedMessage,String] messages A list of up to 10 messages
579
+ # to delete. Each message should be a {ReceivedMessage} object
580
+ # or a received message handle (string).
581
+ #
582
+ # @raise [Errors::BatchDeleteSend] Raised when one or more of the
583
+ # messages failed to delete. The raised error has a list
584
+ # of the failures.
585
+ #
586
+ # @return [nil]
587
+ #
588
+ def batch_delete *messages
589
+
590
+ entries = []
591
+ messages.flatten.each_with_index do |msg,n|
592
+ handle = msg.is_a?(ReceivedMessage) ? msg.handle : msg
593
+ entries << { :id => n.to_s, :receipt_handle => handle }
594
+ end
595
+
596
+ response = client.delete_message_batch(
597
+ :queue_url => url, :entries => entries)
598
+
599
+ failures = batch_failures(entries, response)
600
+
601
+ raise Errors::BatchDeleteError.new(failures) unless failures.empty?
602
+
603
+ nil
604
+
605
+ end
606
+
607
+ # @overload batch_change_visibility(visibility_timeout, *messages)
608
+ #
609
+ # Accepts a single `:visibility_timeout` value and a list of
610
+ # messages ({ReceivedMessage} objects or receipt handle strings).
611
+ # This form of the method is useful when you want to set the same
612
+ # timeout value for each message.
613
+ #
614
+ # queue.batch_change_visibility(10, messages)
615
+ #
616
+ # @param [Integer] visibility_timeout The new value for the message's
617
+ # visibility timeout (in seconds).
618
+ #
619
+ # @param [ReceivedMessage,String] message A list of up to 10 messages
620
+ # to change the visibility timeout for.
621
+ #
622
+ # @raise [BatchChangeVisibilityError] Raises this error when one
623
+ # or more of the messages failed the visibility update.
624
+ #
625
+ # @return [nil]
626
+ #
627
+ # @overload batch_change_visibility(*messages_with_timeouts)
628
+ #
629
+ # Accepts a list of hashes. Each hash should provide the visibility
630
+ # timeout and message (a {ReceivedMessage} object or the recipt handle
631
+ # string).
632
+ #
633
+ # Use this form when each message needs a different visiblity timeout.
634
+ #
635
+ # messages = []
636
+ # messages << { :message => 'handle1', :visibility_timeout => 5 }
637
+ # messages << { :message => 'handle2', :visibility_timeout => 10 }
638
+ #
639
+ # queue.batch_change_visibility(*messages)
640
+ #
641
+ # @param [Hash] message A list hashes, each with a `:visibility_timeout`
642
+ # and a `:message`.
643
+ #
644
+ # @raise [BatchChangeVisibilityError] Raises this error when one
645
+ # or more of the messages failed the visibility update.
646
+ #
647
+ # @return [nil]
648
+ #
649
+ def batch_change_visibility *args
650
+
651
+ args = args.flatten
652
+
653
+ if args.first.is_a?(Integer)
654
+ timeout = args.shift
655
+ messages = args.collect{|m| [m, timeout] }
656
+ else
657
+ messages = args.collect{|m| [m[:message], m[:visibility_timeout]] }
658
+ end
659
+
660
+ entries = []
661
+ messages.each do |msg,timeout|
662
+ handle = msg.is_a?(ReceivedMessage) ? msg.handle : msg
663
+ entries << {
664
+ :id => entries.size.to_s,
665
+ :receipt_handle => handle,
666
+ :visibility_timeout => timeout,
667
+ }
668
+ end
669
+
670
+ response = client.change_message_visibility_batch(
671
+ :queue_url => url, :entries => entries)
672
+
673
+ failures = batch_failures(entries, response)
674
+
675
+ raise Errors::BatchChangeVisibilityError.new(failures) unless
676
+ failures.empty?
677
+
678
+ nil
679
+
680
+ end
681
+
682
+ # @return [Boolean] Returns true if the other queue has the same
683
+ # url.
684
+ def ==(other)
685
+ other.kind_of?(Queue) and other.url == url
686
+ end
687
+ alias_method :eql?, :==
688
+
689
+ # @api private
690
+ def inspect
691
+ "<#{self.class}:#{url}>"
692
+ end
693
+
694
+ protected
695
+ def batch_failures entries, response, include_batch_index=false
696
+ response[:failed].inject([]) do |failures, failure|
697
+
698
+ entry = entries.find{|e| e[:id] == failure[:id] }
699
+
700
+ details = {
701
+ :error_code => failure[:code],
702
+ :error_message => failure[:message],
703
+ :sender_fault => failure[:sender_fault],
704
+ }
705
+
706
+ if include_batch_index
707
+ details[:batch_index] = failure[:id].to_i
708
+ end
709
+
710
+ if message_body = entry[:message_body]
711
+ details[:message_body] = message_body
712
+ end
713
+
714
+ if handle = entry[:receipt_handle]
715
+ details[:receipt_handle] = handle
716
+ end
717
+
718
+ failures << details
719
+
720
+ end
721
+ end
722
+
723
+ # @api private
724
+ protected
725
+ def hit_timeout?(got_first, last_message_at, opts)
726
+ initial_timeout = opts[:initial_timeout]
727
+ idle_timeout = opts[:idle_timeout]
728
+
729
+ timeout = (got_first ||
730
+ # if initial_timeout is false (as opposed
731
+ # to nil) then we skip the branch and poll
732
+ # indefinitely until the first message
733
+ # comes
734
+ (!initial_timeout && initial_timeout != false) ?
735
+ idle_timeout :
736
+ initial_timeout) and
737
+ Time.now - last_message_at > timeout
738
+ end
739
+
740
+ # @api private
741
+ protected
742
+ def receive_opts(opts)
743
+ receive_opts = { :queue_url => url }
744
+ receive_opts[:visibility_timeout] = opts[:visibility_timeout] if
745
+ opts[:visibility_timeout]
746
+ receive_opts[:max_number_of_messages] = opts[:limit] if
747
+ opts[:limit]
748
+ receive_opts[:wait_time_seconds] = opts[:wait_time_seconds] if
749
+ opts[:wait_time_seconds]
750
+ receive_opts[:message_attribute_names] = opts[:message_attribute_names] if
751
+ opts[:message_attribute_names]
752
+
753
+ if names = opts[:attributes]
754
+ receive_opts[:attribute_names] = names.map do |name|
755
+ name = ReceivedMessage::ATTRIBUTE_ALIASES[name.to_sym] if
756
+ ReceivedMessage::ATTRIBUTE_ALIASES.key?(name.to_sym)
757
+ name = Core::Inflection.class_name(name.to_s) if name.kind_of?(Symbol)
758
+ name
759
+ end
760
+ end
761
+
762
+ receive_opts
763
+ end
764
+
765
+ # @api private
766
+ protected
767
+ def call_message_block(messages, block)
768
+ result = nil
769
+ messages.each do |message|
770
+ begin
771
+ result = block.call(message)
772
+ rescue Exception => e
773
+ raise
774
+ else
775
+ message.delete
776
+ end
777
+ end
778
+ result
779
+ end
780
+
781
+ # @api private
782
+ protected
783
+ def get_attribute(name)
784
+ resp = client.get_queue_attributes(:queue_url => url,
785
+ :attribute_names =>
786
+ [name, "QueueArn"].uniq)
787
+ @arn ||= resp.attributes["QueueArn"]
788
+ resp.attributes[name]
789
+ end
790
+
791
+ # @api private
792
+ protected
793
+ def set_attribute(name, value)
794
+ client.set_queue_attributes({
795
+ :queue_url => url,
796
+ :attributes => { name => value },
797
+ })
798
+ end
799
+
800
+ # @api private
801
+ protected
802
+ def is_checksum_valid checksum, data
803
+ if config.sqs_verify_checksums?
804
+ calculate_checksum(data) == checksum
805
+ else
806
+ true
807
+ end
808
+ end
809
+
810
+ # @api private
811
+ protected
812
+ def calculate_checksum data
813
+ Digest::MD5.hexdigest data
814
+ end
815
+
816
+ # @api private
817
+ protected
818
+ def verify_send_message_checksum body, md5
819
+ unless is_checksum_valid md5, body
820
+ raise Errors::ChecksumError.new "Invalid MD5 #{md5} for message body #{body}"
821
+ end
822
+ end
823
+
824
+ # @api private
825
+ protected
826
+ def verify_send_message_batch_checksum entries, response
827
+ failed = []
828
+
829
+ response[:successful].each do |msg|
830
+ entry = entries.find{ |e| e[:id] == msg[:id] }
831
+ failed << msg unless is_checksum_valid msg[:md5_of_message_body], entry[:message_body]
832
+ end
833
+
834
+ failed
835
+ end
836
+
837
+ # @api private
838
+ protected
839
+ def verify_receive_message_checksum response
840
+ return [] if response[:messages].nil?
841
+
842
+ invalid_msgs = []
843
+
844
+ response[:messages].each do |msg|
845
+ md5 = msg[:md5_of_body]
846
+ body = msg[:body]
847
+ invalid_msgs << msg unless is_checksum_valid md5, body
848
+ end
849
+
850
+ invalid_msgs
851
+ end
852
+
853
+ end
854
+
855
+ end
856
+ end