aws-sdk 1.8.5 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.yardopts +1 -0
- data/README.rdoc +8 -0
- data/lib/aws-sdk.rb +39 -35
- data/lib/aws/api_config/CloudFront-2012-07-01.yml +2398 -0
- data/lib/aws/api_config/DirectConnect-2012-10-25.yml +475 -0
- data/lib/aws/api_config/DynamoDB-2011-12-05.yml +8 -0
- data/lib/aws/api_config/DynamoDB-2012-08-10.yml +1516 -0
- data/lib/aws/api_config/OpsWorks-2013-02-18.yml +2 -2
- data/lib/aws/auto_scaling.rb +44 -44
- data/lib/aws/auto_scaling/activity.rb +1 -1
- data/lib/aws/auto_scaling/activity_collection.rb +14 -15
- data/lib/aws/auto_scaling/client.rb +277 -277
- data/lib/aws/auto_scaling/config.rb +1 -1
- data/lib/aws/auto_scaling/group.rb +35 -36
- data/lib/aws/auto_scaling/group_collection.rb +10 -10
- data/lib/aws/auto_scaling/group_options.rb +19 -19
- data/lib/aws/auto_scaling/instance.rb +27 -27
- data/lib/aws/auto_scaling/instance_collection.rb +10 -10
- data/lib/aws/auto_scaling/launch_configuration.rb +3 -3
- data/lib/aws/auto_scaling/launch_configuration_collection.rb +1 -1
- data/lib/aws/auto_scaling/notification_configuration.rb +2 -2
- data/lib/aws/auto_scaling/notification_configuration_collection.rb +37 -38
- data/lib/aws/auto_scaling/scaling_policy.rb +3 -3
- data/lib/aws/auto_scaling/scaling_policy_collection.rb +6 -6
- data/lib/aws/auto_scaling/scaling_policy_options.rb +8 -7
- data/lib/aws/auto_scaling/scheduled_action.rb +3 -3
- data/lib/aws/auto_scaling/scheduled_action_collection.rb +28 -28
- data/lib/aws/auto_scaling/tag_collection.rb +30 -28
- data/lib/aws/cloud_formation.rb +95 -94
- data/lib/aws/cloud_formation/client.rb +136 -133
- data/lib/aws/cloud_formation/config.rb +1 -1
- data/lib/aws/cloud_formation/stack.rb +37 -37
- data/lib/aws/cloud_formation/stack_collection.rb +28 -27
- data/lib/aws/cloud_formation/stack_event.rb +9 -11
- data/lib/aws/cloud_formation/stack_output.rb +1 -1
- data/lib/aws/cloud_formation/stack_resource.rb +6 -6
- data/lib/aws/cloud_formation/stack_resource_collection.rb +11 -12
- data/lib/aws/cloud_formation/stack_resource_summary_collection.rb +11 -11
- data/lib/aws/cloud_formation/stack_summary_collection.rb +39 -39
- data/lib/aws/cloud_front.rb +21 -21
- data/lib/aws/cloud_front/client.rb +853 -652
- data/lib/aws/cloud_front/request.rb +3 -0
- data/lib/aws/cloud_search.rb +22 -22
- data/lib/aws/cloud_search/client.rb +322 -315
- data/lib/aws/cloud_search/config.rb +1 -1
- data/lib/aws/cloud_watch.rb +39 -39
- data/lib/aws/cloud_watch/alarm.rb +55 -37
- data/lib/aws/cloud_watch/alarm_collection.rb +18 -18
- data/lib/aws/cloud_watch/alarm_history_item_collection.rb +2 -2
- data/lib/aws/cloud_watch/client.rb +360 -146
- data/lib/aws/cloud_watch/config.rb +1 -1
- data/lib/aws/cloud_watch/metric.rb +15 -15
- data/lib/aws/cloud_watch/metric_alarm_collection.rb +17 -17
- data/lib/aws/cloud_watch/metric_collection.rb +16 -16
- data/lib/aws/cloud_watch/metric_statistics.rb +11 -11
- data/lib/aws/core.rb +243 -225
- data/lib/aws/core/async_handle.rb +13 -13
- data/lib/aws/core/cacheable.rb +14 -15
- data/lib/aws/core/client.rb +40 -15
- data/lib/aws/core/collection.rb +42 -46
- data/lib/aws/core/collection/with_limit_and_next_token.rb +1 -1
- data/lib/aws/core/collection/with_next_token.rb +1 -1
- data/lib/aws/core/configuration.rb +97 -133
- data/lib/aws/core/credential_providers.rb +16 -16
- data/lib/aws/core/data.rb +23 -23
- data/lib/aws/core/http/connection_pool.rb +348 -0
- data/lib/aws/core/http/net_http_handler.rb +17 -26
- data/lib/aws/core/http/patch.rb +102 -0
- data/lib/aws/core/http/request.rb +13 -19
- data/lib/aws/core/http/response.rb +2 -2
- data/lib/aws/core/lazy_error_classes.rb +17 -17
- data/lib/aws/core/log_formatter.rb +70 -104
- data/lib/aws/core/options/json_serializer.rb +1 -1
- data/lib/aws/core/options/validator.rb +4 -4
- data/lib/aws/core/page_result.rb +8 -8
- data/lib/aws/core/policy.rb +49 -49
- data/lib/aws/core/region.rb +72 -0
- data/lib/aws/core/region_collection.rb +106 -0
- data/lib/aws/core/resource.rb +5 -5
- data/lib/aws/core/response.rb +20 -17
- data/lib/aws/core/rest_request_builder.rb +4 -4
- data/lib/aws/core/service_interface.rb +24 -2
- data/lib/aws/core/signature/version_3.rb +2 -2
- data/lib/aws/core/uri_escape.rb +1 -1
- data/lib/aws/core/xml/frame_stack.rb +1 -1
- data/lib/aws/core/xml/grammar.rb +3 -4
- data/lib/aws/core/xml/sax_handlers/libxml.rb +2 -2
- data/lib/aws/core/xml/sax_handlers/nokogiri.rb +3 -3
- data/lib/aws/core/xml/sax_handlers/rexml.rb +5 -5
- data/lib/aws/core/xml/stub.rb +9 -9
- data/lib/aws/data_pipeline.rb +21 -21
- data/lib/aws/data_pipeline/client.rb +189 -133
- data/lib/aws/data_pipeline/config.rb +1 -1
- data/lib/aws/direct_connect.rb +74 -0
- data/lib/aws/direct_connect/client.rb +253 -0
- data/lib/aws/direct_connect/config.rb +18 -0
- data/lib/aws/direct_connect/errors.rb +22 -0
- data/lib/aws/direct_connect/request.rb +27 -0
- data/lib/aws/dynamo_db.rb +71 -69
- data/lib/aws/dynamo_db/attribute_collection.rb +53 -58
- data/lib/aws/dynamo_db/batch_get.rb +23 -23
- data/lib/aws/dynamo_db/batch_write.rb +43 -43
- data/lib/aws/dynamo_db/binary.rb +9 -9
- data/lib/aws/dynamo_db/client.rb +494 -509
- data/lib/aws/dynamo_db/client_base.rb +91 -0
- data/lib/aws/dynamo_db/client_v2.rb +825 -0
- data/lib/aws/dynamo_db/config.rb +1 -1
- data/lib/aws/dynamo_db/item.rb +10 -10
- data/lib/aws/dynamo_db/item_collection.rb +75 -75
- data/lib/aws/dynamo_db/table.rb +85 -85
- data/lib/aws/dynamo_db/table_collection.rb +13 -13
- data/lib/aws/ec2.rb +132 -142
- data/lib/aws/ec2/attachment.rb +31 -36
- data/lib/aws/ec2/attachment_collection.rb +1 -1
- data/lib/aws/ec2/availability_zone.rb +4 -4
- data/lib/aws/ec2/client.rb +2272 -2125
- data/lib/aws/ec2/config.rb +1 -1
- data/lib/aws/ec2/customer_gateway.rb +6 -6
- data/lib/aws/ec2/customer_gateway_collection.rb +6 -6
- data/lib/aws/ec2/dhcp_options.rb +3 -3
- data/lib/aws/ec2/dhcp_options_collection.rb +10 -10
- data/lib/aws/ec2/elastic_ip.rb +15 -15
- data/lib/aws/ec2/elastic_ip_collection.rb +11 -15
- data/lib/aws/ec2/export_task.rb +4 -4
- data/lib/aws/ec2/export_task_collection.rb +11 -11
- data/lib/aws/ec2/filtered_collection.rb +6 -8
- data/lib/aws/ec2/image.rb +46 -40
- data/lib/aws/ec2/image_collection.rb +44 -52
- data/lib/aws/ec2/instance.rb +64 -62
- data/lib/aws/ec2/instance_collection.rb +47 -50
- data/lib/aws/ec2/internet_gateway.rb +6 -6
- data/lib/aws/ec2/internet_gateway/attachment.rb +13 -13
- data/lib/aws/ec2/internet_gateway_collection.rb +3 -3
- data/lib/aws/ec2/key_pair.rb +3 -3
- data/lib/aws/ec2/key_pair_collection.rb +12 -12
- data/lib/aws/ec2/network_acl.rb +39 -39
- data/lib/aws/ec2/network_acl/association.rb +2 -2
- data/lib/aws/ec2/network_acl/entry.rb +22 -22
- data/lib/aws/ec2/network_acl_collection.rb +2 -2
- data/lib/aws/ec2/network_interface.rb +13 -4
- data/lib/aws/ec2/network_interface/attachment.rb +3 -3
- data/lib/aws/ec2/network_interface_collection.rb +5 -5
- data/lib/aws/ec2/permission_collection.rb +1 -1
- data/lib/aws/ec2/region.rb +6 -6
- data/lib/aws/ec2/region_collection.rb +1 -1
- data/lib/aws/ec2/reserved_instances_collection.rb +2 -2
- data/lib/aws/ec2/reserved_instances_offering_collection.rb +2 -2
- data/lib/aws/ec2/resource_tag_collection.rb +5 -5
- data/lib/aws/ec2/route_table.rb +14 -14
- data/lib/aws/ec2/route_table/association.rb +22 -22
- data/lib/aws/ec2/route_table/route.rb +8 -8
- data/lib/aws/ec2/route_table_collection.rb +3 -3
- data/lib/aws/ec2/security_group.rb +39 -41
- data/lib/aws/ec2/security_group_collection.rb +19 -21
- data/lib/aws/ec2/snapshot.rb +3 -3
- data/lib/aws/ec2/snapshot_collection.rb +11 -12
- data/lib/aws/ec2/subnet.rb +2 -2
- data/lib/aws/ec2/subnet_collection.rb +17 -17
- data/lib/aws/ec2/tag_collection.rb +1 -1
- data/lib/aws/ec2/tagged_collection.rb +7 -7
- data/lib/aws/ec2/tagged_item.rb +10 -10
- data/lib/aws/ec2/volume.rb +16 -16
- data/lib/aws/ec2/volume_collection.rb +9 -12
- data/lib/aws/ec2/vpc.rb +6 -6
- data/lib/aws/ec2/vpc_collection.rb +10 -10
- data/lib/aws/ec2/vpn_connection.rb +4 -4
- data/lib/aws/ec2/vpn_connection/telemetry.rb +1 -1
- data/lib/aws/ec2/vpn_connection_collection.rb +6 -6
- data/lib/aws/ec2/vpn_gateway.rb +2 -2
- data/lib/aws/ec2/vpn_gateway_collection.rb +5 -5
- data/lib/aws/elastic_beanstalk.rb +12 -12
- data/lib/aws/elastic_beanstalk/client.rb +376 -368
- data/lib/aws/elastic_beanstalk/config.rb +1 -1
- data/lib/aws/elastic_transcoder.rb +5 -5
- data/lib/aws/elastic_transcoder/client.rb +283 -283
- data/lib/aws/elastic_transcoder/config.rb +1 -1
- data/lib/aws/elasticache.rb +12 -12
- data/lib/aws/elasticache/client.rb +484 -479
- data/lib/aws/elasticache/config.rb +1 -1
- data/lib/aws/elb.rb +23 -23
- data/lib/aws/elb/availability_zone_collection.rb +34 -34
- data/lib/aws/elb/backend_server_policy_collection.rb +24 -24
- data/lib/aws/elb/client.rb +153 -153
- data/lib/aws/elb/config.rb +1 -1
- data/lib/aws/elb/errors.rb +1 -1
- data/lib/aws/elb/instance_collection.rb +20 -25
- data/lib/aws/elb/listener.rb +3 -3
- data/lib/aws/elb/listener_collection.rb +8 -8
- data/lib/aws/elb/load_balancer.rb +15 -16
- data/lib/aws/elb/load_balancer_collection.rb +36 -24
- data/lib/aws/elb/load_balancer_policy.rb +1 -1
- data/lib/aws/elb/load_balancer_policy_collection.rb +5 -5
- data/lib/aws/emr.rb +28 -26
- data/lib/aws/emr/client.rb +165 -149
- data/lib/aws/emr/config.rb +1 -1
- data/lib/aws/emr/instance_group.rb +1 -1
- data/lib/aws/emr/instance_group_collection.rb +1 -1
- data/lib/aws/emr/job_flow.rb +27 -26
- data/lib/aws/emr/job_flow_collection.rb +34 -34
- data/lib/aws/errors.rb +7 -7
- data/lib/aws/glacier.rb +21 -21
- data/lib/aws/glacier/archive_collection.rb +2 -2
- data/lib/aws/glacier/client.rb +139 -140
- data/lib/aws/glacier/config.rb +1 -1
- data/lib/aws/glacier/vault.rb +2 -2
- data/lib/aws/glacier/vault_collection.rb +1 -1
- data/lib/aws/iam.rb +133 -144
- data/lib/aws/iam/access_key.rb +17 -17
- data/lib/aws/iam/access_key_collection.rb +22 -22
- data/lib/aws/iam/account_alias_collection.rb +2 -2
- data/lib/aws/iam/client.rb +429 -420
- data/lib/aws/iam/collection.rb +1 -1
- data/lib/aws/iam/config.rb +2 -2
- data/lib/aws/iam/group.rb +8 -8
- data/lib/aws/iam/group_collection.rb +16 -16
- data/lib/aws/iam/group_policy_collection.rb +6 -6
- data/lib/aws/iam/group_user_collection.rb +3 -3
- data/lib/aws/iam/mfa_device.rb +1 -1
- data/lib/aws/iam/mfa_device_collection.rb +9 -9
- data/lib/aws/iam/policy_collection.rb +4 -4
- data/lib/aws/iam/resource.rb +2 -2
- data/lib/aws/iam/server_certificate.rb +1 -1
- data/lib/aws/iam/server_certificate_collection.rb +15 -15
- data/lib/aws/iam/signing_certificate.rb +29 -29
- data/lib/aws/iam/signing_certificate_collection.rb +23 -23
- data/lib/aws/iam/user.rb +33 -38
- data/lib/aws/iam/user_collection.rb +27 -27
- data/lib/aws/iam/user_group_collection.rb +3 -3
- data/lib/aws/iam/user_policy_collection.rb +6 -6
- data/lib/aws/iam/virtual_mfa_device.rb +12 -12
- data/lib/aws/iam/virtual_mfa_device_collection.rb +4 -4
- data/lib/aws/import_export.rb +22 -21
- data/lib/aws/import_export/client.rb +47 -43
- data/lib/aws/ops_works.rb +5 -5
- data/lib/aws/ops_works/client.rb +484 -438
- data/lib/aws/ops_works/config.rb +1 -1
- data/lib/aws/rails.rb +34 -34
- data/lib/aws/rds.rb +18 -18
- data/lib/aws/rds/client.rb +1286 -1277
- data/lib/aws/rds/config.rb +1 -1
- data/lib/aws/rds/db_instance.rb +15 -4
- data/lib/aws/rds/db_snapshot.rb +1 -1
- data/lib/aws/record.rb +50 -24
- data/lib/aws/record/abstract_base.rb +52 -60
- data/lib/aws/record/attributes.rb +79 -79
- data/lib/aws/record/conversion.rb +1 -1
- data/lib/aws/record/dirty_tracking.rb +69 -67
- data/lib/aws/record/errors.rb +21 -21
- data/lib/aws/record/exceptions.rb +2 -2
- data/lib/aws/record/hash_model.rb +20 -21
- data/lib/aws/record/hash_model/attributes.rb +13 -15
- data/lib/aws/record/hash_model/finder_methods.rb +46 -46
- data/lib/aws/record/hash_model/scope.rb +31 -31
- data/lib/aws/record/model.rb +136 -136
- data/lib/aws/record/model/attributes.rb +57 -59
- data/lib/aws/record/model/finder_methods.rb +67 -67
- data/lib/aws/record/model/scope.rb +48 -49
- data/lib/aws/record/naming.rb +1 -1
- data/lib/aws/record/scope.rb +23 -19
- data/lib/aws/record/validations.rb +253 -271
- data/lib/aws/record/validator.rb +3 -3
- data/lib/aws/record/validators/acceptance.rb +1 -3
- data/lib/aws/record/validators/block.rb +1 -3
- data/lib/aws/record/validators/confirmation.rb +1 -3
- data/lib/aws/record/validators/count.rb +2 -4
- data/lib/aws/record/validators/exclusion.rb +2 -4
- data/lib/aws/record/validators/format.rb +2 -4
- data/lib/aws/record/validators/inclusion.rb +1 -3
- data/lib/aws/record/validators/length.rb +5 -7
- data/lib/aws/record/validators/method.rb +1 -3
- data/lib/aws/record/validators/numericality.rb +6 -8
- data/lib/aws/record/validators/presence.rb +1 -3
- data/lib/aws/redshift.rb +14 -14
- data/lib/aws/redshift/client.rb +596 -592
- data/lib/aws/redshift/config.rb +1 -1
- data/lib/aws/route_53.rb +30 -30
- data/lib/aws/route_53/change_batch.rb +7 -7
- data/lib/aws/route_53/client.rb +188 -152
- data/lib/aws/route_53/hosted_zone.rb +4 -4
- data/lib/aws/route_53/hosted_zone_collection.rb +7 -7
- data/lib/aws/route_53/resource_record_set.rb +10 -10
- data/lib/aws/route_53/resource_record_set_collection.rb +6 -6
- data/lib/aws/s3.rb +79 -79
- data/lib/aws/s3/access_control_list.rb +44 -36
- data/lib/aws/s3/acl_options.rb +51 -51
- data/lib/aws/s3/bucket.rb +146 -146
- data/lib/aws/s3/bucket_collection.rb +21 -21
- data/lib/aws/s3/bucket_lifecycle_configuration.rb +81 -82
- data/lib/aws/s3/bucket_tag_collection.rb +4 -2
- data/lib/aws/s3/cipher_io.rb +5 -4
- data/lib/aws/s3/client.rb +89 -84
- data/lib/aws/s3/client/xml.rb +1 -1
- data/lib/aws/s3/config.rb +7 -1
- data/lib/aws/s3/cors_rule.rb +2 -0
- data/lib/aws/s3/cors_rule_collection.rb +42 -40
- data/lib/aws/s3/data_options.rb +16 -11
- data/lib/aws/s3/encryption_utils.rb +2 -2
- data/lib/aws/s3/errors.rb +7 -7
- data/lib/aws/s3/multipart_upload.rb +30 -33
- data/lib/aws/s3/multipart_upload_collection.rb +8 -6
- data/lib/aws/s3/object_collection.rb +35 -35
- data/lib/aws/s3/object_metadata.rb +6 -6
- data/lib/aws/s3/object_version.rb +4 -4
- data/lib/aws/s3/object_version_collection.rb +15 -15
- data/lib/aws/s3/policy.rb +2 -2
- data/lib/aws/s3/prefixed_collection.rb +9 -5
- data/lib/aws/s3/presigned_post.rb +39 -37
- data/lib/aws/s3/request.rb +11 -11
- data/lib/aws/s3/s3_object.rb +210 -200
- data/lib/aws/s3/tree.rb +25 -27
- data/lib/aws/s3/tree/child_collection.rb +3 -3
- data/lib/aws/s3/tree/leaf_node.rb +2 -2
- data/lib/aws/s3/tree/parent.rb +1 -1
- data/lib/aws/s3/website_configuration.rb +13 -13
- data/lib/aws/simple_db.rb +83 -83
- data/lib/aws/simple_db/attribute.rb +9 -7
- data/lib/aws/simple_db/attribute_collection.rb +22 -13
- data/lib/aws/simple_db/client.rb +107 -107
- data/lib/aws/simple_db/config.rb +7 -1
- data/lib/aws/simple_db/consistent_read_option.rb +5 -5
- data/lib/aws/simple_db/domain.rb +4 -2
- data/lib/aws/simple_db/domain_collection.rb +4 -4
- data/lib/aws/simple_db/domain_metadata.rb +5 -5
- data/lib/aws/simple_db/errors.rb +9 -9
- data/lib/aws/simple_db/item.rb +5 -5
- data/lib/aws/simple_db/item_collection.rb +83 -81
- data/lib/aws/simple_db/item_data.rb +4 -4
- data/lib/aws/simple_db/put_attributes.rb +3 -3
- data/lib/aws/simple_email_service.rb +140 -140
- data/lib/aws/simple_email_service/client.rb +82 -76
- data/lib/aws/simple_email_service/config.rb +1 -2
- data/lib/aws/simple_email_service/email_address_collection.rb +3 -3
- data/lib/aws/simple_email_service/identity.rb +8 -8
- data/lib/aws/simple_email_service/quotas.rb +8 -6
- data/lib/aws/simple_workflow.rb +106 -106
- data/lib/aws/simple_workflow/activity_task.rb +15 -22
- data/lib/aws/simple_workflow/activity_task_collection.rb +15 -15
- data/lib/aws/simple_workflow/activity_type.rb +23 -23
- data/lib/aws/simple_workflow/activity_type_collection.rb +23 -23
- data/lib/aws/simple_workflow/client.rb +1004 -956
- data/lib/aws/simple_workflow/config.rb +1 -1
- data/lib/aws/simple_workflow/count.rb +5 -5
- data/lib/aws/simple_workflow/decision_task.rb +129 -129
- data/lib/aws/simple_workflow/decision_task_collection.rb +59 -59
- data/lib/aws/simple_workflow/domain.rb +11 -11
- data/lib/aws/simple_workflow/domain_collection.rb +26 -26
- data/lib/aws/simple_workflow/history_event.rb +32 -32
- data/lib/aws/simple_workflow/history_event_collection.rb +3 -3
- data/lib/aws/simple_workflow/option_formatters.rb +5 -5
- data/lib/aws/simple_workflow/request.rb +1 -1
- data/lib/aws/simple_workflow/resource.rb +1 -1
- data/lib/aws/simple_workflow/type.rb +8 -8
- data/lib/aws/simple_workflow/type_collection.rb +15 -15
- data/lib/aws/simple_workflow/workflow_execution.rb +70 -72
- data/lib/aws/simple_workflow/workflow_execution_collection.rb +130 -130
- data/lib/aws/simple_workflow/workflow_type.rb +27 -25
- data/lib/aws/simple_workflow/workflow_type_collection.rb +20 -20
- data/lib/aws/sns.rb +25 -25
- data/lib/aws/sns/client.rb +55 -55
- data/lib/aws/sns/config.rb +1 -1
- data/lib/aws/sns/policy.rb +1 -1
- data/lib/aws/sns/subscription.rb +7 -7
- data/lib/aws/sns/subscription_collection.rb +5 -5
- data/lib/aws/sns/topic.rb +49 -49
- data/lib/aws/sns/topic_collection.rb +2 -2
- data/lib/aws/sns/topic_subscription_collection.rb +5 -5
- data/lib/aws/sqs.rb +20 -20
- data/lib/aws/sqs/client.rb +78 -78
- data/lib/aws/sqs/config.rb +1 -1
- data/lib/aws/sqs/errors.rb +12 -12
- data/lib/aws/sqs/queue.rb +66 -67
- data/lib/aws/sqs/queue_collection.rb +16 -8
- data/lib/aws/sqs/received_message.rb +7 -6
- data/lib/aws/storage_gateway.rb +21 -21
- data/lib/aws/storage_gateway/client.rb +269 -202
- data/lib/aws/storage_gateway/config.rb +1 -1
- data/lib/aws/sts.rb +10 -8
- data/lib/aws/sts/client.rb +35 -35
- data/lib/aws/sts/session.rb +3 -3
- data/lib/aws/version.rb +1 -2
- metadata +23 -21
- data/lib/aws/core/autoloader.rb +0 -64
- data/lib/net/http/connection_pool.rb +0 -226
- data/lib/net/http/connection_pool/connection.rb +0 -189
- data/lib/net/http/connection_pool/session.rb +0 -126
data/lib/aws/sns/config.rb
CHANGED
data/lib/aws/sns/policy.rb
CHANGED
data/lib/aws/sns/subscription.rb
CHANGED
|
@@ -42,11 +42,11 @@ module AWS
|
|
|
42
42
|
|
|
43
43
|
# @return [String] The protocol. Possible values:
|
|
44
44
|
#
|
|
45
|
-
# *
|
|
46
|
-
# *
|
|
47
|
-
# *
|
|
48
|
-
# *
|
|
49
|
-
# *
|
|
45
|
+
# * `:http`
|
|
46
|
+
# * `:https`
|
|
47
|
+
# * `:email`
|
|
48
|
+
# * `:email_json`
|
|
49
|
+
# * `:sqs`
|
|
50
50
|
attr_reader :protocol
|
|
51
51
|
|
|
52
52
|
# @return [String] The AWS account ID of the subscription owner.
|
|
@@ -61,7 +61,7 @@ module AWS
|
|
|
61
61
|
|
|
62
62
|
# @return [Topic]
|
|
63
63
|
def topic
|
|
64
|
-
Topic.new(topic_arn, :config => config)
|
|
64
|
+
Topic.new(topic_arn, :config => config)
|
|
65
65
|
end
|
|
66
66
|
|
|
67
67
|
# Deletes this subscription.
|
|
@@ -71,7 +71,7 @@ module AWS
|
|
|
71
71
|
nil
|
|
72
72
|
end
|
|
73
73
|
|
|
74
|
-
# @return [Boolean] Returns true if the subscription confirmation
|
|
74
|
+
# @return [Boolean] Returns true if the subscription confirmation
|
|
75
75
|
# request was authenticated.
|
|
76
76
|
def confirmation_authenticated?
|
|
77
77
|
|
|
@@ -17,11 +17,11 @@ module AWS
|
|
|
17
17
|
# Represents the collection of all subscriptions for the AWS
|
|
18
18
|
# account. For example:
|
|
19
19
|
#
|
|
20
|
-
#
|
|
21
|
-
#
|
|
22
|
-
#
|
|
23
|
-
#
|
|
24
|
-
#
|
|
20
|
+
# # get the ARNs of all SQS queues with subscriptions to topics
|
|
21
|
+
# # owned by this account
|
|
22
|
+
# topic.subscriptions.
|
|
23
|
+
# select { |s| s.protocol == :sqs }.
|
|
24
|
+
# collect(&:endpoint)
|
|
25
25
|
#
|
|
26
26
|
class SubscriptionCollection
|
|
27
27
|
|
data/lib/aws/sns/topic.rb
CHANGED
|
@@ -30,20 +30,20 @@ module AWS
|
|
|
30
30
|
# @return [String] The topic ARN.
|
|
31
31
|
attr_reader :arn
|
|
32
32
|
|
|
33
|
-
# The topic name.
|
|
33
|
+
# The topic name.
|
|
34
34
|
#
|
|
35
|
-
# If you have not set a display name (see {#display_name=}) then
|
|
36
|
-
# this is used as the "From" field for notifications to email and
|
|
37
|
-
# email-json endpoints.
|
|
38
|
-
# @return [String] Returns the toipc name.
|
|
35
|
+
# If you have not set a display name (see {#display_name=}) then
|
|
36
|
+
# this is used as the "From" field for notifications to email and
|
|
37
|
+
# email-json endpoints.
|
|
38
|
+
# @return [String] Returns the toipc name.
|
|
39
39
|
def name
|
|
40
40
|
arn.split(/:/)[-1]
|
|
41
41
|
end
|
|
42
42
|
|
|
43
|
-
# Causes the given
|
|
43
|
+
# Causes the given `endpoint` to receive messages published to this
|
|
44
44
|
# topic.
|
|
45
45
|
#
|
|
46
|
-
#
|
|
46
|
+
# ## Subscribing to SQS Queues
|
|
47
47
|
#
|
|
48
48
|
# If you subscribe to an SQS queue (with a {SQS::Queue} object}
|
|
49
49
|
# then a policy will be added/updated to the queue that will
|
|
@@ -52,7 +52,7 @@ module AWS
|
|
|
52
52
|
# * If you subscribe with a queue by ARN then you must change the
|
|
53
53
|
# policy yourself.
|
|
54
54
|
#
|
|
55
|
-
# * If you do not want the policy modified then pass
|
|
55
|
+
# * If you do not want the policy modified then pass `:update_policy`
|
|
56
56
|
# as false or just pass the queue's arn
|
|
57
57
|
#
|
|
58
58
|
# topic.subscribe(queue.arn)
|
|
@@ -62,7 +62,7 @@ module AWS
|
|
|
62
62
|
#
|
|
63
63
|
# topic.subscribe('http://example.com/messages')
|
|
64
64
|
# topic.subscribe('https://example.com/messages')
|
|
65
|
-
#
|
|
65
|
+
#
|
|
66
66
|
# @example Using a uri object to set the endpoint (http and https)
|
|
67
67
|
#
|
|
68
68
|
# topic.subscribe(URI.parse('http://example.com/messages'))
|
|
@@ -81,17 +81,17 @@ module AWS
|
|
|
81
81
|
#
|
|
82
82
|
# # you must manage the queue policy yourself to allow the
|
|
83
83
|
# # the topic to send messages (policy action 'sqs:SendMessage')
|
|
84
|
-
# topic.subscribe('arn:aws:sqs:us-
|
|
84
|
+
# topic.subscribe('arn:aws:sqs:us-west-2:123456789123:AQueue')
|
|
85
85
|
#
|
|
86
86
|
# @example SQS Queue (by Queue object)
|
|
87
87
|
#
|
|
88
88
|
# # the queue policy will be added/updated to allow the topic
|
|
89
89
|
# # to send it messages
|
|
90
90
|
# topic.subscribe(AWS::SQS.new.queues.first)
|
|
91
|
-
#
|
|
91
|
+
#
|
|
92
92
|
# @param [mixed] endpoint The endpoint that should receive
|
|
93
93
|
# messages that are published to this topic. Valid values
|
|
94
|
-
# for
|
|
94
|
+
# for `endpoint` include:
|
|
95
95
|
#
|
|
96
96
|
# * URI object
|
|
97
97
|
# * http and https URI strings
|
|
@@ -103,7 +103,7 @@ module AWS
|
|
|
103
103
|
# @param [Hash] options
|
|
104
104
|
# @option options [Boolean] :json (false)
|
|
105
105
|
# @return [Subscription,nil] Returns a subscription when possible.
|
|
106
|
-
# If the subscription requires confirmation first, then
|
|
106
|
+
# If the subscription requires confirmation first, then `nil` is
|
|
107
107
|
# returned instead.
|
|
108
108
|
def subscribe endpoint, options = {}
|
|
109
109
|
subscribe_opts = endpoint_opts(endpoint, options).merge(:topic_arn => arn)
|
|
@@ -134,7 +134,7 @@ module AWS
|
|
|
134
134
|
#
|
|
135
135
|
def confirm_subscription token, options = {}
|
|
136
136
|
|
|
137
|
-
options[:authenticate_on_unsubscribe] = 'true' if
|
|
137
|
+
options[:authenticate_on_unsubscribe] = 'true' if
|
|
138
138
|
options[:authenticate_on_unsubscribe]
|
|
139
139
|
|
|
140
140
|
confirm_opts = options.merge(:token => token, :topic_arn => arn)
|
|
@@ -152,16 +152,16 @@ module AWS
|
|
|
152
152
|
TopicSubscriptionCollection.new(self)
|
|
153
153
|
end
|
|
154
154
|
|
|
155
|
-
# @return [String] Returns the human-readable name used in
|
|
156
|
-
# the "From" field for notifications to email and email-json
|
|
155
|
+
# @return [String] Returns the human-readable name used in
|
|
156
|
+
# the "From" field for notifications to email and email-json
|
|
157
157
|
# endpoints. If you have not set the display name the topic
|
|
158
158
|
# {#name} will be used/returned instead.
|
|
159
159
|
def display_name
|
|
160
160
|
to_h[:display_name]
|
|
161
161
|
end
|
|
162
162
|
|
|
163
|
-
# @param [String] display_name Sets the human-readable name used in
|
|
164
|
-
# the "From" field for notifications to email and email-json
|
|
163
|
+
# @param [String] display_name Sets the human-readable name used in
|
|
164
|
+
# the "From" field for notifications to email and email-json
|
|
165
165
|
# endpoints.
|
|
166
166
|
# @return [String] Returns the display_name as passed.
|
|
167
167
|
def display_name= display_name
|
|
@@ -194,9 +194,9 @@ module AWS
|
|
|
194
194
|
to_h[:policy]
|
|
195
195
|
end
|
|
196
196
|
|
|
197
|
-
# Sets the topic's policy.
|
|
197
|
+
# Sets the topic's policy.
|
|
198
198
|
# @param [String,Policy] policy A JSON policy string, a {Policy} object
|
|
199
|
-
# or any other object that responds to #to_json with a valid
|
|
199
|
+
# or any other object that responds to #to_json with a valid
|
|
200
200
|
# policy.
|
|
201
201
|
# @return [nil]
|
|
202
202
|
def policy= policy
|
|
@@ -216,46 +216,46 @@ module AWS
|
|
|
216
216
|
to_h[:effective_delivery_policy_json]
|
|
217
217
|
end
|
|
218
218
|
|
|
219
|
-
# Publishes a message to this SNS topic.
|
|
219
|
+
# Publishes a message to this SNS topic.
|
|
220
220
|
#
|
|
221
|
-
#
|
|
221
|
+
# topic.publish('a short message')
|
|
222
222
|
#
|
|
223
223
|
# You can pass a subject that is used when sending the message to
|
|
224
224
|
# email endpoints:
|
|
225
225
|
#
|
|
226
|
-
#
|
|
226
|
+
# topic.publish('message', :subject => 'SNS message subject')
|
|
227
227
|
#
|
|
228
228
|
# If you would like to pass a different message to various protocols
|
|
229
229
|
# (endpoint types) you can pass those as options:
|
|
230
230
|
#
|
|
231
|
-
#
|
|
232
|
-
#
|
|
233
|
-
#
|
|
234
|
-
#
|
|
231
|
+
# topic.publish('default message',
|
|
232
|
+
# :http => "message sent to http endpoints",
|
|
233
|
+
# :https => "message sent to https endpoints",
|
|
234
|
+
# :email => "message sent to email endpoints")
|
|
235
235
|
#
|
|
236
236
|
# The full list of acceptable protocols are listed below. The default
|
|
237
237
|
# message is sent to endpoints who's protocol was not listed.
|
|
238
238
|
#
|
|
239
|
-
# @param [String] default_message The message you want to send to the
|
|
240
|
-
# topic. Messages must be UTF-8 encoded strings at most 8 KB in size
|
|
239
|
+
# @param [String] default_message The message you want to send to the
|
|
240
|
+
# topic. Messages must be UTF-8 encoded strings at most 8 KB in size
|
|
241
241
|
# (8192 bytes, not 8192 characters).
|
|
242
242
|
# @param [Hash] options
|
|
243
|
-
# @option options [String] :subject Used as the "Subject" line when
|
|
243
|
+
# @option options [String] :subject Used as the "Subject" line when
|
|
244
244
|
# the message is delivered to email endpoints. Will also be
|
|
245
245
|
# included in the standard JSON messages delivered to other endpoints.
|
|
246
|
-
# * must be ASCII text that begins with a letter, number or
|
|
246
|
+
# * must be ASCII text that begins with a letter, number or
|
|
247
247
|
# punctuation mark
|
|
248
248
|
# * must not include line breaks or control characters
|
|
249
249
|
# * and must be less than 100 characters long
|
|
250
|
-
# @option options [String] :http - Message to use when sending to an
|
|
250
|
+
# @option options [String] :http - Message to use when sending to an
|
|
251
251
|
# HTTP endpoint.
|
|
252
|
-
# @option options [String] :https - Message to use when sending to an
|
|
252
|
+
# @option options [String] :https - Message to use when sending to an
|
|
253
253
|
# HTTPS endpoint.
|
|
254
|
-
# @option options [String] :email - Message to use when sending to an
|
|
254
|
+
# @option options [String] :email - Message to use when sending to an
|
|
255
255
|
# email endpoint.
|
|
256
|
-
# @option options [String] :email_json - Message to use when sending
|
|
256
|
+
# @option options [String] :email_json - Message to use when sending
|
|
257
257
|
# to an email json endpoint.
|
|
258
|
-
# @option options [String] :sqs - Message to use when sending to an
|
|
258
|
+
# @option options [String] :sqs - Message to use when sending to an
|
|
259
259
|
# SQS endpoint.
|
|
260
260
|
# @return [String] Returns the ID of the message that was sent.
|
|
261
261
|
def publish default_message, options = {}
|
|
@@ -273,7 +273,7 @@ module AWS
|
|
|
273
273
|
publish_opts[:message_structure] = 'json'
|
|
274
274
|
publish_opts[:subject] = options[:subject] if options[:subject]
|
|
275
275
|
publish_opts[:topic_arn] = arn
|
|
276
|
-
|
|
276
|
+
|
|
277
277
|
response = client.publish(publish_opts)
|
|
278
278
|
|
|
279
279
|
response[:message_id]
|
|
@@ -290,15 +290,15 @@ module AWS
|
|
|
290
290
|
# @return [Hash] Returns a hash of attributes about this topic,
|
|
291
291
|
# including:
|
|
292
292
|
#
|
|
293
|
-
# *
|
|
294
|
-
# *
|
|
295
|
-
# *
|
|
296
|
-
# *
|
|
297
|
-
# *
|
|
298
|
-
# *
|
|
299
|
-
# *
|
|
300
|
-
# *
|
|
301
|
-
#
|
|
293
|
+
# * `:arn`
|
|
294
|
+
# * `:name`
|
|
295
|
+
# * `:owner`
|
|
296
|
+
# * `:display_name`
|
|
297
|
+
# * `:policy`
|
|
298
|
+
# * `:num_subscriptions_confirmed`
|
|
299
|
+
# * `:num_subscriptions_pending`
|
|
300
|
+
# * `:num_subscriptions_deleted`
|
|
301
|
+
#
|
|
302
302
|
def to_h
|
|
303
303
|
attributes = client.get_topic_attributes(:topic_arn => arn).attributes
|
|
304
304
|
{
|
|
@@ -370,13 +370,13 @@ module AWS
|
|
|
370
370
|
unless opts[:update_policy] == false
|
|
371
371
|
policy = endpoint.policy || SQS::Policy.new
|
|
372
372
|
policy.allow(
|
|
373
|
-
:principal => :any,
|
|
374
|
-
:actions => [:send_message],
|
|
373
|
+
:principal => :any,
|
|
374
|
+
:actions => [:send_message],
|
|
375
375
|
:resources => [endpoint]
|
|
376
376
|
).where(:source_arn).is(arn)
|
|
377
377
|
endpoint.policy = policy
|
|
378
378
|
end
|
|
379
|
-
|
|
379
|
+
|
|
380
380
|
{ :protocol => 'sqs', :endpoint => endpoint.arn }
|
|
381
381
|
|
|
382
382
|
when endpoint =~ /^arn:/
|
|
@@ -28,8 +28,8 @@ module AWS
|
|
|
28
28
|
# @param [String] topic_arn An AWS SNS Topic ARN. It should be
|
|
29
29
|
# formatted something like:
|
|
30
30
|
#
|
|
31
|
-
#
|
|
32
|
-
#
|
|
31
|
+
# arn:aws:sns:us-west-2:123456789012:TopicName
|
|
32
|
+
#
|
|
33
33
|
# @return [Topic] Returns a topic with the given Topic ARN.
|
|
34
34
|
def [] topic_arn
|
|
35
35
|
unless topic_arn =~ /^arn:aws:sns:/
|
|
@@ -17,11 +17,11 @@ module AWS
|
|
|
17
17
|
# Represents the collection of all subscriptions for a particular
|
|
18
18
|
# topic. For example:
|
|
19
19
|
#
|
|
20
|
-
#
|
|
21
|
-
#
|
|
22
|
-
#
|
|
23
|
-
#
|
|
24
|
-
#
|
|
20
|
+
# # get the e-mail addressess that receive plain-text
|
|
21
|
+
# # messages sent to the topic
|
|
22
|
+
# topic.subscriptions.
|
|
23
|
+
# select { |s| s.protocol == :email }.
|
|
24
|
+
# map(&:endpoint)
|
|
25
25
|
#
|
|
26
26
|
class TopicSubscriptionCollection < SubscriptionCollection
|
|
27
27
|
|
data/lib/aws/sqs.rb
CHANGED
|
@@ -18,22 +18,22 @@ module AWS
|
|
|
18
18
|
|
|
19
19
|
# Provides an expressive, object-oriented interface to Amazon SQS.
|
|
20
20
|
#
|
|
21
|
-
#
|
|
21
|
+
# ## Credentials
|
|
22
22
|
#
|
|
23
23
|
# You can setup default credentials for all AWS services via
|
|
24
24
|
# AWS.config:
|
|
25
25
|
#
|
|
26
|
-
#
|
|
27
|
-
#
|
|
28
|
-
#
|
|
26
|
+
# AWS.config(
|
|
27
|
+
# :access_key_id => 'YOUR_ACCESS_KEY_ID',
|
|
28
|
+
# :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
|
|
29
29
|
#
|
|
30
30
|
# Or you can set them directly on the SQS interface:
|
|
31
31
|
#
|
|
32
|
-
#
|
|
33
|
-
#
|
|
34
|
-
#
|
|
32
|
+
# sqs = AWS::SQS.new(
|
|
33
|
+
# :access_key_id => 'YOUR_ACCESS_KEY_ID',
|
|
34
|
+
# :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
|
|
35
35
|
#
|
|
36
|
-
#
|
|
36
|
+
# ## Queues and Messages
|
|
37
37
|
#
|
|
38
38
|
# Amazon SQS is a distributed queue system that enables web
|
|
39
39
|
# service applications to quickly and reliably queue messages that
|
|
@@ -44,11 +44,11 @@ module AWS
|
|
|
44
44
|
# You can access your queues using the {#queues} collection. For
|
|
45
45
|
# example, to create a queue, use {QueueCollection#create}:
|
|
46
46
|
#
|
|
47
|
-
#
|
|
47
|
+
# queue = sqs.queues.create("myqueue")
|
|
48
48
|
#
|
|
49
49
|
# Or to find out what queues you have in your account:
|
|
50
50
|
#
|
|
51
|
-
#
|
|
51
|
+
# pp sqs.queues.collect(&:url)
|
|
52
52
|
#
|
|
53
53
|
# See the {Queue} class for more information on how to send and
|
|
54
54
|
# receive messages.
|
|
@@ -57,19 +57,19 @@ module AWS
|
|
|
57
57
|
# @return [Client] the low-level SQS client object
|
|
58
58
|
class SQS
|
|
59
59
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
autoload :Request, 'request'
|
|
69
|
-
end
|
|
60
|
+
autoload :Client, 'aws/sqs/client'
|
|
61
|
+
autoload :Errors, 'aws/sqs/errors'
|
|
62
|
+
autoload :Queue, 'aws/sqs/queue'
|
|
63
|
+
autoload :QueueCollection, 'aws/sqs/queue_collection'
|
|
64
|
+
autoload :Policy, 'aws/sqs/policy'
|
|
65
|
+
autoload :ReceivedMessage, 'aws/sqs/received_message'
|
|
66
|
+
autoload :ReceivedSNSMessage, 'aws/sqs/received_sns_message'
|
|
67
|
+
autoload :Request, 'aws/sqs/request'
|
|
70
68
|
|
|
71
69
|
include Core::ServiceInterface
|
|
72
70
|
|
|
71
|
+
endpoint_prefix 'sqs'
|
|
72
|
+
|
|
73
73
|
# @return [QueueCollection] The collection of all {Queue}
|
|
74
74
|
# objects in your account.
|
|
75
75
|
def queues
|
data/lib/aws/sqs/client.rb
CHANGED
|
@@ -25,177 +25,177 @@ module AWS
|
|
|
25
25
|
# @!method add_permission(options = {})
|
|
26
26
|
# Calls the AddPermission API operation.
|
|
27
27
|
# @param [Hash] options
|
|
28
|
-
# *
|
|
28
|
+
# * `:queue_url` - *required* - (String) The URL of the SQS queue to
|
|
29
29
|
# take action on.
|
|
30
|
-
# *
|
|
30
|
+
# * `:label` - *required* - (String) The unique identification of the
|
|
31
31
|
# permission you're setting (e.g., AliceSendMessage). Constraints:
|
|
32
32
|
# Maximum 80 characters; alphanumeric characters, hyphens (-), and
|
|
33
33
|
# underscores (_) are allowed.
|
|
34
|
-
# *
|
|
34
|
+
# * `:aws_account_ids` - *required* - (Array<String>) The AWS account
|
|
35
35
|
# number of the principal who will be given permission. The principal
|
|
36
36
|
# must have an AWS account, but does not need to be signed up for
|
|
37
37
|
# Amazon SQS.
|
|
38
|
-
# *
|
|
38
|
+
# * `:actions` - *required* - (Array<String>) The action the client
|
|
39
39
|
# wants to allow for the specified principal.
|
|
40
40
|
# @return [Core::Response]
|
|
41
41
|
|
|
42
42
|
# @!method change_message_visibility(options = {})
|
|
43
43
|
# Calls the ChangeMessageVisibility API operation.
|
|
44
44
|
# @param [Hash] options
|
|
45
|
-
# *
|
|
45
|
+
# * `:queue_url` - *required* - (String) The URL of the SQS queue to
|
|
46
46
|
# take action on.
|
|
47
|
-
# *
|
|
47
|
+
# * `:receipt_handle` - *required* - (String) The receipt handle
|
|
48
48
|
# associated with the message whose visibility timeout should be
|
|
49
49
|
# changed.
|
|
50
|
-
# *
|
|
50
|
+
# * `:visibility_timeout` - *required* - (Integer) The new value (in
|
|
51
51
|
# seconds) for the message's visibility timeout.
|
|
52
52
|
# @return [Core::Response]
|
|
53
53
|
|
|
54
54
|
# @!method change_message_visibility_batch(options = {})
|
|
55
55
|
# Calls the ChangeMessageVisibilityBatch API operation.
|
|
56
56
|
# @param [Hash] options
|
|
57
|
-
# *
|
|
57
|
+
# * `:queue_url` - *required* - (String) The URL of the SQS queue to
|
|
58
58
|
# take action on.
|
|
59
|
-
# *
|
|
59
|
+
# * `:entries` - *required* - (Array<Hash>) A list of receipt handles
|
|
60
60
|
# of the messages for which the visibility timeout must be changed.
|
|
61
|
-
# *
|
|
61
|
+
# * `:id` - *required* - (String) An identifier for this particular
|
|
62
62
|
# receipt handle. This is used to communicate the result. Note that
|
|
63
63
|
# the Ids of a batch request need to be unique within the request.
|
|
64
|
-
# *
|
|
65
|
-
# *
|
|
64
|
+
# * `:receipt_handle` - *required* - (String) A receipt handle.
|
|
65
|
+
# * `:visibility_timeout` - (Integer) The new value (in seconds) for
|
|
66
66
|
# the message's visibility timeout.
|
|
67
67
|
# @return [Core::Response]
|
|
68
68
|
# The #data method of the response object returns
|
|
69
69
|
# a hash with the following structure:
|
|
70
|
-
# *
|
|
71
|
-
# *
|
|
72
|
-
# *
|
|
73
|
-
# *
|
|
74
|
-
# *
|
|
75
|
-
# *
|
|
76
|
-
# *
|
|
70
|
+
# * `:successful` - (Array<Hash>)
|
|
71
|
+
# * `:id` - (String)
|
|
72
|
+
# * `:failed` - (Array<Hash>)
|
|
73
|
+
# * `:id` - (String)
|
|
74
|
+
# * `:sender_fault` - (Boolean)
|
|
75
|
+
# * `:code` - (String)
|
|
76
|
+
# * `:message` - (String)
|
|
77
77
|
|
|
78
78
|
# @!method create_queue(options = {})
|
|
79
79
|
# Calls the CreateQueue API operation.
|
|
80
80
|
# @param [Hash] options
|
|
81
|
-
# *
|
|
81
|
+
# * `:queue_name` - *required* - (String) The name for the queue to be
|
|
82
82
|
# created.
|
|
83
|
-
# *
|
|
83
|
+
# * `:attributes` - (Hash<String,String>) A map of attributes with
|
|
84
84
|
# their corresponding values.
|
|
85
85
|
# @return [Core::Response]
|
|
86
86
|
# The #data method of the response object returns
|
|
87
87
|
# a hash with the following structure:
|
|
88
|
-
# *
|
|
88
|
+
# * `:queue_url` - (String)
|
|
89
89
|
|
|
90
90
|
# @!method delete_message(options = {})
|
|
91
91
|
# Calls the DeleteMessage API operation.
|
|
92
92
|
# @param [Hash] options
|
|
93
|
-
# *
|
|
93
|
+
# * `:queue_url` - *required* - (String) The URL of the SQS queue to
|
|
94
94
|
# take action on.
|
|
95
|
-
# *
|
|
95
|
+
# * `:receipt_handle` - *required* - (String) The receipt handle
|
|
96
96
|
# associated with the message to delete.
|
|
97
97
|
# @return [Core::Response]
|
|
98
98
|
|
|
99
99
|
# @!method delete_message_batch(options = {})
|
|
100
100
|
# Calls the DeleteMessageBatch API operation.
|
|
101
101
|
# @param [Hash] options
|
|
102
|
-
# *
|
|
102
|
+
# * `:queue_url` - *required* - (String) The URL of the SQS queue to
|
|
103
103
|
# take action on.
|
|
104
|
-
# *
|
|
104
|
+
# * `:entries` - *required* - (Array<Hash>) A list of receipt handles
|
|
105
105
|
# for the messages to be deleted.
|
|
106
|
-
# *
|
|
106
|
+
# * `:id` - *required* - (String) An identifier for this particular
|
|
107
107
|
# receipt handle. This is used to communicate the result. Note that
|
|
108
108
|
# the Ids of a batch request need to be unique within the request.
|
|
109
|
-
# *
|
|
109
|
+
# * `:receipt_handle` - *required* - (String) A receipt handle.
|
|
110
110
|
# @return [Core::Response]
|
|
111
111
|
# The #data method of the response object returns
|
|
112
112
|
# a hash with the following structure:
|
|
113
|
-
# *
|
|
114
|
-
# *
|
|
115
|
-
# *
|
|
116
|
-
# *
|
|
117
|
-
# *
|
|
118
|
-
# *
|
|
119
|
-
# *
|
|
113
|
+
# * `:successful` - (Array<Hash>)
|
|
114
|
+
# * `:id` - (String)
|
|
115
|
+
# * `:failed` - (Array<Hash>)
|
|
116
|
+
# * `:id` - (String)
|
|
117
|
+
# * `:sender_fault` - (Boolean)
|
|
118
|
+
# * `:code` - (String)
|
|
119
|
+
# * `:message` - (String)
|
|
120
120
|
|
|
121
121
|
# @!method delete_queue(options = {})
|
|
122
122
|
# Calls the DeleteQueue API operation.
|
|
123
123
|
# @param [Hash] options
|
|
124
|
-
# *
|
|
124
|
+
# * `:queue_url` - *required* - (String) The URL of the SQS queue to
|
|
125
125
|
# take action on.
|
|
126
126
|
# @return [Core::Response]
|
|
127
127
|
|
|
128
128
|
# @!method get_queue_attributes(options = {})
|
|
129
129
|
# Calls the GetQueueAttributes API operation.
|
|
130
130
|
# @param [Hash] options
|
|
131
|
-
# *
|
|
131
|
+
# * `:queue_url` - *required* - (String) The URL of the SQS queue to
|
|
132
132
|
# take action on.
|
|
133
|
-
# *
|
|
133
|
+
# * `:attribute_names` - (Array<String>) A list of attributes to
|
|
134
134
|
# retrieve information for.
|
|
135
135
|
# @return [Core::Response]
|
|
136
136
|
# The #data method of the response object returns
|
|
137
137
|
# a hash with the following structure:
|
|
138
|
-
# *
|
|
138
|
+
# * `:attributes` - (Hash<String,String>)
|
|
139
139
|
|
|
140
140
|
# @!method get_queue_url(options = {})
|
|
141
141
|
# Calls the GetQueueUrl API operation.
|
|
142
142
|
# @param [Hash] options
|
|
143
|
-
# *
|
|
143
|
+
# * `:queue_name` - *required* - (String) The name of the queue whose
|
|
144
144
|
# URL must be fetched.
|
|
145
|
-
# *
|
|
145
|
+
# * `:queue_owner_aws_account_id` - (String) The AWS account number of
|
|
146
146
|
# the queue's owner.
|
|
147
147
|
# @return [Core::Response]
|
|
148
148
|
# The #data method of the response object returns
|
|
149
149
|
# a hash with the following structure:
|
|
150
|
-
# *
|
|
150
|
+
# * `:queue_url` - (String)
|
|
151
151
|
|
|
152
152
|
# @!method list_queues(options = {})
|
|
153
153
|
# Calls the ListQueues API operation.
|
|
154
154
|
# @param [Hash] options
|
|
155
|
-
# *
|
|
155
|
+
# * `:queue_name_prefix` - (String) A string to use for filtering the
|
|
156
156
|
# list results. Only those queues whose name begins with the
|
|
157
157
|
# specified string are returned.
|
|
158
158
|
# @return [Core::Response]
|
|
159
159
|
# The #data method of the response object returns
|
|
160
160
|
# a hash with the following structure:
|
|
161
|
-
# *
|
|
161
|
+
# * `:queue_urls` - (Array<String>)
|
|
162
162
|
|
|
163
163
|
# @!method receive_message(options = {})
|
|
164
164
|
# Calls the ReceiveMessage API operation.
|
|
165
165
|
# @param [Hash] options
|
|
166
|
-
# *
|
|
166
|
+
# * `:queue_url` - *required* - (String) The URL of the SQS queue to
|
|
167
167
|
# take action on.
|
|
168
|
-
# *
|
|
168
|
+
# * `:attribute_names` - (Array<String>) A list of attributes that need
|
|
169
169
|
# to be returned along with each message. The set of valid attributes
|
|
170
170
|
# are [SenderId, ApproximateFirstReceiveTimestamp,
|
|
171
171
|
# ApproximateReceiveCount, SentTimestamp].
|
|
172
|
-
# *
|
|
172
|
+
# * `:max_number_of_messages` - (Integer) The maximum number of
|
|
173
173
|
# messages to return. Amazon SQS never returns more messages than
|
|
174
174
|
# this value but may return fewer. All of the messages are not
|
|
175
175
|
# necessarily returned.
|
|
176
|
-
# *
|
|
176
|
+
# * `:visibility_timeout` - (Integer) The duration (in seconds) that
|
|
177
177
|
# the received messages are hidden from subsequent retrieve requests
|
|
178
178
|
# after being retrieved by a ReceiveMessage request.
|
|
179
|
-
# *
|
|
179
|
+
# * `:wait_time_seconds` - (Integer) The duration (in seconds) for
|
|
180
180
|
# which the call will wait for a message to arrive in the queue
|
|
181
181
|
# before returning. If a message is available, the call will return
|
|
182
182
|
# sooner than WaitTimeSeconds.
|
|
183
183
|
# @return [Core::Response]
|
|
184
184
|
# The #data method of the response object returns
|
|
185
185
|
# a hash with the following structure:
|
|
186
|
-
# *
|
|
187
|
-
# *
|
|
188
|
-
# *
|
|
189
|
-
# *
|
|
190
|
-
# *
|
|
191
|
-
# *
|
|
186
|
+
# * `:messages` - (Array<Hash>)
|
|
187
|
+
# * `:message_id` - (String)
|
|
188
|
+
# * `:receipt_handle` - (String)
|
|
189
|
+
# * `:md5_of_body` - (String)
|
|
190
|
+
# * `:body` - (String)
|
|
191
|
+
# * `:attributes` - (Hash<String,String>)
|
|
192
192
|
|
|
193
193
|
# @!method remove_permission(options = {})
|
|
194
194
|
# Calls the RemovePermission API operation.
|
|
195
195
|
# @param [Hash] options
|
|
196
|
-
# *
|
|
196
|
+
# * `:queue_url` - *required* - (String) The URL of the SQS queue to
|
|
197
197
|
# take action on.
|
|
198
|
-
# *
|
|
198
|
+
# * `:label` - *required* - (String) The identification of the
|
|
199
199
|
# permission to remove. This is the label added with the
|
|
200
200
|
# AddPermission operation.
|
|
201
201
|
# @return [Core::Response]
|
|
@@ -203,49 +203,49 @@ module AWS
|
|
|
203
203
|
# @!method send_message(options = {})
|
|
204
204
|
# Calls the SendMessage API operation.
|
|
205
205
|
# @param [Hash] options
|
|
206
|
-
# *
|
|
206
|
+
# * `:queue_url` - *required* - (String) The URL of the SQS queue to
|
|
207
207
|
# take action on.
|
|
208
|
-
# *
|
|
209
|
-
# *
|
|
208
|
+
# * `:message_body` - *required* - (String) The message to send.
|
|
209
|
+
# * `:delay_seconds` - (Integer) The number of seconds the message has
|
|
210
210
|
# to be delayed.
|
|
211
211
|
# @return [Core::Response]
|
|
212
212
|
# The #data method of the response object returns
|
|
213
213
|
# a hash with the following structure:
|
|
214
|
-
# *
|
|
215
|
-
# *
|
|
214
|
+
# * `:md5_of_message_body` - (String)
|
|
215
|
+
# * `:message_id` - (String)
|
|
216
216
|
|
|
217
217
|
# @!method send_message_batch(options = {})
|
|
218
218
|
# Calls the SendMessageBatch API operation.
|
|
219
219
|
# @param [Hash] options
|
|
220
|
-
# *
|
|
220
|
+
# * `:queue_url` - *required* - (String) The URL of the SQS queue to
|
|
221
221
|
# take action on.
|
|
222
|
-
# *
|
|
222
|
+
# * `:entries` - *required* - (Array<Hash>) A list of
|
|
223
223
|
# SendMessageBatchRequestEntrys.
|
|
224
|
-
# *
|
|
224
|
+
# * `:id` - *required* - (String) An identifier for the message in
|
|
225
225
|
# this batch. This is used to communicate the result. Note that the
|
|
226
226
|
# the Ids of a batch request need to be unique within the request.
|
|
227
|
-
# *
|
|
228
|
-
# *
|
|
227
|
+
# * `:message_body` - *required* - (String) Body of the message.
|
|
228
|
+
# * `:delay_seconds` - (Integer) The number of seconds for which the
|
|
229
229
|
# message has to be delayed.
|
|
230
230
|
# @return [Core::Response]
|
|
231
231
|
# The #data method of the response object returns
|
|
232
232
|
# a hash with the following structure:
|
|
233
|
-
# *
|
|
234
|
-
# *
|
|
235
|
-
# *
|
|
236
|
-
# *
|
|
237
|
-
# *
|
|
238
|
-
# *
|
|
239
|
-
# *
|
|
240
|
-
# *
|
|
241
|
-
# *
|
|
233
|
+
# * `:successful` - (Array<Hash>)
|
|
234
|
+
# * `:id` - (String)
|
|
235
|
+
# * `:message_id` - (String)
|
|
236
|
+
# * `:md5_of_message_body` - (String)
|
|
237
|
+
# * `:failed` - (Array<Hash>)
|
|
238
|
+
# * `:id` - (String)
|
|
239
|
+
# * `:sender_fault` - (Boolean)
|
|
240
|
+
# * `:code` - (String)
|
|
241
|
+
# * `:message` - (String)
|
|
242
242
|
|
|
243
243
|
# @!method set_queue_attributes(options = {})
|
|
244
244
|
# Calls the SetQueueAttributes API operation.
|
|
245
245
|
# @param [Hash] options
|
|
246
|
-
# *
|
|
246
|
+
# * `:queue_url` - *required* - (String) The URL of the SQS queue to
|
|
247
247
|
# take action on.
|
|
248
|
-
# *
|
|
248
|
+
# * `:attributes` - *required* - (Hash<String,String>) A map of
|
|
249
249
|
# attributes to set.
|
|
250
250
|
# @return [Core::Response]
|
|
251
251
|
|