Current section
Files
Jump to
Current section
Files
src/aws_sqs.erl
%% WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
%% See https://github.com/aws-beam/aws-codegen for more details.
%% @doc Welcome to the Amazon SQS API Reference.
%%
%% Amazon SQS is a reliable, highly-scalable hosted queue for storing
%% messages as they travel between applications or microservices. Amazon SQS
%% moves data between distributed application components and helps you
%% decouple these components.
%%
%% For information on the permissions you need to use this API, see Identity
%% and access management in the Amazon SQS Developer Guide.
%%
%% You can use Amazon Web Services SDKs to access Amazon SQS using your
%% favorite programming language. The SDKs perform tasks such as the
%% following automatically:
%%
%% <ul> <li> Cryptographically sign your service requests
%%
%% </li> <li> Retry requests
%%
%% </li> <li> Handle error responses
%%
%% </li> </ul> Additional information
%%
%% <ul> <li> Amazon SQS Product Page
%%
%% </li> <li> Amazon SQS Developer Guide
%%
%% <ul> <li> Making API Requests
%%
%% </li> <li> Amazon SQS Message Attributes
%%
%% </li> <li> Amazon SQS Dead-Letter Queues
%%
%% </li> </ul> </li> <li> Amazon SQS in the Command Line Interface
%%
%% </li> <li> Amazon Web Services General Reference
%%
%% <ul> <li> Regions and Endpoints
%%
%% </li> </ul> </li> </ul>
-module(aws_sqs).
-export([add_permission/2,
add_permission/3,
change_message_visibility/2,
change_message_visibility/3,
change_message_visibility_batch/2,
change_message_visibility_batch/3,
create_queue/2,
create_queue/3,
delete_message/2,
delete_message/3,
delete_message_batch/2,
delete_message_batch/3,
delete_queue/2,
delete_queue/3,
get_queue_attributes/2,
get_queue_attributes/3,
get_queue_url/2,
get_queue_url/3,
list_dead_letter_source_queues/2,
list_dead_letter_source_queues/3,
list_queue_tags/2,
list_queue_tags/3,
list_queues/2,
list_queues/3,
purge_queue/2,
purge_queue/3,
receive_message/2,
receive_message/3,
remove_permission/2,
remove_permission/3,
send_message/2,
send_message/3,
send_message_batch/2,
send_message_batch/3,
set_queue_attributes/2,
set_queue_attributes/3,
tag_queue/2,
tag_queue/3,
untag_queue/2,
untag_queue/3]).
-include_lib("hackney/include/hackney_lib.hrl").
%%====================================================================
%% API
%%====================================================================
%% @doc Adds a permission to a queue for a specific principal.
%%
%% This allows sharing access to the queue.
%%
%% When you create a queue, you have full control access rights for the
%% queue. Only you, the owner of the queue, can grant or deny permissions to
%% the queue. For more information about these permissions, see Allow
%% Developers to Write Messages to a Shared Queue in the Amazon SQS Developer
%% Guide.
%%
%% `AddPermission' generates a policy for you. You can use `
%% `SetQueueAttributes' ' to upload your policy. For more
%% information, see Using Custom Policies with the Amazon SQS Access Policy
%% Language in the Amazon SQS Developer Guide.
%%
%% An Amazon SQS policy can have a maximum of 7 actions.
%%
%% To remove the ability to change queue permissions, you must deny
%% permission to the `AddPermission', `RemovePermission', and
%% `SetQueueAttributes' actions in your IAM policy.
%%
%% Some actions take lists of parameters. These lists are specified using the
%% `param.n' notation. Values of `n' are integers starting from 1.
%% For example, a parameter list with two elements looks like this:
%%
%% `&AttributeName.1=first'
%%
%% `&AttributeName.2=second'
%%
%% Cross-account permissions don't apply to this action. For more
%% information, see Grant cross-account permissions to a role and a user name
%% in the Amazon SQS Developer Guide.
add_permission(Client, Input)
when is_map(Client), is_map(Input) ->
add_permission(Client, Input, []).
add_permission(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"AddPermission">>, Input, Options).
%% @doc Changes the visibility timeout of a specified message in a queue to a
%% new value.
%%
%% The default visibility timeout for a message is 30 seconds. The minimum is
%% 0 seconds. The maximum is 12 hours. For more information, see Visibility
%% Timeout in the Amazon SQS Developer Guide.
%%
%% For example, you have a message with a visibility timeout of 5 minutes.
%% After 3 minutes, you call `ChangeMessageVisibility' with a timeout of
%% 10 minutes. You can continue to call `ChangeMessageVisibility' to
%% extend the visibility timeout to the maximum allowed time. If you try to
%% extend the visibility timeout beyond the maximum, your request is
%% rejected.
%%
%% An Amazon SQS message has three basic states:
%%
%% <ol> <li> Sent to a queue by a producer.
%%
%% </li> <li> Received from the queue by a consumer.
%%
%% </li> <li> Deleted from the queue.
%%
%% </li> </ol> A message is considered to be stored after it is sent to a
%% queue by a producer, but not yet received from the queue by a consumer
%% (that is, between states 1 and 2). There is no limit to the number of
%% stored messages. A message is considered to be in flight after it is
%% received from a queue by a consumer, but not yet deleted from the queue
%% (that is, between states 2 and 3). There is a limit to the number of
%% inflight messages.
%%
%% Limits that apply to inflight messages are unrelated to the unlimited
%% number of stored messages.
%%
%% For most standard queues (depending on queue traffic and message backlog),
%% there can be a maximum of approximately 120,000 inflight messages
%% (received from a queue by a consumer, but not yet deleted from the queue).
%% If you reach this limit, Amazon SQS returns the `OverLimit' error
%% message. To avoid reaching the limit, you should delete messages from the
%% queue after they're processed. You can also increase the number of
%% queues you use to process your messages. To request a limit increase, file
%% a support request.
%%
%% For FIFO queues, there can be a maximum of 20,000 inflight messages
%% (received from a queue by a consumer, but not yet deleted from the queue).
%% If you reach this limit, Amazon SQS returns no error messages.
%%
%% If you attempt to set the `VisibilityTimeout' to a value greater than
%% the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't
%% automatically recalculate and increase the timeout to the maximum
%% remaining time.
%%
%% Unlike with a queue, when you change the visibility timeout for a specific
%% message the timeout value is applied immediately but isn't saved in
%% memory for that message. If you don't delete a message after it is
%% received, the visibility timeout for the message reverts to the original
%% timeout value (not to the value you set using the
%% `ChangeMessageVisibility' action) the next time the message is
%% received.
change_message_visibility(Client, Input)
when is_map(Client), is_map(Input) ->
change_message_visibility(Client, Input, []).
change_message_visibility(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ChangeMessageVisibility">>, Input, Options).
%% @doc Changes the visibility timeout of multiple messages.
%%
%% This is a batch version of ` `ChangeMessageVisibility'.' The
%% result of the action on each message is reported individually in the
%% response. You can send up to 10 ` `ChangeMessageVisibility' '
%% requests with each `ChangeMessageVisibilityBatch' action.
%%
%% Because the batch request can result in a combination of successful and
%% unsuccessful actions, you should check for batch errors even when the call
%% returns an HTTP status code of `200'.
%%
%% Some actions take lists of parameters. These lists are specified using the
%% `param.n' notation. Values of `n' are integers starting from 1.
%% For example, a parameter list with two elements looks like this:
%%
%% `&AttributeName.1=first'
%%
%% `&AttributeName.2=second'
change_message_visibility_batch(Client, Input)
when is_map(Client), is_map(Input) ->
change_message_visibility_batch(Client, Input, []).
change_message_visibility_batch(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ChangeMessageVisibilityBatch">>, Input, Options).
%% @doc Creates a new standard or FIFO queue.
%%
%% You can pass one or more attributes in the request. Keep the following in
%% mind:
%%
%% <ul> <li> If you don't specify the `FifoQueue' attribute, Amazon
%% SQS creates a standard queue.
%%
%% You can't change the queue type after you create it and you can't
%% convert an existing standard queue into a FIFO queue. You must either
%% create a new FIFO queue for your application or delete your existing
%% standard queue and recreate it as a FIFO queue. For more information, see
%% Moving From a Standard Queue to a FIFO Queue in the Amazon SQS Developer
%% Guide.
%%
%% </li> <li> If you don't provide a value for an attribute, the queue is
%% created with the default value for the attribute.
%%
%% </li> <li> If you delete a queue, you must wait at least 60 seconds before
%% creating a queue with the same name.
%%
%% </li> </ul> To successfully create a new queue, you must provide a queue
%% name that adheres to the limits related to queues and is unique within the
%% scope of your queues.
%%
%% After you create a queue, you must wait at least one second after the
%% queue is created to be able to use the queue.
%%
%% To get the queue URL, use the ` `GetQueueUrl' ' action. `
%% `GetQueueUrl' ' requires only the `QueueName' parameter. be
%% aware of existing queue names:
%%
%% <ul> <li> If you provide the name of an existing queue along with the
%% exact names and values of all the queue's attributes,
%% `CreateQueue' returns the queue URL for the existing queue.
%%
%% </li> <li> If the queue name, attribute names, or attribute values
%% don't match an existing queue, `CreateQueue' returns an error.
%%
%% </li> </ul> Some actions take lists of parameters. These lists are
%% specified using the `param.n' notation. Values of `n' are integers
%% starting from 1. For example, a parameter list with two elements looks
%% like this:
%%
%% `&AttributeName.1=first'
%%
%% `&AttributeName.2=second'
%%
%% Cross-account permissions don't apply to this action. For more
%% information, see Grant cross-account permissions to a role and a user name
%% in the Amazon SQS Developer Guide.
create_queue(Client, Input)
when is_map(Client), is_map(Input) ->
create_queue(Client, Input, []).
create_queue(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"CreateQueue">>, Input, Options).
%% @doc Deletes the specified message from the specified queue.
%%
%% To select the message to delete, use the `ReceiptHandle' of the
%% message (not the `MessageId' which you receive when you send the
%% message). Amazon SQS can delete a message from a queue even if a
%% visibility timeout setting causes the message to be locked by another
%% consumer. Amazon SQS automatically deletes messages left in a queue longer
%% than the retention period configured for the queue.
%%
%% The `ReceiptHandle' is associated with a specific instance of
%% receiving a message. If you receive a message more than once, the
%% `ReceiptHandle' is different each time you receive a message. When you
%% use the `DeleteMessage' action, you must provide the most recently
%% received `ReceiptHandle' for the message (otherwise, the request
%% succeeds, but the message might not be deleted).
%%
%% For standard queues, it is possible to receive a message even after you
%% delete it. This might happen on rare occasions if one of the servers which
%% stores a copy of the message is unavailable when you send the request to
%% delete the message. The copy remains on the server and might be returned
%% to you during a subsequent receive request. You should ensure that your
%% application is idempotent, so that receiving a message more than once does
%% not cause issues.
delete_message(Client, Input)
when is_map(Client), is_map(Input) ->
delete_message(Client, Input, []).
delete_message(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DeleteMessage">>, Input, Options).
%% @doc Deletes up to ten messages from the specified queue.
%%
%% This is a batch version of ` `DeleteMessage'.' The result of the
%% action on each message is reported individually in the response.
%%
%% Because the batch request can result in a combination of successful and
%% unsuccessful actions, you should check for batch errors even when the call
%% returns an HTTP status code of `200'.
%%
%% Some actions take lists of parameters. These lists are specified using the
%% `param.n' notation. Values of `n' are integers starting from 1.
%% For example, a parameter list with two elements looks like this:
%%
%% `&AttributeName.1=first'
%%
%% `&AttributeName.2=second'
delete_message_batch(Client, Input)
when is_map(Client), is_map(Input) ->
delete_message_batch(Client, Input, []).
delete_message_batch(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DeleteMessageBatch">>, Input, Options).
%% @doc Deletes the queue specified by the `QueueUrl', regardless of the
%% queue's contents.
%%
%% Be careful with the `DeleteQueue' action: When you delete a queue, any
%% messages in the queue are no longer available.
%%
%% When you delete a queue, the deletion process takes up to 60 seconds.
%% Requests you send involving that queue during the 60 seconds might
%% succeed. For example, a ` `SendMessage' ' request might succeed,
%% but after 60 seconds the queue and the message you sent no longer exist.
%%
%% When you delete a queue, you must wait at least 60 seconds before creating
%% a queue with the same name.
%%
%% Cross-account permissions don't apply to this action. For more
%% information, see Grant cross-account permissions to a role and a user name
%% in the Amazon SQS Developer Guide.
delete_queue(Client, Input)
when is_map(Client), is_map(Input) ->
delete_queue(Client, Input, []).
delete_queue(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DeleteQueue">>, Input, Options).
%% @doc Gets attributes for the specified queue.
%%
%% To determine whether a queue is FIFO, you can check whether
%% `QueueName' ends with the `.fifo' suffix.
get_queue_attributes(Client, Input)
when is_map(Client), is_map(Input) ->
get_queue_attributes(Client, Input, []).
get_queue_attributes(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"GetQueueAttributes">>, Input, Options).
%% @doc Returns the URL of an existing Amazon SQS queue.
%%
%% To access a queue that belongs to another AWS account, use the
%% `QueueOwnerAWSAccountId' parameter to specify the account ID of the
%% queue's owner. The queue's owner must grant you permission to
%% access the queue. For more information about shared queue access, see `
%% `AddPermission' ' or see Allow Developers to Write Messages to a
%% Shared Queue in the Amazon SQS Developer Guide.
get_queue_url(Client, Input)
when is_map(Client), is_map(Input) ->
get_queue_url(Client, Input, []).
get_queue_url(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"GetQueueUrl">>, Input, Options).
%% @doc Returns a list of your queues that have the `RedrivePolicy' queue
%% attribute configured with a dead-letter queue.
%%
%% The `ListDeadLetterSourceQueues' methods supports pagination. Set
%% parameter `MaxResults' in the request to specify the maximum number of
%% results to be returned in the response. If you do not set
%% `MaxResults', the response includes a maximum of 1,000 results. If you
%% set `MaxResults' and there are additional results to display, the
%% response includes a value for `NextToken'. Use `NextToken' as a
%% parameter in your next request to `ListDeadLetterSourceQueues' to
%% receive the next page of results.
%%
%% For more information about using dead-letter queues, see Using Amazon SQS
%% Dead-Letter Queues in the Amazon SQS Developer Guide.
list_dead_letter_source_queues(Client, Input)
when is_map(Client), is_map(Input) ->
list_dead_letter_source_queues(Client, Input, []).
list_dead_letter_source_queues(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ListDeadLetterSourceQueues">>, Input, Options).
%% @doc List all cost allocation tags added to the specified Amazon SQS
%% queue.
%%
%% For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS
%% Developer Guide.
%%
%% Cross-account permissions don't apply to this action. For more
%% information, see Grant cross-account permissions to a role and a user name
%% in the Amazon SQS Developer Guide.
list_queue_tags(Client, Input)
when is_map(Client), is_map(Input) ->
list_queue_tags(Client, Input, []).
list_queue_tags(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ListQueueTags">>, Input, Options).
%% @doc Returns a list of your queues in the current region.
%%
%% The response includes a maximum of 1,000 results. If you specify a value
%% for the optional `QueueNamePrefix' parameter, only queues with a name
%% that begins with the specified value are returned.
%%
%% The `listQueues' methods supports pagination. Set parameter
%% `MaxResults' in the request to specify the maximum number of results
%% to be returned in the response. If you do not set `MaxResults', the
%% response includes a maximum of 1,000 results. If you set `MaxResults'
%% and there are additional results to display, the response includes a value
%% for `NextToken'. Use `NextToken' as a parameter in your next
%% request to `listQueues' to receive the next page of results.
%%
%% Cross-account permissions don't apply to this action. For more
%% information, see Grant cross-account permissions to a role and a user name
%% in the Amazon SQS Developer Guide.
list_queues(Client, Input)
when is_map(Client), is_map(Input) ->
list_queues(Client, Input, []).
list_queues(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ListQueues">>, Input, Options).
%% @doc Deletes the messages in a queue specified by the `QueueURL'
%% parameter.
%%
%% When you use the `PurgeQueue' action, you can't retrieve any
%% messages deleted from a queue.
%%
%% The message deletion process takes up to 60 seconds. We recommend waiting
%% for 60 seconds regardless of your queue's size.
%%
%% Messages sent to the queue before you call `PurgeQueue' might be
%% received but are deleted within the next minute.
%%
%% Messages sent to the queue after you call `PurgeQueue' might be
%% deleted while the queue is being purged.
purge_queue(Client, Input)
when is_map(Client), is_map(Input) ->
purge_queue(Client, Input, []).
purge_queue(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"PurgeQueue">>, Input, Options).
%% @doc Retrieves one or more messages (up to 10), from the specified queue.
%%
%% Using the `WaitTimeSeconds' parameter enables long-poll support. For
%% more information, see Amazon SQS Long Polling in the Amazon SQS Developer
%% Guide.
%%
%% Short poll is the default behavior where a weighted random set of machines
%% is sampled on a `ReceiveMessage' call. Thus, only the messages on the
%% sampled machines are returned. If the number of messages in the queue is
%% small (fewer than 1,000), you most likely get fewer messages than you
%% requested per `ReceiveMessage' call. If the number of messages in the
%% queue is extremely small, you might not receive any messages in a
%% particular `ReceiveMessage' response. If this happens, repeat the
%% request.
%%
%% For each message returned, the response includes the following:
%%
%% <ul> <li> The message body.
%%
%% </li> <li> An MD5 digest of the message body. For information about MD5,
%% see RFC1321.
%%
%% </li> <li> The `MessageId' you received when you sent the message to
%% the queue.
%%
%% </li> <li> The receipt handle.
%%
%% </li> <li> The message attributes.
%%
%% </li> <li> An MD5 digest of the message attributes.
%%
%% </li> </ul> The receipt handle is the identifier you must provide when
%% deleting the message. For more information, see Queue and Message
%% Identifiers in the Amazon SQS Developer Guide.
%%
%% You can provide the `VisibilityTimeout' parameter in your request. The
%% parameter is applied to the messages that Amazon SQS returns in the
%% response. If you don't include the parameter, the overall visibility
%% timeout for the queue is used for the returned messages. For more
%% information, see Visibility Timeout in the Amazon SQS Developer Guide.
%%
%% A message that isn't deleted or a message whose visibility isn't
%% extended before the visibility timeout expires counts as a failed receive.
%% Depending on the configuration of the queue, the message might be sent to
%% the dead-letter queue.
%%
%% In the future, new attributes might be added. If you write code that calls
%% this action, we recommend that you structure your code so that it can
%% handle new attributes gracefully.
receive_message(Client, Input)
when is_map(Client), is_map(Input) ->
receive_message(Client, Input, []).
receive_message(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ReceiveMessage">>, Input, Options).
%% @doc Revokes any permissions in the queue policy that matches the
%% specified `Label' parameter.
%%
%% Only the owner of a queue can remove permissions from it.
%%
%% Cross-account permissions don't apply to this action. For more
%% information, see Grant cross-account permissions to a role and a user name
%% in the Amazon SQS Developer Guide.
%%
%% To remove the ability to change queue permissions, you must deny
%% permission to the `AddPermission', `RemovePermission', and
%% `SetQueueAttributes' actions in your IAM policy.
remove_permission(Client, Input)
when is_map(Client), is_map(Input) ->
remove_permission(Client, Input, []).
remove_permission(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"RemovePermission">>, Input, Options).
%% @doc Delivers a message to the specified queue.
%%
%% A message can include only XML, JSON, and unformatted text. The following
%% Unicode characters are allowed:
%%
%% `#x9' | `#xA' | `#xD' | `#x20' to `#xD7FF' |
%% `#xE000' to `#xFFFD' | `#x10000' to `#x10FFFF'
%%
%% Any characters not included in this list will be rejected. For more
%% information, see the W3C specification for characters.
send_message(Client, Input)
when is_map(Client), is_map(Input) ->
send_message(Client, Input, []).
send_message(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"SendMessage">>, Input, Options).
%% @doc Delivers up to ten messages to the specified queue.
%%
%% This is a batch version of ` `SendMessage'.' For a FIFO queue,
%% multiple messages within a single batch are enqueued in the order they are
%% sent.
%%
%% The result of sending each message is reported individually in the
%% response. Because the batch request can result in a combination of
%% successful and unsuccessful actions, you should check for batch errors
%% even when the call returns an HTTP status code of `200'.
%%
%% The maximum allowed individual message size and the maximum total payload
%% size (the sum of the individual lengths of all of the batched messages)
%% are both 256 KB (262,144 bytes).
%%
%% A message can include only XML, JSON, and unformatted text. The following
%% Unicode characters are allowed:
%%
%% `#x9' | `#xA' | `#xD' | `#x20' to `#xD7FF' |
%% `#xE000' to `#xFFFD' | `#x10000' to `#x10FFFF'
%%
%% Any characters not included in this list will be rejected. For more
%% information, see the W3C specification for characters.
%%
%% If you don't specify the `DelaySeconds' parameter for an entry,
%% Amazon SQS uses the default value for the queue.
%%
%% Some actions take lists of parameters. These lists are specified using the
%% `param.n' notation. Values of `n' are integers starting from 1.
%% For example, a parameter list with two elements looks like this:
%%
%% `&AttributeName.1=first'
%%
%% `&AttributeName.2=second'
send_message_batch(Client, Input)
when is_map(Client), is_map(Input) ->
send_message_batch(Client, Input, []).
send_message_batch(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"SendMessageBatch">>, Input, Options).
%% @doc Sets the value of one or more queue attributes.
%%
%% When you change a queue's attributes, the change can take up to 60
%% seconds for most of the attributes to propagate throughout the Amazon SQS
%% system. Changes made to the `MessageRetentionPeriod' attribute can
%% take up to 15 minutes.
%%
%% In the future, new attributes might be added. If you write code that calls
%% this action, we recommend that you structure your code so that it can
%% handle new attributes gracefully.
%%
%% Cross-account permissions don't apply to this action. For more
%% information, see Grant cross-account permissions to a role and a user name
%% in the Amazon SQS Developer Guide.
%%
%% To remove the ability to change queue permissions, you must deny
%% permission to the `AddPermission', `RemovePermission', and
%% `SetQueueAttributes' actions in your IAM policy.
set_queue_attributes(Client, Input)
when is_map(Client), is_map(Input) ->
set_queue_attributes(Client, Input, []).
set_queue_attributes(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"SetQueueAttributes">>, Input, Options).
%% @doc Add cost allocation tags to the specified Amazon SQS queue.
%%
%% For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS
%% Developer Guide.
%%
%% When you use queue tags, keep the following guidelines in mind:
%%
%% <ul> <li> Adding more than 50 tags to a queue isn't recommended.
%%
%% </li> <li> Tags don't have any semantic meaning. Amazon SQS interprets
%% tags as character strings.
%%
%% </li> <li> Tags are case-sensitive.
%%
%% </li> <li> A new tag with a key identical to that of an existing tag
%% overwrites the existing tag.
%%
%% </li> </ul> For a full list of tag restrictions, see Quotas related to
%% queues in the Amazon SQS Developer Guide.
%%
%% Cross-account permissions don't apply to this action. For more
%% information, see Grant cross-account permissions to a role and a user name
%% in the Amazon SQS Developer Guide.
tag_queue(Client, Input)
when is_map(Client), is_map(Input) ->
tag_queue(Client, Input, []).
tag_queue(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"TagQueue">>, Input, Options).
%% @doc Remove cost allocation tags from the specified Amazon SQS queue.
%%
%% For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS
%% Developer Guide.
%%
%% Cross-account permissions don't apply to this action. For more
%% information, see Grant cross-account permissions to a role and a user name
%% in the Amazon SQS Developer Guide.
untag_queue(Client, Input)
when is_map(Client), is_map(Input) ->
untag_queue(Client, Input, []).
untag_queue(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UntagQueue">>, Input, Options).
%%====================================================================
%% Internal functions
%%====================================================================
-spec request(aws_client:aws_client(), binary(), map(), list()) ->
{ok, Result, {integer(), list(), hackney:client()}} |
{error, Error, {integer(), list(), hackney:client()}} |
{error, term()} when
Result :: map() | undefined,
Error :: map().
request(Client, Action, Input, Options) ->
RequestFun = fun() -> do_request(Client, Action, Input, Options) end,
aws_request:request(RequestFun, Options).
do_request(Client, Action, Input0, Options) ->
Client1 = Client#{service => <<"sqs">>},
Host = build_host(<<"sqs">>, Client1),
URL = build_url(Host, Client1),
Headers = [
{<<"Host">>, Host},
{<<"Content-Type">>, <<"application/x-www-form-urlencoded">>}
],
Input = Input0#{ <<"Action">> => Action
, <<"Version">> => <<"2012-11-05">>
},
Payload = aws_util:encode_query(Input),
SignedHeaders = aws_request:sign_request(Client1, <<"POST">>, URL, Headers, Payload),
Response = hackney:request(post, URL, SignedHeaders, Payload, Options),
handle_response(Response).
handle_response({ok, 200, ResponseHeaders, Client}) ->
case hackney:body(Client) of
{ok, <<>>} ->
{ok, undefined, {200, ResponseHeaders, Client}};
{ok, Body} ->
Result = aws_util:decode_xml(Body),
{ok, Result, {200, ResponseHeaders, Client}}
end;
handle_response({ok, StatusCode, ResponseHeaders, Client}) ->
{ok, Body} = hackney:body(Client),
Error = aws_util:decode_xml(Body),
{error, Error, {StatusCode, ResponseHeaders, Client}};
handle_response({error, Reason}) ->
{error, Reason}.
build_host(_EndpointPrefix, #{region := <<"local">>, endpoint := Endpoint}) ->
Endpoint;
build_host(_EndpointPrefix, #{region := <<"local">>}) ->
<<"localhost">>;
build_host(EndpointPrefix, #{region := Region, endpoint := Endpoint}) ->
aws_util:binary_join([EndpointPrefix, Region, Endpoint], <<".">>).
build_url(Host, Client) ->
Proto = maps:get(proto, Client),
Port = maps:get(port, Client),
aws_util:binary_join([Proto, <<"://">>, Host, <<":">>, Port, <<"/">>], <<"">>).