From 54e46231d8ddea55564bc1e2746a250b5104fc90 Mon Sep 17 00:00:00 2001
From: awstools
For ADM, PlatformPrincipal
is client id
- * and PlatformCredential
is client secret
.
For ADM, PlatformPrincipal
is client id
and
+ * PlatformCredential
is client secret
.
For APNS and APNS_SANDBOX
using certificate
- * credentials, PlatformPrincipal
is SSL certificate
and
+ *
For APNS and APNS_SANDBOX
using certificate credentials,
+ * PlatformPrincipal
is SSL certificate
and
* PlatformCredential
is private key
.
PlatformCredential
is signing key
.
* For Baidu, PlatformPrincipal
is API key
- * and PlatformCredential
is secret key
.
For Baidu, PlatformPrincipal
is API key
and
+ * PlatformCredential
is secret key
.
For GCM (Firebase Cloud Messaging) using key credentials, there is no @@ -69,9 +69,8 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp * @json <<< cat service.json`.
*For MPNS, PlatformPrincipal
is TLS
- * certificate
and PlatformCredential
is private
- * key
.
For MPNS, PlatformPrincipal
is TLS certificate
and
+ * PlatformCredential
is private key
.
For WNS, A map of attributes with their corresponding values. The following lists names, descriptions, and values of the special request
- * parameters that the The following lists names, descriptions, and values of the special request parameters
+ * that the
@@ -569,34 +569,30 @@ export interface CreateTopicInput {
*
- * PlatformPrincipal
is Package Security
diff --git a/clients/client-sns/src/models/models_0.ts b/clients/client-sns/src/models/models_0.ts
index 1c6b7cdf7b9b..646a7b2a19ed 100644
--- a/clients/client-sns/src/models/models_0.ts
+++ b/clients/client-sns/src/models/models_0.ts
@@ -515,8 +515,8 @@ export interface CreateTopicInput {
/**
*
CreateTopic
action uses:CreateTopic
action uses:
*
*
ArchivePolicy
– Adds or updates an inline policy document
- * to archive messages stored in the specified Amazon SNS topic.ArchivePolicy
– The policy that sets the retention period
+ * for messages stored in the message archive of an Amazon SNS FIFO
+ * topic.
- * BeginningArchiveTime
– The earliest starting point at
- * which a message in the topic’s archive can be replayed from. This point in time
- * is based on the configured message retention period set by the topic’s message
- * archiving policy.
- * ContentBasedDeduplication
– Enables content-based deduplication for
- * FIFO topics.
ContentBasedDeduplication
– Enables content-based
+ * deduplication for FIFO topics.
* 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.
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.
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.
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.
- * FifoTopic
– When this is set to true
, a FIFO
- * topic is created.
ArchivePolicy
– The policy that sets the retention period
+ * for messages stored in the message archive of an Amazon SNS FIFO
+ * topic.
+ *
+ * BeginningArchiveTime
– The earliest starting point at
+ * which a message in the topic’s archive can be replayed from. This point in time
+ * is based on the configured message retention period set by the topic’s message
+ * archiving policy.
- * ContentBasedDeduplication
– Enables content-based deduplication for
- * FIFO topics.
ContentBasedDeduplication
– Enables content-based
+ * deduplication for FIFO topics.
* 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.
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.
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).
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.
MessageDeduplicationId
parameter for the
+ * Publish
action.
*
+ * FifoTopic
– When this is set to true
, a FIFO
+ * topic is created.
- * ContentBasedDeduplication
– Enables content-based deduplication for
- * FIFO topics.
ArchivePolicy
– The policy that sets the retention period
+ * for messages stored in the message archive of an Amazon SNS FIFO
+ * topic.
+ *
+ * ContentBasedDeduplication
– Enables content-based
+ * deduplication for FIFO topics.
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.
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.
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.
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.
Creates a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile\n apps may register. You must specify PlatformPrincipal
and\n PlatformCredential
attributes when using the\n CreatePlatformApplication
action.
\n PlatformPrincipal
and PlatformCredential
are received from\n the notification service.
For ADM, PlatformPrincipal
is client id
\n and PlatformCredential
is client secret
.
For APNS and APNS_SANDBOX
using certificate\n credentials, PlatformPrincipal
is SSL certificate
and\n PlatformCredential
is private key
.
For APNS and APNS_SANDBOX
using token credentials,\n PlatformPrincipal
is signing key ID
and\n PlatformCredential
is signing key
.
For Baidu, PlatformPrincipal
is API key
\n and PlatformCredential
is secret key
.
For GCM (Firebase Cloud Messaging) using key credentials, there is no\n PlatformPrincipal
. The PlatformCredential
is\n API key
.
For GCM (Firebase Cloud Messaging) using token credentials, there is no\n PlatformPrincipal
. The PlatformCredential
is a\n JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in\n string format and special characters must be ignored. To format the file\n correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq\n @json <<< cat service.json`
.
For MPNS, PlatformPrincipal
is TLS\n certificate
and PlatformCredential
is private\n key
.
For WNS, PlatformPrincipal
is Package Security\n Identifier
and PlatformCredential
is secret\n key
.
You can use the returned PlatformApplicationArn
as an attribute for the\n CreatePlatformEndpoint
action.
Creates a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile\n apps may register. You must specify PlatformPrincipal
and\n PlatformCredential
attributes when using the\n CreatePlatformApplication
action.
\n PlatformPrincipal
and PlatformCredential
are received from\n the notification service.
For ADM, PlatformPrincipal
is client id
and\n PlatformCredential
is client secret
.
For APNS and APNS_SANDBOX
using certificate credentials,\n PlatformPrincipal
is SSL certificate
and\n PlatformCredential
is private key
.
For APNS and APNS_SANDBOX
using token credentials,\n PlatformPrincipal
is signing key ID
and\n PlatformCredential
is signing key
.
For Baidu, PlatformPrincipal
is API key
and\n PlatformCredential
is secret key
.
For GCM (Firebase Cloud Messaging) using key credentials, there is no\n PlatformPrincipal
. The PlatformCredential
is\n API key
.
For GCM (Firebase Cloud Messaging) using token credentials, there is no\n PlatformPrincipal
. The PlatformCredential
is a\n JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in\n string format and special characters must be ignored. To format the file\n correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq\n @json <<< cat service.json`
.
For MPNS, PlatformPrincipal
is TLS certificate
and\n PlatformCredential
is private key
.
For WNS, PlatformPrincipal
is Package Security\n Identifier
and PlatformCredential
is secret\n key
.
You can use the returned PlatformApplicationArn
as an attribute for the\n CreatePlatformEndpoint
action.
A map of attributes with their corresponding values.
\nThe following lists names, descriptions, and values of the special request\n parameters 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
– Adds or updates an inline policy document\n to archive messages stored in the specified Amazon SNS topic.
\n BeginningArchiveTime
– The earliest starting point at\n which a message in the topic’s archive can be replayed from. This point in time\n is based on the configured message retention period set by the topic’s message\n archiving policy.
\n ContentBasedDeduplication
– Enables content-based deduplication for\n FIFO topics.
By default, ContentBasedDeduplication
is set to false
.\n If you create a FIFO topic and this attribute is false
, you must\n specify a value for the MessageDeduplicationId
parameter for the\n Publish action.
When you set ContentBasedDeduplication
to true
, \n Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using \n the body of the 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 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\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 the topic's attributes. Attributes in this map include the following:
\n\n DeliveryPolicy
– The JSON serialization of the topic's\n delivery policy.
\n DisplayName
– The human-readable name used in the\n From
field for notifications to email
and\n email-json
endpoints.
\n EffectiveDeliveryPolicy
– The JSON serialization of the\n effective delivery policy, taking system defaults into account.
\n Owner
– The Amazon Web Services account ID of the topic's owner.
\n Policy
– The JSON serialization of the topic's access\n control policy.
\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\n Amazon SNS.
By default, SignatureVersion
is set to 1. The signature is a Base64-encoded\n SHA1withRSA signature.
When you set SignatureVersion
to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature.
If the API response does not include the\n SignatureVersion
attribute, it means that the\n SignatureVersion
for the topic has value 1.
\n SubscriptionsConfirmed
– The number of confirmed\n subscriptions for the topic.
\n SubscriptionsDeleted
– The number of deleted subscriptions\n for the topic.
\n SubscriptionsPending
– The number of subscriptions pending\n confirmation for the topic.
\n TopicArn
– The topic's ARN.
\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-encryption:
\n\n KmsMasterKeyId
- The ID of an Amazon Web Services managed customer master key\n (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 FifoTopic
– When this is set to true
, a FIFO\n topic is created.
\n ContentBasedDeduplication
– Enables content-based deduplication for\n FIFO topics.
By default, ContentBasedDeduplication
is set to false
.\n If you create a FIFO topic and this attribute is false
, you must\n specify a value for the MessageDeduplicationId
parameter for the\n Publish action.
When you set ContentBasedDeduplication
to true
, \n Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using \n the body of the 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 Publish
\n action.
A map of the topic's attributes. Attributes in this map include the following:
\n\n DeliveryPolicy
– The JSON serialization of the topic's\n delivery policy.
\n DisplayName
– The human-readable name used in the\n From
field for notifications to email
and\n email-json
endpoints.
\n EffectiveDeliveryPolicy
– The JSON serialization of the\n effective delivery policy, taking system defaults into account.
\n Owner
– The Amazon Web Services account ID of the topic's owner.
\n Policy
– The JSON serialization of the topic's access\n control policy.
\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\n Amazon SNS.
By default, SignatureVersion
is set to 1. The signature is a Base64-encoded\n SHA1withRSA signature.
When you set SignatureVersion
to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature.
If the API response does not include the\n SignatureVersion
attribute, it means that the\n SignatureVersion
for the topic has value 1.
\n SubscriptionsConfirmed
– The number of confirmed\n subscriptions for the topic.
\n SubscriptionsDeleted
– The number of deleted subscriptions\n for the topic.
\n SubscriptionsPending
– The number of subscriptions pending\n confirmation for the topic.
\n TopicArn
– The topic's ARN.
\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-encryption:
\n\n KmsMasterKeyId
- The ID of an Amazon Web Services managed customer master key\n (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 BeginningArchiveTime
– The earliest starting point at\n which a message in the topic’s archive can be replayed from. This point in time\n is based on the configured message retention period set by the topic’s message\n archiving policy.
\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 FifoTopic
– When this is set to true
, a FIFO\n topic is created.
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 ContentBasedDeduplication
– Enables content-based deduplication for\n FIFO topics.
By default, ContentBasedDeduplication
is set to false
.\n If you create a FIFO topic and this attribute is false
, you must\n specify a value for the MessageDeduplicationId
parameter for the\n Publish action.
When you set ContentBasedDeduplication
to true
, \n Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using \n the body of the 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 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\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.