Struct aws_sdk_sqs::Client

pub struct Client { /* private fields */ }

Client for Amazon Simple Queue Service

Client for invoking operations on Amazon Simple Queue Service. Each operation on Amazon Simple Queue Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_sqs::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = aws_config::load_from_env().await;
let config = aws_sdk_sqs::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AddPermission operation has a Client::add_permission, function which returns a builder for that operation. The fluent builder ultimately has a call() function that returns an async future that returns a result, as illustrated below:

let result = client.add_permission()
    .queue_url("example")
    .call()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn add_permission(&self) -> AddPermissionFluentBuilder

Constructs a fluent builder for the AddPermission operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the Amazon SQS queue to which permissions are added.

    Queue URLs and names are case-sensitive.

  • label(impl Into<String>) / set_label(Option<String>):

    The unique identification of the permission you’re setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

  • aws_account_ids(Vec<String>) / set_aws_account_ids(Option<Vec<String>>):

    The Amazon Web Services account numbers of the principals who are to receive permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.

  • actions(Vec<String>) / set_actions(Option<Vec<String>>):

    The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

    For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.

    Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

• On success, responds with AddPermissionOutput
• On failure, responds with SdkError<AddPermissionError>

impl Client

pub fn change_message_visibility(&self) -> ChangeMessageVisibilityFluentBuilder

Constructs a fluent builder for the ChangeMessageVisibility operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the Amazon SQS queue whose message’s visibility is changed.

    Queue URLs and names are case-sensitive.

  • receipt_handle(impl Into<String>) / set_receipt_handle(Option<String>):

    The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the ReceiveMessage action.

  • visibility_timeout(i32) / set_visibility_timeout(i32):

    The new value for the message’s visibility timeout (in seconds). Values range: 0 to 43200. Maximum: 12 hours.

• On success, responds with ChangeMessageVisibilityOutput
• On failure, responds with SdkError<ChangeMessageVisibilityError>

impl Client

pub fn change_message_visibility_batch( &self ) -> ChangeMessageVisibilityBatchFluentBuilder

Constructs a fluent builder for the ChangeMessageVisibilityBatch operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the Amazon SQS queue whose messages’ visibility is changed.

    Queue URLs and names are case-sensitive.

  • entries(Vec<ChangeMessageVisibilityBatchRequestEntry>) / set_entries(Option<Vec<ChangeMessageVisibilityBatchRequestEntry>>):

    A list of receipt handles of the messages for which the visibility timeout must be changed.

• On success, responds with ChangeMessageVisibilityBatchOutput with field(s):
  • successful(Option<Vec<ChangeMessageVisibilityBatchResultEntry>>):

    A list of ChangeMessageVisibilityBatchResultEntry items.

  • failed(Option<Vec<BatchResultErrorEntry>>):

    A list of BatchResultErrorEntry items.

• On failure, responds with SdkError<ChangeMessageVisibilityBatchError>

impl Client

pub fn create_queue(&self) -> CreateQueueFluentBuilder

Constructs a fluent builder for the CreateQueue operation.

• The fluent builder is configurable:
  • queue_name(impl Into<String>) / set_queue_name(Option<String>):

    The name of the new queue. The following limits apply to this name:

    • A queue name can have up to 80 characters.

    • Valid values: alphanumeric characters, hyphens (-), and underscores (_).

    • A FIFO queue name must end with the .fifo suffix.

    Queue URLs and names are case-sensitive.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    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:

    • Adding more than 50 tags to a queue isn’t recommended.

    • Tags don’t have any semantic meaning. Amazon SQS interprets tags as character strings.

    • Tags are case-sensitive.

    • A new tag with a key identical to that of an existing tag overwrites the existing tag.

    For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide.

    To be able to tag a queue on creation, you must have the sqs:CreateQueue and sqs:TagQueue permissions.

    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.

  • attributes(HashMap<QueueAttributeName, String>) / set_attributes(Option<HashMap<QueueAttributeName, String>>):

    A map of attributes with their corresponding values.

    The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:

    • DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.

    • MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).

    • MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).

    • Policy – The queue’s policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Amazon IAM User Guide.

    • ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.

    • RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide.

      • deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

      • maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.

      The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.

    • VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

    The following attributes apply only to server-side-encryption:

    • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the Key Management Service API Reference.

    • KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.

    • SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).

    The following attributes apply only to FIFO (first-in-first-out) queues:

    • FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you don’t specify the FifoQueue attribute, Amazon SQS creates a standard queue. You can provide this attribute only during queue creation. You can’t change it for an existing queue. When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.

      For more information, see FIFO queue logic in the Amazon SQS Developer Guide.

    • ContentBasedDeduplication – Enables content-based deduplication. Valid values are true and false. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following:

      • Every message must have a unique MessageDeduplicationId.

        • You may provide a MessageDeduplicationId explicitly.

        • If you aren’t able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

        • If you don’t provide a MessageDeduplicationId and the queue doesn’t have ContentBasedDeduplication set, the action fails with an error.

        • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

      • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

      • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

    The following attributes apply only to high throughput for FIFO queues:

    • DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.

    • FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

    To enable high throughput for FIFO queues, do the following:

    • Set DeduplicationScope to messageGroup.

    • Set FifoThroughputLimit to perMessageGroupId.

    If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified.

    For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.

