Struct aws_sdk_sqs::input::SendMessageInput
source · [−]#[non_exhaustive]pub struct SendMessageInput {
pub queue_url: Option<String>,
pub message_body: Option<String>,
pub delay_seconds: i32,
pub message_attributes: Option<HashMap<String, MessageAttributeValue>>,
pub message_system_attributes: Option<HashMap<MessageSystemAttributeNameForSends, MessageSystemAttributeValue>>,
pub message_deduplication_id: Option<String>,
pub message_group_id: Option<String>,
}
Expand description
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.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: 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
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: 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: 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 beString
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: 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 enableContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate theMessageDeduplicationId
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 haveContentBasedDeduplication
set, the action fails with an error. -
If the queue has
ContentBasedDeduplication
set, yourMessageDeduplicationId
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 aMessageDeduplicationId
that is the same as the one generated for the firstMessageDeduplicationId
, 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: 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 aMessageGroupId
, the action fails. -
ReceiveMessage
might return messages with multipleMessageGroupId
values. For eachMessageGroupId
, the messages are sorted by time sent. The caller can't specify aMessageGroupId
.
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.
Implementations
sourceimpl SendMessageInput
impl SendMessageInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<SendMessage, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<SendMessage, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<SendMessage
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture SendMessageInput
sourceimpl SendMessageInput
impl SendMessageInput
sourcepub fn queue_url(&self) -> Option<&str>
pub fn queue_url(&self) -> Option<&str>
The URL of the Amazon SQS queue to which a message is sent.
Queue URLs and names are case-sensitive.
sourcepub fn message_body(&self) -> Option<&str>
pub fn message_body(&self) -> Option<&str>
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.
sourcepub fn delay_seconds(&self) -> i32
pub fn delay_seconds(&self) -> 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.
sourcepub fn message_attributes(
&self
) -> Option<&HashMap<String, MessageAttributeValue>>
pub fn message_attributes(
&self
) -> 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.
sourcepub fn message_system_attributes(
&self
) -> Option<&HashMap<MessageSystemAttributeNameForSends, MessageSystemAttributeValue>>
pub fn message_system_attributes(
&self
) -> 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 beString
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.
sourcepub fn message_deduplication_id(&self) -> Option<&str>
pub fn message_deduplication_id(&self) -> Option<&str>
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 enableContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate theMessageDeduplicationId
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 haveContentBasedDeduplication
set, the action fails with an error. -
If the queue has
ContentBasedDeduplication
set, yourMessageDeduplicationId
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 aMessageDeduplicationId
that is the same as the one generated for the firstMessageDeduplicationId
, 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.
sourcepub fn message_group_id(&self) -> Option<&str>
pub fn message_group_id(&self) -> Option<&str>
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 aMessageGroupId
, the action fails. -
ReceiveMessage
might return messages with multipleMessageGroupId
values. For eachMessageGroupId
, the messages are sorted by time sent. The caller can't specify aMessageGroupId
.
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.
Trait Implementations
sourceimpl Clone for SendMessageInput
impl Clone for SendMessageInput
sourcefn clone(&self) -> SendMessageInput
fn clone(&self) -> SendMessageInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for SendMessageInput
impl Debug for SendMessageInput
sourceimpl PartialEq<SendMessageInput> for SendMessageInput
impl PartialEq<SendMessageInput> for SendMessageInput
sourcefn eq(&self, other: &SendMessageInput) -> bool
fn eq(&self, other: &SendMessageInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &SendMessageInput) -> bool
fn ne(&self, other: &SendMessageInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for SendMessageInput
Auto Trait Implementations
impl RefUnwindSafe for SendMessageInput
impl Send for SendMessageInput
impl Sync for SendMessageInput
impl Unpin for SendMessageInput
impl UnwindSafe for SendMessageInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more