aws-sdk 1.4.1 → 1.5.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.yardopts +0 -1
- data/lib/aws/api_config/AutoScaling-2011-01-01.yml +772 -544
- data/lib/aws/api_config/CloudFormation-2010-05-15.yml +284 -185
- data/lib/aws/api_config/DynamoDB-2011-12-05.yml +458 -738
- data/lib/aws/api_config/EC2-2011-12-15.yml +3502 -2653
- data/lib/aws/api_config/ELB-2011-08-15.yml +484 -352
- data/lib/aws/api_config/IAM-2010-05-08.yml +899 -711
- data/lib/aws/api_config/SNS-2010-03-31.yml +235 -167
- data/lib/aws/api_config/SQS-2011-10-01.yml +290 -251
- data/lib/aws/api_config/STS-2011-06-15.yml +35 -41
- data/lib/aws/api_config/SimpleDB-2009-04-15.yml +290 -263
- data/lib/aws/api_config/SimpleEmailService-2010-12-01.yml +144 -130
- data/lib/aws/api_config/SimpleWorkflow-2012-01-25.yml +697 -1139
- data/lib/aws/auto_scaling/activity_collection.rb +1 -1
- data/lib/aws/auto_scaling/client.rb +724 -9
- data/lib/aws/auto_scaling/errors.rb +1 -5
- data/lib/aws/auto_scaling/group.rb +1 -1
- data/lib/aws/auto_scaling/group_collection.rb +1 -1
- data/lib/aws/auto_scaling/instance_collection.rb +1 -1
- data/lib/aws/auto_scaling/launch_configuration.rb +1 -1
- data/lib/aws/auto_scaling/launch_configuration_collection.rb +1 -1
- data/lib/aws/auto_scaling/notification_configuration_collection.rb +1 -1
- data/lib/aws/auto_scaling/request.rb +1 -2
- data/lib/aws/auto_scaling/scaling_policy_collection.rb +1 -1
- data/lib/aws/auto_scaling/scheduled_action_collection.rb +3 -3
- data/lib/aws/auto_scaling/tag_collection.rb +1 -1
- data/lib/aws/cloud_formation.rb +1 -18
- data/lib/aws/cloud_formation/client.rb +314 -8
- data/lib/aws/cloud_formation/errors.rb +1 -5
- data/lib/aws/cloud_formation/request.rb +1 -2
- data/lib/aws/cloud_formation/stack.rb +4 -3
- data/lib/aws/cloud_formation/stack_collection.rb +2 -2
- data/lib/aws/cloud_formation/stack_resource_collection.rb +1 -1
- data/lib/aws/cloud_formation/stack_resource_summary_collection.rb +2 -2
- data/lib/aws/cloud_formation/stack_summary_collection.rb +1 -1
- data/lib/aws/core.rb +29 -14
- data/lib/aws/core/async_handle.rb +11 -12
- data/lib/aws/core/client.rb +112 -102
- data/lib/aws/core/client/query_json.rb +110 -0
- data/lib/aws/core/client/query_xml.rb +122 -0
- data/lib/aws/core/data.rb +242 -0
- data/lib/aws/core/http/request.rb +7 -4
- data/lib/aws/core/lazy_error_classes.rb +60 -38
- data/lib/aws/core/option_grammar.rb +1 -0
- data/lib/aws/core/policy.rb +2 -1
- data/lib/aws/core/resource.rb +38 -33
- data/lib/aws/core/response.rb +109 -44
- data/lib/aws/core/signature/version_2.rb +42 -0
- data/lib/aws/core/signature/version_3.rb +73 -0
- data/lib/aws/core/signature/version_3_http.rb +72 -0
- data/lib/aws/core/signature/version_4.rb +138 -0
- data/lib/aws/core/uri_escape.rb +6 -9
- data/lib/aws/core/xml/frame.rb +242 -0
- data/lib/aws/core/xml/frame_stack.rb +85 -0
- data/lib/aws/core/xml/grammar.rb +299 -0
- data/lib/aws/core/xml/parser.rb +70 -0
- data/lib/aws/core/xml/root_frame.rb +65 -0
- data/lib/aws/core/{configured_xml_grammars.rb → xml/sax_handlers/libxml.rb} +22 -20
- data/lib/aws/core/xml/sax_handlers/nokogiri.rb +55 -0
- data/lib/aws/core/{authorize_with_session_token.rb → xml/sax_handlers/ox.rb} +19 -7
- data/lib/aws/core/{configured_option_grammars.rb → xml/sax_handlers/rexml.rb} +22 -23
- data/lib/aws/core/xml/stub.rb +123 -0
- data/lib/aws/dynamo_db/batch_get.rb +1 -1
- data/lib/aws/dynamo_db/client.rb +796 -14
- data/lib/aws/dynamo_db/errors.rb +1 -38
- data/lib/aws/dynamo_db/item_collection.rb +29 -28
- data/lib/aws/dynamo_db/request.rb +3 -53
- data/lib/aws/dynamo_db/table.rb +6 -2
- data/lib/aws/ec2/attachment.rb +1 -1
- data/lib/aws/ec2/client.rb +3954 -9
- data/lib/aws/ec2/dhcp_options.rb +3 -3
- data/lib/aws/ec2/errors.rb +10 -4
- data/lib/aws/ec2/instance.rb +7 -6
- data/lib/aws/ec2/instance_collection.rb +2 -2
- data/lib/aws/ec2/key_pair_collection.rb +3 -3
- data/lib/aws/ec2/network_acl.rb +4 -2
- data/lib/aws/ec2/network_acl/entry.rb +10 -10
- data/lib/aws/ec2/network_interface.rb +2 -3
- data/lib/aws/ec2/network_interface/attachment.rb +8 -8
- data/lib/aws/ec2/permission_collection.rb +3 -3
- data/lib/aws/ec2/request.rb +1 -3
- data/lib/aws/ec2/resource_tag_collection.rb +4 -8
- data/lib/aws/ec2/route_table.rb +3 -2
- data/lib/aws/ec2/route_table/route.rb +7 -7
- data/lib/aws/ec2/security_group.rb +2 -2
- data/lib/aws/ec2/security_group/egress_ip_permission_collection.rb +16 -5
- data/lib/aws/ec2/security_group/ingress_ip_permission_collection.rb +4 -3
- data/lib/aws/ec2/security_group/ip_permission.rb +1 -2
- data/lib/aws/ec2/snapshot_collection.rb +6 -3
- data/lib/aws/ec2/subnet.rb +1 -1
- data/lib/aws/ec2/volume.rb +1 -3
- data/lib/aws/ec2/volume_collection.rb +2 -0
- data/lib/aws/elb/availability_zone_collection.rb +2 -2
- data/lib/aws/elb/backend_server_policy_collection.rb +1 -1
- data/lib/aws/elb/client.rb +513 -9
- data/lib/aws/elb/errors.rb +2 -6
- data/lib/aws/elb/instance_collection.rb +2 -2
- data/lib/aws/elb/request.rb +1 -1
- data/lib/aws/errors.rb +61 -74
- data/lib/aws/iam.rb +2 -3
- data/lib/aws/iam/client.rb +1178 -10
- data/lib/aws/iam/collection.rb +2 -1
- data/lib/aws/iam/errors.rb +1 -6
- data/lib/aws/iam/group.rb +8 -9
- data/lib/aws/iam/request.rb +1 -1
- data/lib/aws/iam/server_certificate_collection.rb +8 -5
- data/lib/aws/iam/signing_certificate.rb +1 -1
- data/lib/aws/iam/user.rb +2 -2
- data/lib/aws/iam/user_policy.rb +3 -2
- data/lib/aws/rails.rb +1 -2
- data/lib/aws/record.rb +3 -3
- data/lib/aws/record/abstract_base.rb +0 -3
- data/lib/aws/record/attributes.rb +7 -7
- data/lib/aws/record/model.rb +19 -19
- data/lib/aws/record/model/finder_methods.rb +7 -7
- data/lib/aws/s3/bucket.rb +7 -2
- data/lib/aws/s3/client.rb +391 -398
- data/lib/aws/s3/client/xml.rb +44 -71
- data/lib/aws/s3/data_options.rb +3 -2
- data/lib/aws/s3/errors.rb +8 -11
- data/lib/aws/s3/multipart_upload_collection.rb +1 -3
- data/lib/aws/s3/object_collection.rb +2 -1
- data/lib/aws/s3/object_metadata.rb +2 -2
- data/lib/aws/s3/paginated_collection.rb +2 -2
- data/lib/aws/s3/prefix_and_delimiter_collection.rb +1 -1
- data/lib/aws/s3/presigned_post.rb +18 -17
- data/lib/aws/s3/request.rb +4 -3
- data/lib/aws/s3/s3_object.rb +8 -10
- data/lib/aws/simple_db/attribute.rb +2 -2
- data/lib/aws/simple_db/attribute_collection.rb +14 -4
- data/lib/aws/simple_db/client.rb +313 -14
- data/lib/aws/simple_db/domain.rb +1 -1
- data/lib/aws/simple_db/domain_collection.rb +4 -4
- data/lib/aws/simple_db/domain_metadata.rb +1 -1
- data/lib/aws/simple_db/errors.rb +14 -2
- data/lib/aws/simple_db/expect_condition_option.rb +1 -1
- data/lib/aws/simple_db/item.rb +1 -1
- data/lib/aws/simple_db/item_collection.rb +9 -9
- data/lib/aws/simple_db/item_data.rb +9 -6
- data/lib/aws/simple_db/request.rb +1 -1
- data/lib/aws/simple_email_service.rb +8 -7
- data/lib/aws/simple_email_service/client.rb +174 -9
- data/lib/aws/simple_email_service/email_address_collection.rb +0 -1
- data/lib/aws/simple_email_service/errors.rb +1 -5
- data/lib/aws/simple_email_service/quotas.rb +8 -6
- data/lib/aws/simple_email_service/request.rb +7 -1
- data/lib/aws/simple_workflow/client.rb +1383 -6
- data/lib/aws/simple_workflow/decision_task.rb +1 -3
- data/lib/aws/simple_workflow/errors.rb +1 -38
- data/lib/aws/simple_workflow/history_event_collection.rb +2 -2
- data/lib/aws/simple_workflow/request.rb +5 -49
- data/lib/aws/simple_workflow/type.rb +1 -1
- data/lib/aws/simple_workflow/type_collection.rb +4 -3
- data/lib/aws/simple_workflow/workflow_execution_collection.rb +2 -2
- data/lib/aws/sns/client.rb +345 -9
- data/lib/aws/sns/errors.rb +1 -5
- data/lib/aws/sns/request.rb +1 -2
- data/lib/aws/sns/subscription_collection.rb +2 -2
- data/lib/aws/sns/topic.rb +15 -14
- data/lib/aws/sns/topic_collection.rb +1 -1
- data/lib/aws/sqs/client.rb +334 -9
- data/lib/aws/sqs/errors.rb +1 -6
- data/lib/aws/sqs/queue.rb +20 -21
- data/lib/aws/sqs/queue_collection.rb +3 -3
- data/lib/aws/sqs/request.rb +2 -2
- data/lib/aws/sts.rb +8 -10
- data/lib/aws/sts/client.rb +67 -10
- data/lib/aws/sts/errors.rb +1 -5
- data/lib/aws/sts/request.rb +1 -1
- data/lib/user.rb +49 -0
- metadata +21 -28
- data/lib/aws/auto_scaling/client/xml.rb +0 -32
- data/lib/aws/cloud_formation/client/xml.rb +0 -32
- data/lib/aws/core/api_config.rb +0 -44
- data/lib/aws/core/authorize_v2.rb +0 -39
- data/lib/aws/core/authorize_v3.rb +0 -38
- data/lib/aws/core/authorize_v4.rb +0 -149
- data/lib/aws/core/configured_client_methods.rb +0 -76
- data/lib/aws/core/configured_grammars.rb +0 -63
- data/lib/aws/core/configured_json_client_methods.rb +0 -74
- data/lib/aws/core/ignore_result_element.rb +0 -34
- data/lib/aws/core/json_client.rb +0 -41
- data/lib/aws/core/xml_grammar.rb +0 -957
- data/lib/aws/ec2/client/xml.rb +0 -175
- data/lib/aws/elb/client/xml.rb +0 -33
- data/lib/aws/elb/listener_spec.rb +0 -14
- data/lib/aws/iam/client/xml.rb +0 -34
- data/lib/aws/simple_db/client/options.rb +0 -32
- data/lib/aws/simple_db/client/xml.rb +0 -63
- data/lib/aws/simple_email_service/client/xml.rb +0 -34
- data/lib/aws/sns/client/xml.rb +0 -34
- data/lib/aws/sqs/client/xml.rb +0 -33
- data/lib/aws/sts/client/xml.rb +0 -34
data/lib/aws/sns/errors.rb
CHANGED
data/lib/aws/sns/request.rb
CHANGED
data/lib/aws/sns/topic.rb
CHANGED
@@ -105,10 +105,10 @@ module AWS
|
|
105
105
|
# @return [Subscription,nil] Returns a subscription when possible.
|
106
106
|
# If the subscription requires confirmation first, then +nil+ is
|
107
107
|
# returned instead.
|
108
|
-
def subscribe endpoint,
|
109
|
-
subscribe_opts = endpoint_opts(endpoint,
|
108
|
+
def subscribe endpoint, options = {}
|
109
|
+
subscribe_opts = endpoint_opts(endpoint, options).merge(:topic_arn => arn)
|
110
110
|
resp = client.subscribe(subscribe_opts)
|
111
|
-
if arn = resp
|
111
|
+
if arn = resp[:subscription_arn] and arn =~ /^arn:/
|
112
112
|
Subscription.new(arn, :config => config)
|
113
113
|
else
|
114
114
|
nil
|
@@ -128,21 +128,22 @@ module AWS
|
|
128
128
|
#
|
129
129
|
# @option :options [Boolean] :authenticate_on_unsubscribe
|
130
130
|
# Indicates that you want to disable unauthenticated
|
131
|
-
# unsubsciption of the subscription.
|
132
|
-
# in the request, the request has an AWS signature, and the
|
133
|
-
# value of this parameter is true, only the topic owner and
|
134
|
-
# the subscription owner will be permitted to unsubscribe the
|
135
|
-
# endpoint, and the Unsubscribe action will require AWS
|
136
|
-
# authentication.
|
131
|
+
# unsubsciption of the subscription.
|
137
132
|
#
|
138
133
|
# @return [Subscription] The newly created subscription.
|
139
|
-
|
140
|
-
|
134
|
+
#
|
135
|
+
def confirm_subscription token, options = {}
|
136
|
+
|
137
|
+
options[:authenticate_on_unsubscribe] = 'true' if
|
138
|
+
options[:authenticate_on_unsubscribe]
|
139
|
+
|
140
|
+
confirm_opts = options.merge(:token => token, :topic_arn => arn)
|
141
141
|
resp = client.confirm_subscription(confirm_opts)
|
142
142
|
Subscription.new(
|
143
|
-
resp
|
143
|
+
resp[:subscription_arn],
|
144
144
|
:topic_arn => arn,
|
145
145
|
:config => config)
|
146
|
+
|
146
147
|
end
|
147
148
|
|
148
149
|
# @return [TopicSubscriptionCollection] Returns a collection that
|
@@ -238,7 +239,7 @@ module AWS
|
|
238
239
|
# @param [String] default_message The message you want to send to the
|
239
240
|
# topic. Messages must be UTF-8 encoded strings at most 8 KB in size
|
240
241
|
# (8192 bytes, not 8192 characters).
|
241
|
-
# @param [Hash]
|
242
|
+
# @param [Hash] options
|
242
243
|
# @option options [String] :subject Used as the "Subject" line when
|
243
244
|
# the message is delivered to email endpoints. Will also be
|
244
245
|
# included in the standard JSON messages delivered to other endpoints.
|
@@ -275,7 +276,7 @@ module AWS
|
|
275
276
|
|
276
277
|
response = client.publish(publish_opts)
|
277
278
|
|
278
|
-
response
|
279
|
+
response[:message_id]
|
279
280
|
|
280
281
|
end
|
281
282
|
|
data/lib/aws/sqs/client.rb
CHANGED
@@ -14,21 +14,346 @@
|
|
14
14
|
module AWS
|
15
15
|
class SQS
|
16
16
|
|
17
|
-
#
|
17
|
+
# Client class for Amazon Simple Queue Service (SQS).
|
18
18
|
class Client < Core::Client
|
19
19
|
|
20
|
-
AWS.register_autoloads(self) do
|
21
|
-
autoload :XML, 'xml'
|
22
|
-
end
|
23
|
-
|
24
|
-
include Core::ConfiguredClientMethods
|
25
|
-
|
26
20
|
API_VERSION = '2011-10-01'
|
27
21
|
|
22
|
+
extend Core::Client::QueryXML
|
23
|
+
|
28
24
|
# @private
|
29
|
-
|
25
|
+
CACHEABLE_REQUESTS = Set[]
|
26
|
+
|
27
|
+
## client methods ##
|
28
|
+
|
29
|
+
# Calls the AddPermission API operation.
|
30
|
+
# @method add_permission(options = {})
|
31
|
+
#
|
32
|
+
# === Options:
|
33
|
+
#
|
34
|
+
# * +:queue_url+ - *required* - (String) The URL of the SQS queue to take
|
35
|
+
# action on.
|
36
|
+
# * +:label+ - *required* - (String) The unique identification of the
|
37
|
+
# permission you're setting (e.g., AliceSendMessage). Constraints:
|
38
|
+
# Maximum 80 characters; alphanumeric characters, hyphens (-), and
|
39
|
+
# underscores (_) are allowed.
|
40
|
+
# * +:aws_account_ids+ - *required* - (Array<String>) The AWS account
|
41
|
+
# number of the principal who will be given permission. The principal
|
42
|
+
# must have an AWS account, but does not need to be signed up for
|
43
|
+
# Amazon SQS.
|
44
|
+
# * +:actions+ - *required* - (Array<String>) The action the client wants
|
45
|
+
# to allow for the specified principal.
|
46
|
+
#
|
47
|
+
# === Response Structure:
|
48
|
+
#
|
49
|
+
# This method returns no response data.
|
50
|
+
#
|
51
|
+
# @return [Core::Response]
|
52
|
+
#
|
53
|
+
define_client_method :add_permission, 'AddPermission'
|
54
|
+
|
55
|
+
# Calls the ChangeMessageVisibility API operation.
|
56
|
+
# @method change_message_visibility(options = {})
|
57
|
+
#
|
58
|
+
# === Options:
|
59
|
+
#
|
60
|
+
# * +:queue_url+ - *required* - (String) The URL of the SQS queue to take
|
61
|
+
# action on.
|
62
|
+
# * +:receipt_handle+ - *required* - (String) The receipt handle
|
63
|
+
# associated with the message whose visibility timeout should be
|
64
|
+
# changed.
|
65
|
+
# * +:visibility_timeout+ - *required* - (Integer) The new value (in
|
66
|
+
# seconds) for the message's visibility timeout.
|
67
|
+
#
|
68
|
+
# === Response Structure:
|
69
|
+
#
|
70
|
+
# This method returns no response data.
|
71
|
+
#
|
72
|
+
# @return [Core::Response]
|
73
|
+
#
|
74
|
+
define_client_method :change_message_visibility, 'ChangeMessageVisibility'
|
75
|
+
|
76
|
+
# Calls the ChangeMessageVisibilityBatch API operation.
|
77
|
+
# @method change_message_visibility_batch(options = {})
|
78
|
+
#
|
79
|
+
# === Options:
|
80
|
+
#
|
81
|
+
# * +:queue_url+ - *required* - (String) The URL of the SQS queue to take
|
82
|
+
# action on.
|
83
|
+
# * +:entries+ - *required* - (Array<Hash>) A list of receipt handles of
|
84
|
+
# the messages for which the visibility timeout must be changed.
|
85
|
+
# * +:id+ - *required* - (String) An identifier for this particular
|
86
|
+
# receipt handle. This is used to communicate the result. Note that
|
87
|
+
# the Ids of a batch request need to be unique within the request.
|
88
|
+
# * +:receipt_handle+ - *required* - (String) A receipt handle.
|
89
|
+
# * +:visibility_timeout+ - (Integer) The new value (in seconds) for
|
90
|
+
# the message's visibility timeout.
|
91
|
+
#
|
92
|
+
# === Response Structure:
|
93
|
+
#
|
94
|
+
# * +:successful+ - (Array<Hash>)
|
95
|
+
# * +:id+ - (String)
|
96
|
+
# * +:failed+ - (Array<Hash>)
|
97
|
+
# * +:id+ - (String)
|
98
|
+
# * +:sender_fault+ - (Boolean)
|
99
|
+
# * +:code+ - (String)
|
100
|
+
# * +:message+ - (String)
|
101
|
+
#
|
102
|
+
# @return [Core::Response]
|
103
|
+
#
|
104
|
+
define_client_method :change_message_visibility_batch, 'ChangeMessageVisibilityBatch'
|
105
|
+
|
106
|
+
# Calls the CreateQueue API operation.
|
107
|
+
# @method create_queue(options = {})
|
108
|
+
#
|
109
|
+
# === Options:
|
110
|
+
#
|
111
|
+
# * +:queue_name+ - *required* - (String) The name for the queue to be
|
112
|
+
# created.
|
113
|
+
# * +:attributes+ - (Hash<String,String>) A map of attributes with their
|
114
|
+
# corresponding values.
|
115
|
+
#
|
116
|
+
# === Response Structure:
|
117
|
+
#
|
118
|
+
# * +:queue_url+ - (String)
|
119
|
+
#
|
120
|
+
# @return [Core::Response]
|
121
|
+
#
|
122
|
+
define_client_method :create_queue, 'CreateQueue'
|
123
|
+
|
124
|
+
# Calls the DeleteMessage API operation.
|
125
|
+
# @method delete_message(options = {})
|
126
|
+
#
|
127
|
+
# === Options:
|
128
|
+
#
|
129
|
+
# * +:queue_url+ - *required* - (String) The URL of the SQS queue to take
|
130
|
+
# action on.
|
131
|
+
# * +:receipt_handle+ - *required* - (String) The receipt handle
|
132
|
+
# associated with the message to delete.
|
133
|
+
#
|
134
|
+
# === Response Structure:
|
135
|
+
#
|
136
|
+
# This method returns no response data.
|
137
|
+
#
|
138
|
+
# @return [Core::Response]
|
139
|
+
#
|
140
|
+
define_client_method :delete_message, 'DeleteMessage'
|
141
|
+
|
142
|
+
# Calls the DeleteMessageBatch API operation.
|
143
|
+
# @method delete_message_batch(options = {})
|
144
|
+
#
|
145
|
+
# === Options:
|
146
|
+
#
|
147
|
+
# * +:queue_url+ - *required* - (String) The URL of the SQS queue to take
|
148
|
+
# action on.
|
149
|
+
# * +:entries+ - *required* - (Array<Hash>) A list of receipt handles for
|
150
|
+
# the messages to be deleted.
|
151
|
+
# * +:id+ - *required* - (String) An identifier for this particular
|
152
|
+
# receipt handle. This is used to communicate the result. Note that
|
153
|
+
# the Ids of a batch request need to be unique within the request.
|
154
|
+
# * +:receipt_handle+ - *required* - (String) A receipt handle.
|
155
|
+
#
|
156
|
+
# === Response Structure:
|
157
|
+
#
|
158
|
+
# * +:successful+ - (Array<Hash>)
|
159
|
+
# * +:id+ - (String)
|
160
|
+
# * +:failed+ - (Array<Hash>)
|
161
|
+
# * +:id+ - (String)
|
162
|
+
# * +:sender_fault+ - (Boolean)
|
163
|
+
# * +:code+ - (String)
|
164
|
+
# * +:message+ - (String)
|
165
|
+
#
|
166
|
+
# @return [Core::Response]
|
167
|
+
#
|
168
|
+
define_client_method :delete_message_batch, 'DeleteMessageBatch'
|
169
|
+
|
170
|
+
# Calls the DeleteQueue API operation.
|
171
|
+
# @method delete_queue(options = {})
|
172
|
+
#
|
173
|
+
# === Options:
|
174
|
+
#
|
175
|
+
# * +:queue_url+ - *required* - (String) The URL of the SQS queue to take
|
176
|
+
# action on.
|
177
|
+
#
|
178
|
+
# === Response Structure:
|
179
|
+
#
|
180
|
+
# This method returns no response data.
|
181
|
+
#
|
182
|
+
# @return [Core::Response]
|
183
|
+
#
|
184
|
+
define_client_method :delete_queue, 'DeleteQueue'
|
185
|
+
|
186
|
+
# Calls the GetQueueAttributes API operation.
|
187
|
+
# @method get_queue_attributes(options = {})
|
188
|
+
#
|
189
|
+
# === Options:
|
190
|
+
#
|
191
|
+
# * +:queue_url+ - *required* - (String) The URL of the SQS queue to take
|
192
|
+
# action on.
|
193
|
+
# * +:attribute_names+ - (Array<String>) A list of attributes to retrieve
|
194
|
+
# information for.
|
195
|
+
#
|
196
|
+
# === Response Structure:
|
197
|
+
#
|
198
|
+
# * +:attributes+ - (Hash<String,String>)
|
199
|
+
#
|
200
|
+
# @return [Core::Response]
|
201
|
+
#
|
202
|
+
define_client_method :get_queue_attributes, 'GetQueueAttributes'
|
203
|
+
|
204
|
+
# Calls the GetQueueUrl API operation.
|
205
|
+
# @method get_queue_url(options = {})
|
206
|
+
#
|
207
|
+
# === Options:
|
208
|
+
#
|
209
|
+
# * +:queue_name+ - *required* - (String) The name of the queue whose URL
|
210
|
+
# must be fetched.
|
211
|
+
# * +:queue_owner_aws_account_id+ - (String) The AWS account number of
|
212
|
+
# the queue's owner.
|
213
|
+
#
|
214
|
+
# === Response Structure:
|
215
|
+
#
|
216
|
+
# * +:queue_url+ - (String)
|
217
|
+
#
|
218
|
+
# @return [Core::Response]
|
219
|
+
#
|
220
|
+
define_client_method :get_queue_url, 'GetQueueUrl'
|
221
|
+
|
222
|
+
# Calls the ListQueues API operation.
|
223
|
+
# @method list_queues(options = {})
|
224
|
+
#
|
225
|
+
# === Options:
|
226
|
+
#
|
227
|
+
# * +:queue_name_prefix+ - (String) A string to use for filtering the
|
228
|
+
# list results. Only those queues whose name begins with the specified
|
229
|
+
# string are returned.
|
230
|
+
#
|
231
|
+
# === Response Structure:
|
232
|
+
#
|
233
|
+
# * +:queue_urls+ - (Array<String>)
|
234
|
+
#
|
235
|
+
# @return [Core::Response]
|
236
|
+
#
|
237
|
+
define_client_method :list_queues, 'ListQueues'
|
238
|
+
|
239
|
+
# Calls the ReceiveMessage API operation.
|
240
|
+
# @method receive_message(options = {})
|
241
|
+
#
|
242
|
+
# === Options:
|
243
|
+
#
|
244
|
+
# * +:queue_url+ - *required* - (String) The URL of the SQS queue to take
|
245
|
+
# action on.
|
246
|
+
# * +:attribute_names+ - (Array<String>) A list of attributes to retrieve
|
247
|
+
# information for.
|
248
|
+
# * +:max_number_of_messages+ - (Integer) The maximum number of messages
|
249
|
+
# to return. Amazon SQS never returns more messages than this value but
|
250
|
+
# may return fewer. All of the messages are not necessarily returned.
|
251
|
+
# * +:visibility_timeout+ - (Integer) The duration (in seconds) that the
|
252
|
+
# received messages are hidden from subsequent retrieve requests after
|
253
|
+
# being retrieved by a ReceiveMessage request.
|
254
|
+
#
|
255
|
+
# === Response Structure:
|
256
|
+
#
|
257
|
+
# * +:messages+ - (Array<Hash>)
|
258
|
+
# * +:message_id+ - (String)
|
259
|
+
# * +:receipt_handle+ - (String)
|
260
|
+
# * +:md5_of_body+ - (String)
|
261
|
+
# * +:body+ - (String)
|
262
|
+
# * +:attributes+ - (Hash<String,String>)
|
263
|
+
#
|
264
|
+
# @return [Core::Response]
|
265
|
+
#
|
266
|
+
define_client_method :receive_message, 'ReceiveMessage'
|
267
|
+
|
268
|
+
# Calls the RemovePermission API operation.
|
269
|
+
# @method remove_permission(options = {})
|
270
|
+
#
|
271
|
+
# === Options:
|
272
|
+
#
|
273
|
+
# * +:queue_url+ - *required* - (String) The URL of the SQS queue to take
|
274
|
+
# action on.
|
275
|
+
# * +:label+ - *required* - (String) The identification of the permission
|
276
|
+
# to remove. This is the label added with the AddPermission operation.
|
277
|
+
#
|
278
|
+
# === Response Structure:
|
279
|
+
#
|
280
|
+
# This method returns no response data.
|
281
|
+
#
|
282
|
+
# @return [Core::Response]
|
283
|
+
#
|
284
|
+
define_client_method :remove_permission, 'RemovePermission'
|
285
|
+
|
286
|
+
# Calls the SendMessage API operation.
|
287
|
+
# @method send_message(options = {})
|
288
|
+
#
|
289
|
+
# === Options:
|
290
|
+
#
|
291
|
+
# * +:queue_url+ - *required* - (String) The URL of the SQS queue to take
|
292
|
+
# action on.
|
293
|
+
# * +:message_body+ - *required* - (String) The message to send.
|
294
|
+
# * +:delay_seconds+ - (Integer) The number of seconds the message has to
|
295
|
+
# be delayed.
|
296
|
+
#
|
297
|
+
# === Response Structure:
|
298
|
+
#
|
299
|
+
# * +:md5_of_message_body+ - (String)
|
300
|
+
# * +:message_id+ - (String)
|
301
|
+
#
|
302
|
+
# @return [Core::Response]
|
303
|
+
#
|
304
|
+
define_client_method :send_message, 'SendMessage'
|
305
|
+
|
306
|
+
# Calls the SendMessageBatch API operation.
|
307
|
+
# @method send_message_batch(options = {})
|
308
|
+
#
|
309
|
+
# === Options:
|
310
|
+
#
|
311
|
+
# * +:queue_url+ - *required* - (String) The URL of the SQS queue to take
|
312
|
+
# action on.
|
313
|
+
# * +:entries+ - *required* - (Array<Hash>) A list of
|
314
|
+
# SendMessageBatchRequestEntrys.
|
315
|
+
# * +:id+ - *required* - (String) An identifier for the message in this
|
316
|
+
# batch. This is used to communicate the result. Note that the the
|
317
|
+
# Ids of a batch request need to be unique within the request.
|
318
|
+
# * +:message_body+ - *required* - (String) Body of the message.
|
319
|
+
# * +:delay_seconds+ - (Integer) The number of seconds for which the
|
320
|
+
# message has to be delayed.
|
321
|
+
#
|
322
|
+
# === Response Structure:
|
323
|
+
#
|
324
|
+
# * +:successful+ - (Array<Hash>)
|
325
|
+
# * +:id+ - (String)
|
326
|
+
# * +:message_id+ - (String)
|
327
|
+
# * +:md5_of_message_body+ - (String)
|
328
|
+
# * +:failed+ - (Array<Hash>)
|
329
|
+
# * +:id+ - (String)
|
330
|
+
# * +:sender_fault+ - (Boolean)
|
331
|
+
# * +:code+ - (String)
|
332
|
+
# * +:message+ - (String)
|
333
|
+
#
|
334
|
+
# @return [Core::Response]
|
335
|
+
#
|
336
|
+
define_client_method :send_message_batch, 'SendMessageBatch'
|
337
|
+
|
338
|
+
# Calls the SetQueueAttributes API operation.
|
339
|
+
# @method set_queue_attributes(options = {})
|
340
|
+
#
|
341
|
+
# === Options:
|
342
|
+
#
|
343
|
+
# * +:queue_url+ - *required* - (String) The URL of the SQS queue to take
|
344
|
+
# action on.
|
345
|
+
# * +:attributes+ - *required* - (Hash<String,String>) A map of
|
346
|
+
# attributes to set.
|
347
|
+
#
|
348
|
+
# === Response Structure:
|
349
|
+
#
|
350
|
+
# This method returns no response data.
|
351
|
+
#
|
352
|
+
# @return [Core::Response]
|
353
|
+
#
|
354
|
+
define_client_method :set_queue_attributes, 'SetQueueAttributes'
|
30
355
|
|
31
|
-
|
356
|
+
## end client methods ##
|
32
357
|
|
33
358
|
end
|
34
359
|
end
|