• On success, responds with CreateQueueOutput with field(s):
  • queue_url(Option<String>):

    The URL of the created Amazon SQS queue.

• On failure, responds with SdkError<CreateQueueError>

impl Client

pub fn delete_message(&self) -> DeleteMessageFluentBuilder

Constructs a fluent builder for the DeleteMessage operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the Amazon SQS queue from which messages are deleted.

    Queue URLs and names are case-sensitive.

  • receipt_handle(impl Into<String>) / set_receipt_handle(Option<String>):

    The receipt handle associated with the message to delete.

• On success, responds with DeleteMessageOutput
• On failure, responds with SdkError<DeleteMessageError>

impl Client

pub fn delete_message_batch(&self) -> DeleteMessageBatchFluentBuilder

Constructs a fluent builder for the DeleteMessageBatch operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the Amazon SQS queue from which messages are deleted.

    Queue URLs and names are case-sensitive.

  • entries(Vec<DeleteMessageBatchRequestEntry>) / set_entries(Option<Vec<DeleteMessageBatchRequestEntry>>):

    A list of receipt handles for the messages to be deleted.

• On success, responds with DeleteMessageBatchOutput with field(s):
  • successful(Option<Vec<DeleteMessageBatchResultEntry>>):

    A list of DeleteMessageBatchResultEntry items.

  • failed(Option<Vec<BatchResultErrorEntry>>):

    A list of BatchResultErrorEntry items.

• On failure, responds with SdkError<DeleteMessageBatchError>

impl Client

pub fn delete_queue(&self) -> DeleteQueueFluentBuilder

Constructs a fluent builder for the DeleteQueue operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the Amazon SQS queue to delete.

    Queue URLs and names are case-sensitive.

• On success, responds with DeleteQueueOutput
• On failure, responds with SdkError<DeleteQueueError>

impl Client

pub fn get_queue_attributes(&self) -> GetQueueAttributesFluentBuilder

Constructs a fluent builder for the GetQueueAttributes operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the Amazon SQS queue whose attribute information is retrieved.

    Queue URLs and names are case-sensitive.

  • attribute_names(Vec<QueueAttributeName>) / set_attribute_names(Option<Vec<QueueAttributeName>>):

    A list of attributes for which to retrieve information.

    The AttributeName.N parameter is optional, but if you don’t specify values for this parameter, the request returns empty results.

    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.

    The following attributes are supported:

    The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and ApproximateNumberOfMessagesVisible metrics may not achieve consistency until at least 1 minute after the producers stop sending messages. This period is required for the queue metadata to reach eventual consistency.

    • All – Returns all values.

    • ApproximateNumberOfMessages – Returns the approximate number of messages available for retrieval from the queue.

    • ApproximateNumberOfMessagesDelayed – Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.

    • ApproximateNumberOfMessagesNotVisible – Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.

    • CreatedTimestamp – Returns the time when the queue was created in seconds (epoch time).

    • DelaySeconds – Returns the default delay on the queue in seconds.

    • LastModifiedTimestamp – Returns the time when the queue was last changed in seconds (epoch time).

    • MaximumMessageSize – Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

    • MessageRetentionPeriod – Returns the length of time, in seconds, for which Amazon SQS retains a message.

    • Policy – Returns the policy of the queue.

    • QueueArn – Returns the Amazon resource name (ARN) of the queue.

    • ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

    • RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide.

      • deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

      • maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.

    • VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

    The following attributes apply only to server-side-encryption:

    • KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

    • KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. For more information, see How Does the Data Key Reuse Period Work?.

    • SqsManagedSseEnabled – Returns information about whether the queue is using SSE-SQS encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).

    The following attributes apply only to FIFO (first-in-first-out) queues:

    • FifoQueue – Returns information about whether the queue is FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer Guide.

      To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

    • ContentBasedDeduplication – Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.

    The following attributes apply only to high throughput for FIFO queues:

    • DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.

    • FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

    To enable high throughput for FIFO queues, do the following:

    • Set DeduplicationScope to messageGroup.

    • Set FifoThroughputLimit to perMessageGroupId.

    If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified.

    For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.

