diff --git a/clients/client-sns/src/models/models_0.ts b/clients/client-sns/src/models/models_0.ts index 646a7b2a19ed4..9c08a7d424649 100644 --- a/clients/client-sns/src/models/models_0.ts +++ b/clients/client-sns/src/models/models_0.ts @@ -570,8 +570,8 @@ export interface CreateTopicInput { *
* ArchivePolicy
– The policy that sets the retention period
- * for messages stored in the message archive of an Amazon SNS FIFO
- * topic.
@@ -580,19 +580,34 @@ export interface CreateTopicInput { *
By default, ContentBasedDeduplication
is set to
- * false
. If you create a FIFO topic and this attribute is
- * false
, you must specify a value for the
- * MessageDeduplicationId
parameter for the Publish
- * action.
false
. If you create a FIFO topic and this attribute is
+ * false
, you must specify a value for the
+ * MessageDeduplicationId
parameter for the Publish action.
* When you set ContentBasedDeduplication
to true
,
- * Amazon SNS uses a SHA-256 hash to generate the
- * MessageDeduplicationId
using the body of the message (but not
- * the attributes of the message).
(Optional) To override the generated value, you can specify a value for the
- * MessageDeduplicationId
parameter for the Publish
- * action.
When you set ContentBasedDeduplication
to
+ * true
, Amazon SNS uses a SHA-256 hash to
+ * generate the MessageDeduplicationId
using the body of the
+ * message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value
+ * for the MessageDeduplicationId
parameter for the
+ * Publish
action.
+ * FifoThroughputScope
– Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:
+ * Topic
– The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.
+ * MessageGroup
– The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference.
This parameter applies only to FIFO (first-in-first-out) topics. The
- * MessageDeduplicationId
can contain up to 128 alphanumeric characters
- * (a-z, A-Z, 0-9)
and punctuation
- * (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)
.
Every message must have a unique MessageDeduplicationId
, which is a token
- * used for deduplication of sent messages. If a message with a particular
- * MessageDeduplicationId
is sent successfully, any message sent with the
- * same MessageDeduplicationId
during the 5-minute deduplication interval is
- * treated as a duplicate.
If the topic has ContentBasedDeduplication
set, the system generates a
- * MessageDeduplicationId
based on the contents of the message. Your
- * MessageDeduplicationId
overrides the generated one.
This parameter applies only to FIFO (first-in-first-out) topics. The
+ * MessageDeduplicationId
can contain up to 128 alphanumeric
+ * characters (a-z, A-Z, 0-9)
and punctuation
+ * (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)
.
Every message must have a unique MessageDeduplicationId
, which is
+ * a token used for deduplication of sent messages within the 5 minute minimum
+ * deduplication interval.
The scope of deduplication depends on the FifoThroughputScope
+ * attribute, when set to Topic
the message deduplication scope is
+ * across the entire topic, when set to MessageGroup
the message
+ * deduplication scope is within each individual message group.
If a message with a particular MessageDeduplicationId
is sent
+ * successfully, subsequent messages within the deduplication scope and interval,
+ * with the same MessageDeduplicationId
, are accepted successfully but
+ * aren't delivered.
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 topic,
+ * Amazon SNS 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
+ * topic doesn't have ContentBasedDeduplication
set, the
+ * action fails with an error.
If the topic has a ContentBasedDeduplication
set, your
+ * MessageDeduplicationId
overrides the generated one.
+ *
When ContentBasedDeduplication
is in effect, messages with
+ * identical content sent within the deduplication scope and 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, within the deduplication scope and
+ * interval, and only one copy of the message is delivered.
This parameter applies only to FIFO (first-in-first-out) topics.
- *The token used for deduplication of messages within a 5-minute minimum deduplication
- * interval. If a message with a particular MessageDeduplicationId
is sent
- * successfully, subsequent messages with the same MessageDeduplicationId
are
- * accepted successfully but aren't delivered.
This parameter applies only to FIFO (first-in-first-out) topics. The
+ * MessageDeduplicationId
can contain up to 128 alphanumeric
+ * characters (a-z, A-Z, 0-9)
and punctuation
+ * (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)
.
Every message must have a unique MessageDeduplicationId
, which is
+ * a token used for deduplication of sent messages within the 5 minute minimum
+ * deduplication interval.
The scope of deduplication depends on the FifoThroughputScope
+ * attribute, when set to Topic
the message deduplication scope is
+ * across the entire topic, when set to MessageGroup
the message
+ * deduplication scope is within each individual message group.
If a message with a particular MessageDeduplicationId
is sent
+ * successfully, subsequent messages within the deduplication scope and interval,
+ * with the same MessageDeduplicationId
, are accepted successfully but
+ * aren't delivered.
Every message must have a unique MessageDeduplicationId
.
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.
Amazon SNS continues to keep track of the message deduplication ID even after the * message is received and deleted.
*The length of MessageDeduplicationId
is 128 characters.
- * MessageDeduplicationId
can contain alphanumeric characters (a-z,
- * A-Z, 0-9)
and punctuation
- * (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)
.
* ArchivePolicy
– The policy that sets the retention period
- * for messages stored in the message archive of an Amazon SNS FIFO
- * topic.
@@ -3209,19 +3289,34 @@ export interface SetTopicAttributesInput { *
By default, ContentBasedDeduplication
is set to
- * false
. If you create a FIFO topic and this attribute is
- * false
, you must specify a value for the
- * MessageDeduplicationId
parameter for the Publish
- * action.
false
. If you create a FIFO topic and this attribute is
+ * false
, you must specify a value for the
+ * MessageDeduplicationId
parameter for the Publish action.
+ * When you set ContentBasedDeduplication
to
+ * true
, Amazon SNS uses a SHA-256 hash to
+ * generate the MessageDeduplicationId
using the body of the
+ * message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value
+ * for the MessageDeduplicationId
parameter for the
+ * Publish
action.
+ * FifoThroughputScope
– Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:
+ * Topic
– The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.
When you set ContentBasedDeduplication
to true
,
- * Amazon SNS uses a SHA-256 hash to generate the
- * MessageDeduplicationId
using the body of the message (but not
- * the attributes of the message).
(Optional) To override the generated value, you can specify a value for the
- * MessageDeduplicationId
parameter for the Publish
- * action.
+ * MessageGroup
– The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference.
A map of attributes with their corresponding values.
\nThe following lists names, descriptions, and values of the special request parameters\n that the CreateTopic
action uses:
\n DeliveryPolicy
– The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.
\n DisplayName
– The display name to use for a topic with SMS\n subscriptions.
\n FifoTopic
– Set to true to create a FIFO topic.
\n Policy
– The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.
\n SignatureVersion
– The signature version corresponds to\n the hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.\n By default, SignatureVersion
is set to 1
.
\n TracingConfig
– Tracing mode of an Amazon SNS topic. By default\n TracingConfig
is set to PassThrough
, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active
, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.
The following attribute applies only to server-side\n encryption:
\n\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
\n\n ArchivePolicy
– The policy that sets the retention period\n for messages stored in the message archive of an Amazon SNS FIFO\n topic.
\n ContentBasedDeduplication
– Enables content-based\n deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to\n false
. If you create a FIFO topic and this attribute is\n false
, you must specify a value for the\n MessageDeduplicationId
parameter for the Publish\n action.
When you set ContentBasedDeduplication
to true
,\n Amazon SNS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message (but not\n the attributes of the message).
(Optional) To override the generated value, you can specify a value for the\n MessageDeduplicationId
parameter for the Publish
\n action.
A map of attributes with their corresponding values.
\nThe following lists names, descriptions, and values of the special request parameters\n that the CreateTopic
action uses:
\n DeliveryPolicy
– The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.
\n DisplayName
– The display name to use for a topic with SMS\n subscriptions.
\n FifoTopic
– Set to true to create a FIFO topic.
\n Policy
– The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.
\n SignatureVersion
– The signature version corresponds to\n the hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.\n By default, SignatureVersion
is set to 1
.
\n TracingConfig
– Tracing mode of an Amazon SNS topic. By default\n TracingConfig
is set to PassThrough
, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active
, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.
The following attribute applies only to server-side\n encryption:
\n\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
\n\n ArchivePolicy
– The policy that sets the retention period\n for messages stored in the message archive of an Amazon SNS FIFO\n topic.
\n ContentBasedDeduplication
– Enables content-based\n deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to\n false
. If you create a FIFO topic and this attribute is\n false
, you must specify a value for the\n MessageDeduplicationId
parameter for the Publish action.
When you set ContentBasedDeduplication
to\n true
, Amazon SNS uses a SHA-256 hash to\n generate the MessageDeduplicationId
using the body of the\n message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value\n for the MessageDeduplicationId
parameter for the\n Publish
action.
\n FifoThroughputScope
– Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:
\n Topic
– The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.
\n MessageGroup
– The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference.
This parameter applies only to FIFO (first-in-first-out) topics.
\nThe token used for deduplication of messages within a 5-minute minimum deduplication\n interval. If a message with a particular MessageDeduplicationId
is sent\n successfully, subsequent messages with the same MessageDeduplicationId
are\n accepted successfully but aren't delivered.
Every message must have a unique MessageDeduplicationId
.
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a MessageDeduplicationId
\n and you enable ContentBasedDeduplication
for your topic,\n Amazon SNS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the\n topic doesn't have ContentBasedDeduplication
set, the\n action fails with an error.
If the topic has a ContentBasedDeduplication
set, your\n MessageDeduplicationId
overrides the generated one.\n
When ContentBasedDeduplication
is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled,\n and then another message with a MessageDeduplicationId
that is the\n same as the one generated for the first MessageDeduplicationId
, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.
The MessageDeduplicationId
is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId
after the deduplication\n interval, Amazon SNS can't detect duplicate messages.
Amazon SNS continues to keep track of the message deduplication ID even after the\n message is received and deleted.
\nThe length of MessageDeduplicationId
is 128 characters.
\n MessageDeduplicationId
can contain alphanumeric characters (a-z,\n A-Z, 0-9)
and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.
This parameter applies only to FIFO (first-in-first-out) topics.
\nThis parameter applies only to FIFO (first-in-first-out) topics. The\n MessageDeduplicationId
can contain up to 128 alphanumeric\n characters (a-z, A-Z, 0-9)
and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.
Every message must have a unique MessageDeduplicationId
, which is\n a token used for deduplication of sent messages within the 5 minute minimum\n deduplication interval.
The scope of deduplication depends on the FifoThroughputScope
\n attribute, when set to Topic
the message deduplication scope is\n across the entire topic, when set to MessageGroup
the message\n deduplication scope is within each individual message group.
If a message with a particular MessageDeduplicationId
is sent\n successfully, subsequent messages within the deduplication scope and interval,\n with the same MessageDeduplicationId
, are accepted successfully but\n aren't delivered.
Every message must have a unique MessageDeduplicationId
.
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a MessageDeduplicationId
\n and you enable ContentBasedDeduplication
for your topic,\n Amazon SNS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the\n topic doesn't have ContentBasedDeduplication
set, the\n action fails with an error.
If the topic has a ContentBasedDeduplication
set, your\n MessageDeduplicationId
overrides the generated one.\n
When ContentBasedDeduplication
is in effect, messages with\n identical content sent within the deduplication scope and interval are treated\n as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled,\n and then another message with a MessageDeduplicationId
that is the\n same as the one generated for the first MessageDeduplicationId
, the\n two messages are treated as duplicates, within the deduplication scope and\n interval, and only one copy of the message is delivered.
The MessageDeduplicationId
is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId
after the deduplication\n interval, Amazon SNS can't detect duplicate messages.
Amazon SNS continues to keep track of the message deduplication ID even after the\n message is received and deleted.
\nThis parameter applies only to FIFO (first-in-first-out) topics. The\n MessageDeduplicationId
can contain up to 128 alphanumeric characters\n (a-z, A-Z, 0-9)
and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.
Every message must have a unique MessageDeduplicationId
, which is a token\n used for deduplication of sent messages. If a message with a particular\n MessageDeduplicationId
is sent successfully, any message sent with the\n same MessageDeduplicationId
during the 5-minute deduplication interval is\n treated as a duplicate.
If the topic has ContentBasedDeduplication
set, the system generates a\n MessageDeduplicationId
based on the contents of the message. Your\n MessageDeduplicationId
overrides the generated one.
This parameter applies only to FIFO (first-in-first-out) topics. The\n MessageDeduplicationId
can contain up to 128 alphanumeric\n characters (a-z, A-Z, 0-9)
and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.
Every message must have a unique MessageDeduplicationId
, which is\n a token used for deduplication of sent messages within the 5 minute minimum\n deduplication interval.
The scope of deduplication depends on the FifoThroughputScope
\n attribute, when set to Topic
the message deduplication scope is\n across the entire topic, when set to MessageGroup
the message\n deduplication scope is within each individual message group.
If a message with a particular MessageDeduplicationId
is sent\n successfully, subsequent messages within the deduplication scope and interval,\n with the same MessageDeduplicationId
, are accepted successfully but\n aren't delivered.
Every message must have a unique MessageDeduplicationId
:
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a MessageDeduplicationId
\n and you enable ContentBasedDeduplication
for your topic,\n Amazon SNS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the\n topic doesn't have ContentBasedDeduplication
set, the\n action fails with an error.
If the topic has a ContentBasedDeduplication
set, your\n MessageDeduplicationId
overrides the generated one.\n
When ContentBasedDeduplication
is in effect, messages with\n identical content sent within the deduplication scope and interval are treated\n as duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled,\n and then another message with a MessageDeduplicationId
that is the\n same as the one generated for the first MessageDeduplicationId
, the\n two messages are treated as duplicates, within the deduplication scope and\n interval, and only one copy of the message is delivered.
A map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the SetTopicAttributes
action uses:
\n ApplicationSuccessFeedbackRoleArn
– Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to a platform\n application endpoint.
\n DeliveryPolicy
– The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.
\n DisplayName
– The display name to use for a topic with SMS\n subscriptions.
\n Policy
– The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.
\n TracingConfig
– Tracing mode of an Amazon SNS topic. By default\n TracingConfig
is set to PassThrough
, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active
, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.
HTTP
\n\n HTTPSuccessFeedbackRoleArn
– Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.
\n HTTPSuccessFeedbackSampleRate
– Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an HTTP endpoint.
\n HTTPFailureFeedbackRoleArn
– Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.
Amazon Kinesis Data Firehose
\n\n FirehoseSuccessFeedbackRoleArn
– Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Amazon Kinesis Data Firehose endpoint.
\n FirehoseSuccessFeedbackSampleRate
– Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon Kinesis Data Firehose endpoint.
\n FirehoseFailureFeedbackRoleArn
– Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon Kinesis Data Firehose endpoint.
Lambda
\n\n LambdaSuccessFeedbackRoleArn
– Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Lambda endpoint.
\n LambdaSuccessFeedbackSampleRate
– Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Lambda endpoint.
\n LambdaFailureFeedbackRoleArn
– Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Lambda endpoint.
Platform application endpoint
\n\n ApplicationSuccessFeedbackRoleArn
– Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Amazon Web Services application endpoint.
\n ApplicationSuccessFeedbackSampleRate
– Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon Web Services application endpoint.
\n ApplicationFailureFeedbackRoleArn
– Indicates\n failed message delivery status for an Amazon SNS topic that is subscribed to\n an Amazon Web Services application endpoint.
In addition to being able to configure topic attributes for message\n delivery status of notification messages sent to Amazon SNS application\n endpoints, you can also configure application attributes for the delivery\n status of push notification messages sent to push notification\n services.
\nFor example, For more information, see Using Amazon SNS Application\n Attributes for Message Delivery Status.
\nAmazon SQS
\n\n SQSSuccessFeedbackRoleArn
– Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.
\n SQSSuccessFeedbackSampleRate
– Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon SQS endpoint.
\n SQSFailureFeedbackRoleArn
– Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.
The
The following attribute applies only to server-side-encryption:
\n\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.
\n SignatureVersion
– The signature version corresponds to the\n hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.\n By default, SignatureVersion
is set to 1
.
The following attribute applies only to FIFO topics:
\n\n ArchivePolicy
– The policy that sets the retention period\n for messages stored in the message archive of an Amazon SNS FIFO\n topic.
\n ContentBasedDeduplication
– Enables content-based\n deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to\n false
. If you create a FIFO topic and this attribute is\n false
, you must specify a value for the\n MessageDeduplicationId
parameter for the Publish\n action.
When you set ContentBasedDeduplication
to true
,\n Amazon SNS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message (but not\n the attributes of the message).
(Optional) To override the generated value, you can specify a value for the\n MessageDeduplicationId
parameter for the Publish
\n action.
A map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the SetTopicAttributes
action uses:
\n ApplicationSuccessFeedbackRoleArn
– Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to a platform\n application endpoint.
\n DeliveryPolicy
– The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.
\n DisplayName
– The display name to use for a topic with SMS\n subscriptions.
\n Policy
– The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.
\n TracingConfig
– Tracing mode of an Amazon SNS topic. By default\n TracingConfig
is set to PassThrough
, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active
, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.
HTTP
\n\n HTTPSuccessFeedbackRoleArn
– Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.
\n HTTPSuccessFeedbackSampleRate
– Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an HTTP endpoint.
\n HTTPFailureFeedbackRoleArn
– Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.
Amazon Kinesis Data Firehose
\n\n FirehoseSuccessFeedbackRoleArn
– Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Amazon Kinesis Data Firehose endpoint.
\n FirehoseSuccessFeedbackSampleRate
– Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon Kinesis Data Firehose endpoint.
\n FirehoseFailureFeedbackRoleArn
– Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon Kinesis Data Firehose endpoint.
Lambda
\n\n LambdaSuccessFeedbackRoleArn
– Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Lambda endpoint.
\n LambdaSuccessFeedbackSampleRate
– Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Lambda endpoint.
\n LambdaFailureFeedbackRoleArn
– Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Lambda endpoint.
Platform application endpoint
\n\n ApplicationSuccessFeedbackRoleArn
– Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Amazon Web Services application endpoint.
\n ApplicationSuccessFeedbackSampleRate
– Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon Web Services application endpoint.
\n ApplicationFailureFeedbackRoleArn
– Indicates\n failed message delivery status for an Amazon SNS topic that is subscribed to\n an Amazon Web Services application endpoint.
In addition to being able to configure topic attributes for message\n delivery status of notification messages sent to Amazon SNS application\n endpoints, you can also configure application attributes for the delivery\n status of push notification messages sent to push notification\n services.
\nFor example, For more information, see Using Amazon SNS Application\n Attributes for Message Delivery Status.
\nAmazon SQS
\n\n SQSSuccessFeedbackRoleArn
– Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.
\n SQSSuccessFeedbackSampleRate
– Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon SQS endpoint.
\n SQSFailureFeedbackRoleArn
– Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.
The
The following attribute applies only to server-side-encryption:
\n\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.
\n SignatureVersion
– The signature version corresponds to the\n hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.\n By default, SignatureVersion
is set to 1
.
The following attribute applies only to FIFO topics:
\n\n ArchivePolicy
– The policy that sets the retention period\n for messages stored in the message archive of an Amazon SNS FIFO\n topic.
\n ContentBasedDeduplication
– Enables content-based\n deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to\n false
. If you create a FIFO topic and this attribute is\n false
, you must specify a value for the\n MessageDeduplicationId
parameter for the Publish action.
When you set ContentBasedDeduplication
to\n true
, Amazon SNS uses a SHA-256 hash to\n generate the MessageDeduplicationId
using the body of the\n message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value\n for the MessageDeduplicationId
parameter for the\n Publish
action.
\n FifoThroughputScope
– Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:
\n Topic
– The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.
\n MessageGroup
– The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference.