diff --git a/AWSSNS/AWSSNSModel.h b/AWSSNS/AWSSNSModel.h index 435972a5d62..610f8868ace 100644 --- a/AWSSNS/AWSSNSModel.h +++ b/AWSSNS/AWSSNSModel.h @@ -415,7 +415,7 @@ typedef NS_ENUM(NSInteger, AWSSNSSMSSandboxPhoneNumberVerificationStatus) { /** -
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the CreateTopic
action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName
– The display name to use for a topic with SMS subscriptions.
FifoTopic
– Set to true to create a FIFO topic.
Policy
– The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
SignatureVersion
– The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion
is set to 1
.
TracingConfig
– Tracing mode of an Amazon SNS topic. By default TracingConfig
is set to PassThrough
, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active
, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
The following attribute applies only to server-side encryption:
KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
ArchivePolicy
– Adds or updates an inline policy document to archive messages stored in the specified Amazon SNS 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.
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.
A map of attributes with their corresponding values.
The following lists names, descriptions, and values of the special request parameters that the CreateTopic
action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName
– The display name to use for a topic with SMS subscriptions.
FifoTopic
– Set to true to create a FIFO topic.
Policy
– The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
SignatureVersion
– The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion
is set to 1
.
TracingConfig
– Tracing mode of an Amazon SNS topic. By default TracingConfig
is set to PassThrough
, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active
, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
The following attribute applies only to server-side encryption:
KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
ArchivePolicy
– Adds or updates an inline policy document to archive messages stored in the specified Amazon SNS 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.
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.
A map of the subscription's attributes. Attributes in this map include the following:
ConfirmationWasAuthenticated
– true
if the subscription confirmation request was authenticated.
DeliveryPolicy
– The JSON serialization of the subscription's delivery policy.
EffectiveDeliveryPolicy
– The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.
FilterPolicy
– The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.
FilterPolicyScope
– This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes
(default) – The filter is applied on the message attributes.
MessageBody
– The filter is applied on the message body.
Owner
– The Amazon Web Services account ID of the subscription's owner.
PendingConfirmation
– true
if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription
action with a confirmation token.
RawMessageDelivery
– true
if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.
RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
SubscriptionArn
– The subscription's ARN.
TopicArn
– The topic ARN that the subscription is associated with.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
A map of the subscription's attributes. Attributes in this map include the following:
ConfirmationWasAuthenticated
– true
if the subscription confirmation request was authenticated.
DeliveryPolicy
– The JSON serialization of the subscription's delivery policy.
EffectiveDeliveryPolicy
– The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.
FilterPolicy
– The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.
FilterPolicyScope
– This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes
(default) – The filter is applied on the message attributes.
MessageBody
– The filter is applied on the message body.
Owner
– The Amazon Web Services account ID of the subscription's owner.
PendingConfirmation
– true
if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription
action with a confirmation token.
RawMessageDelivery
– true
if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.
RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
SubscriptionArn
– The subscription's ARN.
TopicArn
– The topic ARN that the subscription is associated with.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
+Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be UTF-8 text with no line breaks or control characters, and less than 100 characters long.
*/ @property (nonatomic, strong) NSString * _Nullable subject; @@ -1406,7 +1406,7 @@ typedef NS_ENUM(NSInteger, AWSSNSSMSSandboxPhoneNumberVerificationStatus) { /** -A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that this action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy
– The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
FilterPolicyScope
– This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes
(default) – The filter is applied on the message attributes.
MessageBody
– The filter is applied on the message body.
RawMessageDelivery
– When set to true
, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that this action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy
– The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
FilterPolicyScope
– This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes
(default) – The filter is applied on the message attributes.
MessageBody
– The filter is applied on the message body.
RawMessageDelivery
– When set to true
, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the Subscribe
action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy
– The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
FilterPolicyScope
– This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes
(default) – The filter is applied on the message attributes.
MessageBody
– The filter is applied on the message body.
RawMessageDelivery
– When set to true
, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
The following attributes apply only to FIFO topics:
ReplayPolicy
– Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic.
ReplayStatus
– Retrieves the status of the subscription message replay, which can be one of the following:
Completed
– The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in the ReplayPolicy
then the subscription will no longer receive newly published messages.
In progress
– The replay is currently replaying the selected messages.
Failed
– The replay was unable to complete.
Pending
– The default state while the replay initiates.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the Subscribe
action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy
– The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
FilterPolicyScope
– This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes
(default) – The filter is applied on the message attributes.
MessageBody
– The filter is applied on the message body.
RawMessageDelivery
– When set to true
, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.
The following attributes apply only to FIFO topics:
ReplayPolicy
– Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic.
ReplayStatus
– Retrieves the status of the subscription message replay, which can be one of the following:
Completed
– The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in the ReplayPolicy
then the subscription will no longer receive newly published messages.
In progress
– The replay is currently replaying the selected messages.
Failed
– The replay was unable to complete.
Pending
– The default state while the replay initiates.
Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal
and PlatformCredential
attributes when using the CreatePlatformApplication
action.
PlatformPrincipal
and PlatformCredential
are received from the notification service.
For ADM
, PlatformPrincipal
is client id
and PlatformCredential
is client secret
.
For Baidu
, PlatformPrincipal
is API key
and PlatformCredential
is secret key
.
For APNS
and APNS_SANDBOX
using certificate credentials, PlatformPrincipal
is SSL certificate
and PlatformCredential
is private key
.
For APNS
and APNS_SANDBOX
using token credentials, PlatformPrincipal
is signing key ID
and PlatformCredential
is signing key
.
For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal
. The PlatformCredential
is API key
.
For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal
. The PlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`
.
For MPNS
, PlatformPrincipal
is TLS certificate
and PlatformCredential
is private key
.
For WNS
, PlatformPrincipal
is Package Security Identifier
and PlatformCredential
is secret key
.
You can use the returned PlatformApplicationArn
as an attribute for the CreatePlatformEndpoint
action.
Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal
and PlatformCredential
attributes when using the CreatePlatformApplication
action.
PlatformPrincipal
and PlatformCredential
are received from the notification service.
For ADM, PlatformPrincipal
is client id
and PlatformCredential
is client secret
.
For APNS and APNS_SANDBOX
using certificate credentials, PlatformPrincipal
is SSL certificate
and PlatformCredential
is private key
.
For APNS and APNS_SANDBOX
using token credentials, PlatformPrincipal
is signing key ID
and PlatformCredential
is signing key
.
For Baidu, PlatformPrincipal
is API key
and PlatformCredential
is secret key
.
For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal
. The PlatformCredential
is API key
.
For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal
. The PlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`
.
For MPNS, PlatformPrincipal
is TLS certificate
and PlatformCredential
is private key
.
For WNS, PlatformPrincipal
is Package Security Identifier
and PlatformCredential
is secret key
.
You can use the returned PlatformApplicationArn
as an attribute for the CreatePlatformEndpoint
action.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the CreateTopic
action uses:
DeliveryPolicy
â The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName
â The display name to use for a topic with SMS subscriptions.
FifoTopic
â Set to true to create a FIFO topic.
Policy
â The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
SignatureVersion
â The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion
is set to 1
.
TracingConfig
â Tracing mode of an Amazon SNS topic. By default TracingConfig
is set to PassThrough
, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active
, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
The following attribute applies only to server-side encryption:
KmsMasterKeyId
â The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
ArchivePolicy
â Adds or updates an inline policy document to archive messages stored in the specified Amazon SNS 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.
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.
A map of attributes with their corresponding values.
The following lists names, descriptions, and values of the special request parameters that the CreateTopic
action uses:
DeliveryPolicy
â The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName
â The display name to use for a topic with SMS subscriptions.
FifoTopic
â Set to true to create a FIFO topic.
Policy
â The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
SignatureVersion
â The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion
is set to 1
.
TracingConfig
â Tracing mode of an Amazon SNS topic. By default TracingConfig
is set to PassThrough
, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active
, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
The following attribute applies only to server-side encryption:
KmsMasterKeyId
â The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
ArchivePolicy
â Adds or updates an inline policy document to archive messages stored in the specified Amazon SNS 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.
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.
A map of the subscription's attributes. Attributes in this map include the following:
ConfirmationWasAuthenticated
â true
if the subscription confirmation request was authenticated.
DeliveryPolicy
â The JSON serialization of the subscription's delivery policy.
EffectiveDeliveryPolicy
â The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.
FilterPolicy
â The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.
FilterPolicyScope
â This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes
(default) â The filter is applied on the message attributes.
MessageBody
â The filter is applied on the message body.
Owner
â The Amazon Web Services account ID of the subscription's owner.
PendingConfirmation
â true
if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription
action with a confirmation token.
RawMessageDelivery
â true
if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.
RedrivePolicy
â When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
SubscriptionArn
â The subscription's ARN.
TopicArn
â The topic ARN that the subscription is associated with.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
â The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
A map of the subscription's attributes. Attributes in this map include the following:
ConfirmationWasAuthenticated
â true
if the subscription confirmation request was authenticated.
DeliveryPolicy
â The JSON serialization of the subscription's delivery policy.
EffectiveDeliveryPolicy
â The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.
FilterPolicy
â The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.
FilterPolicyScope
â This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes
(default) â The filter is applied on the message attributes.
MessageBody
â The filter is applied on the message body.
Owner
â The Amazon Web Services account ID of the subscription's owner.
PendingConfirmation
â true
if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription
action with a confirmation token.
RawMessageDelivery
â true
if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.
RedrivePolicy
â When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
SubscriptionArn
â The subscription's ARN.
TopicArn
â The topic ARN that the subscription is associated with.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
â The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.
Response for GetSubscriptionAttributes action.
\"\ @@ -2148,7 +2150,7 @@ - (NSString *)definitionString { },\ \"Subject\":{\ \"shape\":\"subject\",\ - \"documentation\":\"Optional parameter to be used as the \\\"Subject\\\" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
\"\ + \"documentation\":\"Optional parameter to be used as the \\\"Subject\\\" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be UTF-8 text with no line breaks or control characters, and less than 100 characters long.
\"\ },\ \"MessageStructure\":{\ \"shape\":\"messageStructure\",\ @@ -2345,7 +2347,7 @@ - (NSString *)definitionString { },\ \"AttributeName\":{\ \"shape\":\"attributeName\",\ - \"documentation\":\"A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that this action uses:
DeliveryPolicy
â The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy
â The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
FilterPolicyScope
â This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes
(default) â The filter is applied on the message attributes.
MessageBody
â The filter is applied on the message body.
RawMessageDelivery
â When set to true
, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy
â When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
â The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that this action uses:
DeliveryPolicy
â The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy
â The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
FilterPolicyScope
â This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes
(default) â The filter is applied on the message attributes.
MessageBody
â The filter is applied on the message body.
RawMessageDelivery
â When set to true
, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy
â When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
â The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the Subscribe
action uses:
DeliveryPolicy
â The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy
â The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
FilterPolicyScope
â This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes
(default) â The filter is applied on the message attributes.
MessageBody
â The filter is applied on the message body.
RawMessageDelivery
â When set to true
, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy
â When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
â The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
The following attributes apply only to FIFO topics:
ReplayPolicy
â Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic.
ReplayStatus
â Retrieves the status of the subscription message replay, which can be one of the following:
Completed
â The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in the ReplayPolicy
then the subscription will no longer receive newly published messages.
In progress
â The replay is currently replaying the selected messages.
Failed
â The replay was unable to complete.
Pending
â The default state while the replay initiates.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the Subscribe
action uses:
DeliveryPolicy
â The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy
â The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
FilterPolicyScope
â This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes
(default) â The filter is applied on the message attributes.
MessageBody
â The filter is applied on the message body.
RawMessageDelivery
â When set to true
, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy
â When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
â The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.
The following attributes apply only to FIFO topics:
ReplayPolicy
â Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic.
ReplayStatus
â Retrieves the status of the subscription message replay, which can be one of the following:
Completed
â The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in the ReplayPolicy
then the subscription will no longer receive newly published messages.
In progress
â The replay is currently replaying the selected messages.
Failed
â The replay was unable to complete.
Pending
â The default state while the replay initiates.
Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal
and PlatformCredential
attributes when using the CreatePlatformApplication
action.
PlatformPrincipal
and PlatformCredential
are received from the notification service.
For ADM
, PlatformPrincipal
is client id
and PlatformCredential
is client secret
.
For Baidu
, PlatformPrincipal
is API key
and PlatformCredential
is secret key
.
For APNS
and APNS_SANDBOX
using certificate credentials, PlatformPrincipal
is SSL certificate
and PlatformCredential
is private key
.
For APNS
and APNS_SANDBOX
using token credentials, PlatformPrincipal
is signing key ID
and PlatformCredential
is signing key
.
For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal
. The PlatformCredential
is API key
.
For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal
. The PlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`
.
For MPNS
, PlatformPrincipal
is TLS certificate
and PlatformCredential
is private key
.
For WNS
, PlatformPrincipal
is Package Security Identifier
and PlatformCredential
is secret key
.
You can use the returned PlatformApplicationArn
as an attribute for the CreatePlatformEndpoint
action.
Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal
and PlatformCredential
attributes when using the CreatePlatformApplication
action.
PlatformPrincipal
and PlatformCredential
are received from the notification service.
For ADM, PlatformPrincipal
is client id
and PlatformCredential
is client secret
.
For APNS and APNS_SANDBOX
using certificate credentials, PlatformPrincipal
is SSL certificate
and PlatformCredential
is private key
.
For APNS and APNS_SANDBOX
using token credentials, PlatformPrincipal
is signing key ID
and PlatformCredential
is signing key
.
For Baidu, PlatformPrincipal
is API key
and PlatformCredential
is secret key
.
For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal
. The PlatformCredential
is API key
.
For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal
. The PlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`
.
For MPNS, PlatformPrincipal
is TLS certificate
and PlatformCredential
is private key
.
For WNS, PlatformPrincipal
is Package Security Identifier
and PlatformCredential
is secret key
.
You can use the returned PlatformApplicationArn
as an attribute for the CreatePlatformEndpoint
action.
Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal
and PlatformCredential
attributes when using the CreatePlatformApplication
action.
PlatformPrincipal
and PlatformCredential
are received from the notification service.
For ADM
, PlatformPrincipal
is client id
and PlatformCredential
is client secret
.
For Baidu
, PlatformPrincipal
is API key
and PlatformCredential
is secret key
.
For APNS
and APNS_SANDBOX
using certificate credentials, PlatformPrincipal
is SSL certificate
and PlatformCredential
is private key
.
For APNS
and APNS_SANDBOX
using token credentials, PlatformPrincipal
is signing key ID
and PlatformCredential
is signing key
.
For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal
. The PlatformCredential
is API key
.
For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal
. The PlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`
.
For MPNS
, PlatformPrincipal
is TLS certificate
and PlatformCredential
is private key
.
For WNS
, PlatformPrincipal
is Package Security Identifier
and PlatformCredential
is secret key
.
You can use the returned PlatformApplicationArn
as an attribute for the CreatePlatformEndpoint
action.
Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal
and PlatformCredential
attributes when using the CreatePlatformApplication
action.
PlatformPrincipal
and PlatformCredential
are received from the notification service.
For ADM, PlatformPrincipal
is client id
and PlatformCredential
is client secret
.
For APNS and APNS_SANDBOX
using certificate credentials, PlatformPrincipal
is SSL certificate
and PlatformCredential
is private key
.
For APNS and APNS_SANDBOX
using token credentials, PlatformPrincipal
is signing key ID
and PlatformCredential
is signing key
.
For Baidu, PlatformPrincipal
is API key
and PlatformCredential
is secret key
.
For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal
. The PlatformCredential
is API key
.
For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal
. The PlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`
.
For MPNS, PlatformPrincipal
is TLS certificate
and PlatformCredential
is private key
.
For WNS, PlatformPrincipal
is Package Security Identifier
and PlatformCredential
is secret key
.
You can use the returned PlatformApplicationArn
as an attribute for the CreatePlatformEndpoint
action.