• On success, responds with GetQueueAttributesOutput with field(s):
  • attributes(Option<HashMap<QueueAttributeName, String>>):

    A map of attributes to their respective values.

• On failure, responds with SdkError<GetQueueAttributesError>

impl Client

pub fn get_queue_url(&self) -> GetQueueUrlFluentBuilder

Constructs a fluent builder for the GetQueueUrl operation.

• The fluent builder is configurable:
  • queue_name(impl Into<String>) / set_queue_name(Option<String>):

    The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_).

    Queue URLs and names are case-sensitive.

  • queue_owner_aws_account_id(impl Into<String>) / set_queue_owner_aws_account_id(Option<String>):

    The Amazon Web Services account ID of the account that created the queue.

• On success, responds with GetQueueUrlOutput with field(s):
  • queue_url(Option<String>):

    The URL of the queue.

• On failure, responds with SdkError<GetQueueUrlError>

impl Client

pub fn list_dead_letter_source_queues( &self ) -> ListDeadLetterSourceQueuesFluentBuilder

Constructs a fluent builder for the ListDeadLetterSourceQueues operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of a dead-letter queue.

    Queue URLs and names are case-sensitive.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    Pagination token to request the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Maximum number of results to include in the response. Value range is 1 to 1000. You must set MaxResults to receive a value for NextToken in the response.

• On success, responds with ListDeadLetterSourceQueuesOutput with field(s):
  • queue_urls(Option<Vec<String>>):

    A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.

  • next_token(Option<String>):

    Pagination token to include in the next request. Token value is null if there are no additional results to request, or if you did not set MaxResults in the request.

• On failure, responds with SdkError<ListDeadLetterSourceQueuesError>

impl Client

pub fn list_queue_tags(&self) -> ListQueueTagsFluentBuilder

Constructs a fluent builder for the ListQueueTags operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the queue.

• On success, responds with ListQueueTagsOutput with field(s):
  • tags(Option<HashMap<String, String>>):

    The list of all tags added to the specified queue.

• On failure, responds with SdkError<ListQueueTagsError>

impl Client

pub fn list_queues(&self) -> ListQueuesFluentBuilder

Constructs a fluent builder for the ListQueues operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • queue_name_prefix(impl Into<String>) / set_queue_name_prefix(Option<String>):

    A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

    Queue URLs and names are case-sensitive.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    Pagination token to request the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Maximum number of results to include in the response. Value range is 1 to 1000. You must set MaxResults to receive a value for NextToken in the response.

• On success, responds with ListQueuesOutput with field(s):
  • next_token(Option<String>):

    Pagination token to include in the next request. Token value is null if there are no additional results to request, or if you did not set MaxResults in the request.

  • queue_urls(Option<Vec<String>>):

    A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in the request.

• On failure, responds with SdkError<ListQueuesError>

impl Client

pub fn purge_queue(&self) -> PurgeQueueFluentBuilder

Constructs a fluent builder for the PurgeQueue operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the queue from which the PurgeQueue action deletes messages.

    Queue URLs and names are case-sensitive.

• On success, responds with PurgeQueueOutput
• On failure, responds with SdkError<PurgeQueueError>

impl Client

pub fn receive_message(&self) -> ReceiveMessageFluentBuilder

Constructs a fluent builder for the ReceiveMessage operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the Amazon SQS queue from which messages are received.

    Queue URLs and names are case-sensitive.

  • attribute_names(Vec<QueueAttributeName>) / set_attribute_names(Option<Vec<QueueAttributeName>>):

    A list of attributes that need to be returned along with each message. These attributes include:

    • All – Returns all values.

    • ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds).

    • ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted.

    • AWSTraceHeader – Returns the X-Ray trace header string.

    • SenderId

      • For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.

      • For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

    • SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds).

    • SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).

    • MessageDeduplicationId – Returns the value provided by the producer that calls the SendMessage action.

    • MessageGroupId – Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.

    • SequenceNumber – Returns the value provided by Amazon SQS.

  • message_attribute_names(Vec<String>) / set_message_attribute_names(Option<Vec<String>>):

    The name of the message attribute, where N is the index.

    • The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).

    • The name is case-sensitive and must be unique among all attribute names for the message.

    • The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).

    • The name must not start or end with a period (.), and it should not have periods in succession (..).

    • The name can be up to 256 characters long.

    When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or . in your request. You can also use all message attributes starting with a prefix, for example bar..

  • max_number_of_messages(i32) / set_max_number_of_messages(i32):

    The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.

  • visibility_timeout(i32) / set_visibility_timeout(i32):

    The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

  • wait_time_seconds(i32) / set_wait_time_seconds(i32):

    The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.

    To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage requests is longer than the WaitTimeSeconds parameter. For example, with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.

  • receive_request_attempt_id(impl Into<String>) / set_receive_request_attempt_id(Option<String>):

    This parameter applies only to FIFO (first-in-first-out) queues.

    The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, it is possible to retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.

    • You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.

    • When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.

    • If a caller of the ReceiveMessage action doesn’t provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.

    • It is possible to retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).

    • During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.

      If a caller of the ReceiveMessage action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.

      To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.

    • While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.

    • If a caller of ReceiveMessage can’t track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.

    The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!“#$%&’()*+,-./:;<=>?@[]^_`{|}~).

    For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS Developer Guide.

• On success, responds with ReceiveMessageOutput with field(s):
  • messages(Option<Vec<Message>>):

    A list of messages.

• On failure, responds with SdkError<ReceiveMessageError>

impl Client

pub fn remove_permission(&self) -> RemovePermissionFluentBuilder

Constructs a fluent builder for the RemovePermission operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the Amazon SQS queue from which permissions are removed.

    Queue URLs and names are case-sensitive.

  • label(impl Into<String>) / set_label(Option<String>):

    The identification of the permission to remove. This is the label added using the AddPermission action.

• On success, responds with RemovePermissionOutput
• On failure, responds with SdkError<RemovePermissionError>

impl Client

pub fn send_message(&self) -> SendMessageFluentBuilder

Constructs a fluent builder for the SendMessage operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the Amazon SQS queue to which a message is sent.

    Queue URLs and names are case-sensitive.

  • message_body(impl Into<String>) / set_message_body(Option<String>):

    The message to send. The minimum size is one character. The maximum size is 256 KB.

    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.

  • delay_seconds(i32) / set_delay_seconds(i32):

    The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don’t specify a value, the default value for the queue applies.

    When you set FifoQueue, you can’t set DelaySeconds per message. You can set this parameter only on a queue level.

  • message_attributes(HashMap<String, MessageAttributeValue>) / set_message_attributes(Option<HashMap<String, MessageAttributeValue>>):

    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

  • message_system_attributes(HashMap<MessageSystemAttributeNameForSends, MessageSystemAttributeValue>) / set_message_system_attributes(Option<HashMap<MessageSystemAttributeNameForSends, MessageSystemAttributeValue>>):

    The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.

    • Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted X-Ray trace header string.

    • The size of a message system attribute doesn’t count towards the total size of a message.

  • message_deduplication_id(impl Into<String>) / set_message_deduplication_id(Option<String>):

    This parameter applies only to FIFO (first-in-first-out) queues.

    The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren’t delivered during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.

    • Every message must have a unique MessageDeduplicationId,

      • You may provide a MessageDeduplicationId explicitly.

      • If you aren’t able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

      • If you don’t provide a MessageDeduplicationId and the queue doesn’t have ContentBasedDeduplication set, the action fails with an error.

      • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

    • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

    • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

    The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).

    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can’t detect duplicate messages.

    Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

    The maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!“#$%&’()*+,-./:;<=>?@[]^_`{|}~).

    For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.

  • message_group_id(impl Into<String>) / set_message_group_id(Option<String>):

    This parameter applies only to FIFO (first-in-first-out) queues.

    The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.

    • You must associate a non-empty MessageGroupId with a message. If you don’t provide a MessageGroupId, the action fails.

    • ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can’t specify a MessageGroupId.

    The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!“#$%&’()*+,-./:;<=>?@[]^_`{|}~).

    For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.

    MessageGroupId is required for FIFO queues. You can’t use it for Standard queues.

• On success, responds with SendMessageOutput with field(s):
  • md5_of_message_body(Option<String>):

    An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

  • md5_of_message_attributes(Option<String>):

    An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

  • md5_of_message_system_attributes(Option<String>):

    An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.

  • message_id(Option<String>):

    An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.

  • sequence_number(Option<String>):

    This parameter applies only to FIFO (first-in-first-out) queues.

    The large, non-consecutive number that Amazon SQS assigns to each message.

    The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.

• On failure, responds with SdkError<SendMessageError>

impl Client

pub fn send_message_batch(&self) -> SendMessageBatchFluentBuilder

Constructs a fluent builder for the SendMessageBatch operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the Amazon SQS queue to which batched messages are sent.

    Queue URLs and names are case-sensitive.

  • entries(Vec<SendMessageBatchRequestEntry>) / set_entries(Option<Vec<SendMessageBatchRequestEntry>>):

    A list of SendMessageBatchRequestEntry items.

• On success, responds with SendMessageBatchOutput with field(s):
  • successful(Option<Vec<SendMessageBatchResultEntry>>):

    A list of SendMessageBatchResultEntry items.

  • failed(Option<Vec<BatchResultErrorEntry>>):

    A list of BatchResultErrorEntry items with error details about each message that can’t be enqueued.

• On failure, responds with SdkError<SendMessageBatchError>

impl Client

pub fn set_queue_attributes(&self) -> SetQueueAttributesFluentBuilder

Constructs a fluent builder for the SetQueueAttributes operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the Amazon SQS queue whose attributes are set.

    Queue URLs and names are case-sensitive.

  • attributes(HashMap<QueueAttributeName, String>) / set_attributes(Option<HashMap<QueueAttributeName, String>>):

    A map of attributes to set.

    The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:

    • DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.

    • MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).

    • MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).

    • Policy – The queue’s policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Identity and Access Management User Guide.

    • ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.

    • RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide.

      • deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

      • maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.

      The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.

    • VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

    The following attributes apply only to server-side-encryption:

    • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the Key Management Service API Reference.

    • KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.

    • SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).

    The following attribute applies only to FIFO (first-in-first-out) queues:

    • ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following:

      • Every message must have a unique MessageDeduplicationId.

        • You may provide a MessageDeduplicationId explicitly.

        • If you aren’t able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

        • If you don’t provide a MessageDeduplicationId and the queue doesn’t have ContentBasedDeduplication set, the action fails with an error.

        • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

      • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

      • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

    The following attributes apply only to high throughput for FIFO queues:

    • DeduplicationScope – Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.

    • FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

    To enable high throughput for FIFO queues, do the following:

    • Set DeduplicationScope to messageGroup.

    • Set FifoThroughputLimit to perMessageGroupId.

    If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified.

    For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide.

• On success, responds with SetQueueAttributesOutput
• On failure, responds with SdkError<SetQueueAttributesError>

impl Client

pub fn tag_queue(&self) -> TagQueueFluentBuilder

Constructs a fluent builder for the TagQueue operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the queue.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The list of tags to be added to the specified queue.

• On success, responds with TagQueueOutput
• On failure, responds with SdkError<TagQueueError>

impl Client

pub fn untag_queue(&self) -> UntagQueueFluentBuilder

Constructs a fluent builder for the UntagQueue operation.

• The fluent builder is configurable:
  • queue_url(impl Into<String>) / set_queue_url(Option<String>):

    The URL of the queue.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    The list of tags to be removed from the specified queue.

• On success, responds with UntagQueueOutput
• On failure, responds with SdkError<UntagQueueError>

impl Client

pub fn with_config( client: Client<DynConnector, DynMiddleware<DynConnector>>, conf: Config ) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.