Smaws_Client_SNS.Typestype nonrec verify_sms_sandbox_phone_number_input = {one_time_password : otp_code;The OTP sent to the destination number from the CreateSMSSandBoxPhoneNumber call.
phone_number : phone_number_string;The destination phone number to verify.
*)}Indicates that the one-time password (OTP) used for verification is invalid.
Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
Can’t perform the action on the specified resource. Make sure that the resource exists.
Indicates that a request parameter does not comply with the associated constraints.
Indicates an internal service error.
Indicates that the user has been denied access to the requested resource.
Indicates that a parameter in the request is invalid.
Indicates that a request parameter does not comply with the associated constraints.
type nonrec tag_key_list = tag_key listtype nonrec untag_resource_request = {tag_keys : tag_key_list;The list of tag keys to remove from the specified topic.
*)resource_arn : amazon_resource_name;The ARN of the topic from which to remove tags.
*)}The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
Can't add more than 50 tags to a topic.
A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.
Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
type nonrec unsubscribe_input = {subscription_arn : subscription_ar_n;The ARN of the subscription to be deleted.
*)}Input for Unsubscribe action.
Indicates that the requested resource does not exist.
The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.
type nonrec topics_list = topic listIndicates that the customer already owns the maximum allowed number of topics.
type nonrec topic_attributes_map = (attribute_name * attribute_value) listThe batch request contains more entries than permissible (more than 10).
type nonrec tag = {value : tag_value;The optional value portion of the tag.
*)key : tag_key;The required key portion of the tag.
*)}The list of tags to be added to the specified topic.
type nonrec tag_list = tag listtype nonrec tag_resource_request = {resource_arn : amazon_resource_name;The ARN of the topic to which to add tags.
*)}type nonrec subscription = {topic_arn : topic_ar_n option;The ARN of the subscription's topic.
*)endpoint : endpoint2 option;The subscription's endpoint (format depends on the protocol).
*)protocol : protocol option;The subscription's protocol.
*)owner : account option;The subscription's owner.
*)subscription_arn : subscription_ar_n option;The subscription's ARN.
*)}A wrapper type for the attributes of an Amazon SNS subscription.
type nonrec subscriptions_list = subscription listIndicates that the customer already owns the maximum allowed number of subscriptions.
type nonrec subscription_attributes_map =
(attribute_name * attribute_value) listtype nonrec subscribe_response = {subscription_arn : subscription_ar_n option;The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires confirmation. However, if the API request parameter ReturnSubscriptionArn is true, then the value is always the subscription ARN, even if the subscription requires confirmation.
}Response for Subscribe action.
type nonrec subscribe_input = {return_subscription_arn : boolean_ option;Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.
If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes the pending subscription ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.
The default value is false.
attributes : subscription_attributes_map option;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:
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.endpoint : endpoint2 option;The endpoint that you want to receive notifications. Endpoints vary by protocol:
http protocol, the (public) endpoint is a URL beginning with http://.https protocol, the (public) endpoint is a URL beginning with https://.email protocol, the endpoint is an email address.email-json protocol, the endpoint is an email address.sms protocol, the endpoint is a phone number of an SMS-enabled device.sqs protocol, the endpoint is the ARN of an Amazon SQS queue.application protocol, the endpoint is the EndpointArn of a mobile app and device.lambda protocol, the endpoint is the ARN of an Lambda function.firehose protocol, the endpoint is the ARN of an Amazon Data Firehose delivery stream.protocol : protocol;The protocol that you want to use. Supported protocols include:
http – delivery of JSON-encoded message via HTTP POSThttps – delivery of JSON-encoded message via HTTPS POSTemail – delivery of message via SMTPemail-json – delivery of JSON-encoded message via SMTPsms – delivery of message via SMSsqs – delivery of JSON-encoded message to an Amazon SQS queueapplication – delivery of JSON-encoded message to an EndpointArn for a mobile app and devicelambda – delivery of JSON-encoded message to an Lambda functionfirehose – delivery of JSON-encoded message to an Amazon Data Firehose delivery stream.topic_arn : topic_ar_n;The ARN of the topic you want to subscribe to.
*)}Input for Subscribe action.
Indicates that the request parameter has exceeded the maximum number of concurrent message replays.
Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.
type nonrec set_topic_attributes_input = {attribute_value : attribute_value option;The new value for the attribute.
*)attribute_name : attribute_name;A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes 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.Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.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.HTTP
HTTPSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.HTTPSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.HTTPFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.Amazon Data Firehose
FirehoseSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint.FirehoseSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint.FirehoseFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint.Lambda
LambdaSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.LambdaSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.LambdaFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.Platform application endpoint
ApplicationSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an platform application endpoint.ApplicationSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an platform application endpoint.ApplicationFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an platform application endpoint.In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services.
For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status.
Amazon SQS
SQSSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.SQSSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.SQSFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.The SuccessFeedbackRoleArn and FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs.
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.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.The following attribute applies only to 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.
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.
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.topic_arn : topic_ar_n;The ARN of the topic to modify.
*)}Input for SetTopicAttributes action.
type nonrec set_subscription_attributes_input = {attribute_value : attribute_value option;The new value for the attribute in JSON format.
*)attribute_name : attribute_name;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:
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.
subscription_arn : subscription_ar_n;The ARN of the subscription to modify.
*)}Input for SetSubscriptionAttributes action.
type nonrec set_sms_attributes_input = {attributes : map_string_to_string;The default settings for sending SMS messages from your Amazon Web Services account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your Amazon Web Services account:
To receive the report, the bucket must have a policy that allows the Amazon SNS service principal to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.
*)}The input for the SetSMSAttributes action.
type nonrec set_platform_application_attributes_input = {attributes : map_string_to_string;A map of the platform application attributes. Attributes in this map include the following:
PlatformCredential – The credential received from the notification service.
PlatformCredentialis client secret.PlatformCredential is private key.PlatformCredential is signing key.PlatformPrincipal. The PlatformCredential is API key.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`.PlatformPrincipal – The principal received from the notification service.
PlatformPrincipalis client id.PlatformPrincipal is SSL certificate.PlatformPrincipal is signing key ID.PlatformPrincipal.EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.The following attributes only apply to APNs token-based authentication:
ApplePlatformTeamID – The identifier that's assigned to your Apple developer account team.ApplePlatformBundleID – The bundle identifier that's assigned to your iOS app.platform_application_arn : string_;PlatformApplicationArn for SetPlatformApplicationAttributes action.
}Input for SetPlatformApplicationAttributes action.
type nonrec set_endpoint_attributes_input = {attributes : map_string_to_string;A map of the endpoint attributes. Attributes in this map include the following:
CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.endpoint_arn : string_;EndpointArn used for SetEndpointAttributes action.
}Input for SetEndpointAttributes action.
Enum listing out all supported destination phone number verification statuses. The following enum values are supported. 1. PENDING : The destination phone number is pending verification. 2. VERIFIED : The destination phone number is verified.
type nonrec sms_sandbox_phone_number = {status : sms_sandbox_phone_number_verification_status option;The destination phone number's verification status.
*)phone_number : phone_number_string option;The destination phone number.
*)}A verified or pending destination phone number in the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
type nonrec sms_sandbox_phone_number_list = sms_sandbox_phone_number listEnum listing out all supported route types. The following enum values are supported. 1. Transactional : Non-marketing traffic 2. Promotional : Marketing 3. Premium : Premium routes for OTP delivery to the carriers
type nonrec remove_permission_input = {label : label;The unique label of the statement you want to remove.
*)topic_arn : topic_ar_n;The ARN of the topic whose access control policy you wish to modify.
*)}Input for RemovePermission action.
type nonrec put_data_protection_policy_input = {data_protection_policy : attribute_value;The JSON serialization of the topic's DataProtectionPolicy.
The DataProtectionPolicy must be in JSON string format.
Length Constraints: Maximum length of 30,720.
*)resource_arn : topic_ar_n;The ARN of the topic whose DataProtectionPolicy you want to add or update.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
*)}type nonrec publish_response = {sequence_number : string_ option;This response element applies only to FIFO (first-in-first-out) topics.
The sequence number is a large, non-consecutive number that Amazon SNS assigns to each message. The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for each MessageGroupId.
message_id : message_id option;Unique identifier assigned to the published message.
Length Constraint: Maximum 100 characters
*)}Response for Publish action.
type nonrec message_attribute_value = {binary_value : binary option;Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
*)string_value : string_ option;Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.
*)data_type : string_;Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types.
*)}The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish.
Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Amazon SNS message attributes and Publishing to a mobile phone in the Amazon SNS Developer Guide.
type nonrec message_attribute_map = (string_ * message_attribute_value) listtype nonrec publish_input = {message_group_id : string_ option;The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
For FIFO topics: The MessageGroupId is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId.
For standard topics: The MessageGroupId is optional and is forwarded only to Amazon SQS standard subscriptions to activate fair queues. The MessageGroupId is not used for, or sent to, any other endpoint types. When provided, the same validation rules apply as for FIFO topics.
message_deduplication_id : string_ option;MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).MessageDeduplicationId, which is a token used for deduplication of sent messages within the 5 minute minimum deduplication interval.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.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:
MessageDeduplicationId explicitly.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).MessageDeduplicationId and the topic doesn't have ContentBasedDeduplication set, the action fails with an error.ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.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.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.message_attributes : message_attribute_map option;Message attributes for Publish action.
*)message_structure : message_structure option;Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
Valid value: json
subject : subject option;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.
*)message : message;The message you want to send.
If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.
Constraints:
For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
Publish call to return an error (no partial delivery).phone_number : phone_number option;The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters.
target_arn : string_ option;If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.
topic_arn : topic_ar_n option;The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.
}Input for Publish action.
type nonrec publish_batch_result_entry = {sequence_number : string_ option;This parameter applies only to FIFO (first-in-first-out) topics.
The large, non-consecutive number that Amazon SNS assigns to each message.
The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.
message_id : message_id option;An identifier for the message.
*)id : string_ option;The Id of an entry in a batch request.
}Encloses data related to a successful message in a batch request for topic.
type nonrec publish_batch_result_entry_list = publish_batch_result_entry listtype nonrec batch_result_error_entry = {sender_fault : boolean_;Specifies whether the error happened due to the caller of the batch API action.
*)message : string_ option;A message explaining why the action failed on this entry.
*)code : string_;An error code representing why the action failed on this entry.
*)id : string_;The Id of an entry in a batch request
}Gives a detailed description of failed messages in the batch.
type nonrec batch_result_error_entry_list = batch_result_error_entry listtype nonrec publish_batch_response = {failed : batch_result_error_entry_list option;A list of failed PublishBatch responses.
successful : publish_batch_result_entry_list option;A list of successful PublishBatch responses.
}type nonrec publish_batch_request_entry = {message_group_id : string_ option;FIFO topics: The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single topic, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the topic, but the session data of each user is processed in a FIFO fashion. You must associate a non-empty MessageGroupId with a message. If you do not provide a MessageGroupId, the action fails.
Standard topics: The MessageGroupId is optional and is forwarded only to Amazon SQS standard subscriptions to activate fair queues. The MessageGroupId is not used for, or sent to, any other endpoint types.
The length of MessageGroupId is 128 characters.
MessageGroupId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
message_deduplication_id : string_ option;This parameter applies only to FIFO (first-in-first-out) topics.
MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).MessageDeduplicationId, which is a token used for deduplication of sent messages within the 5 minute minimum deduplication interval.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.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.
MessageDeduplicationId explicitly.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).MessageDeduplicationId and the topic doesn't have ContentBasedDeduplication set, the action fails with an error.ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.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.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.The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SNS can't detect duplicate messages.
Amazon SNS continues to keep track of the message deduplication ID even after the message is received and deleted.
*)message_attributes : message_attribute_map option;Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SNS message attributes in the Amazon SNS Developer Guide.
message_structure : message_structure option;Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:
You can define other top-level keys that define the message you want to send to a specific transport protocol (for example, http).
*)subject : subject option;The subject of the batch message.
*)message : message;The body of the message.
*)id : string_;An identifier for the message in this batch.
The Ids of a batch request must be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
*)}Contains the details of a single Amazon SNS message along with an Id that identifies a message within the batch.
type nonrec publish_batch_request_entry_list = publish_batch_request_entry listtype nonrec publish_batch_input = {publish_batch_request_entries : publish_batch_request_entry_list;A list of PublishBatch request entries to be sent to the SNS topic.
topic_arn : topic_ar_n;The Amazon resource name (ARN) of the topic you want to batch publish to.
*)}type nonrec platform_application_disabled_exception = {message : string_ option;Message for platform application disabled.
*)}Exception error indicating platform application disabled.
The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide.
The Amazon Web Services access key ID needs a subscription for the service.
The request was rejected because the specified entity or resource can't be found.
The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide.
The request was rejected because the specified Amazon Web Services KMS key isn't enabled.
The ciphertext references a key that doesn't exist or that you don't have access to.
type nonrec invalid_parameter_value_exception = {message : string_ option;The parameter of an entry in a request doesn't abide by the specification.
*)}Indicates that a request parameter does not comply with the associated constraints.
The Id of a batch entry in a batch request doesn't abide by the specification.
type nonrec endpoint_disabled_exception = {message : string_ option;Message for endpoint disabled.
*)}Exception error indicating endpoint disabled.
The batch request doesn't contain any entries.
The length of all the batch messages put together is more than the limit.
Two or more batch entries in the request have the same Id.
type nonrec platform_application = {attributes : map_string_to_string option;Attributes for platform application object.
*)platform_application_arn : string_ option;PlatformApplicationArn for platform application object.
*)}Platform application object.
type nonrec phone_number_list = phone_number listEnum listing out all supported number capabilities.
type nonrec number_capability_list = number_capability listtype nonrec phone_number_information = {number_capabilities : number_capability_list option;The capabilities of each phone number.
*)route_type : route_type option;The list of supported routes.
*)iso2_country_code : iso2_country_code option;The two-character code for the country or region, in ISO 3166-1 alpha-2 format.
*)status : string_ option;The status of the phone number.
*)phone_number : phone_number option;The phone number.
*)created_at : timestamp option;The date and time when the phone number was created.
*)}A list of phone numbers and their metadata.
type nonrec phone_number_information_list = phone_number_information listIndicates that the specified phone number opted out of receiving SMS messages from your Amazon Web Services account. You can't send SMS messages to phone numbers that opt out.
type nonrec opt_in_phone_number_input = {phone_number : phone_number;The phone number to opt in. Use E.164 format.
*)}Input for the OptInPhoneNumber action.
type nonrec list_topics_response = {next_token : next_token option;Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
topics : topics_list option;A list of topic ARNs.
*)}Response for ListTopics action.
type nonrec list_topics_input = {next_token : next_token option;Token returned by the previous ListTopics request.
}type nonrec list_subscriptions_response = {next_token : next_token option;Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.
subscriptions : subscriptions_list option;A list of subscriptions.
*)}Response for ListSubscriptions action
type nonrec list_subscriptions_input = {next_token : next_token option;Token returned by the previous ListSubscriptions request.
}Input for ListSubscriptions action.
type nonrec list_subscriptions_by_topic_response = {next_token : next_token option;Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.
subscriptions : subscriptions_list option;A list of subscriptions.
*)}Response for ListSubscriptionsByTopic action.
type nonrec list_subscriptions_by_topic_input = {next_token : next_token option;Token returned by the previous ListSubscriptionsByTopic request.
topic_arn : topic_ar_n;The ARN of the topic for which you wish to find subscriptions.
*)}Input for ListSubscriptionsByTopic action.
type nonrec list_string = string_ listtype nonrec list_sms_sandbox_phone_numbers_result = {next_token : string_ option;A NextToken string is returned when you call the ListSMSSandboxPhoneNumbersInput operation if additional pages of records are available.
phone_numbers : sms_sandbox_phone_number_list;A list of the calling account's pending and verified phone numbers.
*)}type nonrec list_sms_sandbox_phone_numbers_input = {max_results : max_items option;The maximum number of phone numbers to return.
*)next_token : next_token option;Token that the previous ListSMSSandboxPhoneNumbersInput request returns.
}type nonrec list_of_platform_applications = platform_application listtype nonrec list_platform_applications_response = {next_token : string_ option;NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.
platform_applications : list_of_platform_applications option;Platform applications returned when calling ListPlatformApplications action.
}Response for ListPlatformApplications action.
type nonrec list_platform_applications_input = {next_token : string_ option;NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.
}Input for ListPlatformApplications action.
type nonrec list_phone_numbers_opted_out_response = {next_token : string_ option;A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.
phone_numbers : phone_number_list option;A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.
*)}The response from the ListPhoneNumbersOptedOut action.
type nonrec list_phone_numbers_opted_out_input = {next_token : string_ option;A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.
}The input for the ListPhoneNumbersOptedOut action.
type nonrec list_origination_numbers_result = {phone_numbers : phone_number_information_list option;A list of the calling account's verified and pending origination numbers.
*)next_token : next_token option;A NextToken string is returned when you call the ListOriginationNumbers operation if additional pages of records are available.
}type nonrec list_origination_numbers_request = {max_results : max_items_list_origination_numbers option;The maximum number of origination numbers to return.
*)next_token : next_token option;Token that the previous ListOriginationNumbers request returns.
}type nonrec endpoint = {attributes : map_string_to_string option;Attributes for endpoint.
*)endpoint_arn : string_ option;The EndpointArn for mobile app and device.
}The endpoint for mobile app and device.
type nonrec list_of_endpoints = endpoint listtype nonrec list_endpoints_by_platform_application_response = {next_token : string_ option;NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.
endpoints : list_of_endpoints option;Endpoints returned for ListEndpointsByPlatformApplication action.
}Response for ListEndpointsByPlatformApplication action.
type nonrec list_endpoints_by_platform_application_input = {next_token : string_ option;NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.
platform_application_arn : string_;PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
}Input for ListEndpointsByPlatformApplication action.
Indicates that the specified state is not a valid state for an event source.
type nonrec get_topic_attributes_response = {attributes : topic_attributes_map option;A map of the topic's attributes. Attributes in this map include the following:
DeliveryPolicy – The JSON serialization of the topic's delivery policy.DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.Owner – The Amazon Web Services account ID of the topic's owner.Policy – The JSON serialization of the topic's access control policy.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.
SignatureVersion is set to 1. The signature is a Base64-encoded SHA1withRSA signature.When you set SignatureVersion to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature.
If the API response does not include the SignatureVersion attribute, it means that the SignatureVersion for the topic has value 1.
SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.SubscriptionsDeleted – The number of deleted subscriptions for the topic.SubscriptionsPending – The number of subscriptions pending confirmation for the topic.TopicArn – The topic's ARN.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 – 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 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.
FifoTopic – When this is set to true, a FIFO topic is created.}Response for GetTopicAttributes action.
type nonrec get_topic_attributes_input = {topic_arn : topic_ar_n;The ARN of the topic whose properties you want to get.
*)}Input for GetTopicAttributes action.
type nonrec get_subscription_attributes_response = {attributes : subscription_attributes_map option;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:
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.
type nonrec get_subscription_attributes_input = {subscription_arn : subscription_ar_n;The ARN of the subscription whose properties you want to get.
*)}Input for GetSubscriptionAttributes.
type nonrec get_sms_sandbox_account_status_result = {is_in_sandbox : boolean_;Indicates whether the calling Amazon Web Services account is in the SMS sandbox.
*)}type nonrec get_sms_attributes_response = {attributes : map_string_to_string option;The SMS attribute names and their values.
*)}The response from the GetSMSAttributes request.
type nonrec get_sms_attributes_input = {attributes : list_string option;A list of the individual attribute names, such as MonthlySpendLimit, for which you want values.
For all attribute names, see SetSMSAttributes.
If you don't use this parameter, Amazon SNS returns all SMS attributes.
*)}The input for the GetSMSAttributes request.
type nonrec get_platform_application_attributes_response = {attributes : map_string_to_string option;Attributes include the following:
AppleCertificateExpiryDate – The expiry date of the SSL certificate used to configure certificate-based authentication.ApplePlatformTeamID – The Apple developer account ID used to configure token-based authentication.ApplePlatformBundleID – The app identifier used to configure token-based authentication.AuthenticationMethod – Returns the credential type used when sending push notifications from application to APNS/APNS_Sandbox, or application to GCM.
EventEndpointCreated – Topic ARN to which EndpointCreated event notifications should be sent.EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications should be sent.EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications should be sent.EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.}Response for GetPlatformApplicationAttributes action.
type nonrec get_platform_application_attributes_input = {platform_application_arn : string_;PlatformApplicationArn for GetPlatformApplicationAttributesInput.
}Input for GetPlatformApplicationAttributes action.
type nonrec get_endpoint_attributes_response = {attributes : map_string_to_string option;Attributes include the following:
CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.
The device token for the iOS platform is returned in lowercase.
}Response from GetEndpointAttributes of the EndpointArn.
type nonrec get_endpoint_attributes_input = {endpoint_arn : string_;EndpointArn for GetEndpointAttributes input.
}Input for GetEndpointAttributes action.
type nonrec get_data_protection_policy_response = {data_protection_policy : attribute_value option;Retrieves the DataProtectionPolicy in JSON string format.
}type nonrec get_data_protection_policy_input = {resource_arn : topic_ar_n;The ARN of the topic whose DataProtectionPolicy you want to get.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
*)}type nonrec delete_topic_input = {topic_arn : topic_ar_n;The ARN of the topic you want to delete.
*)}type nonrec delete_sms_sandbox_phone_number_input = {phone_number : phone_number_string;The destination phone number to delete.
*)}type nonrec delete_platform_application_input = {platform_application_arn : string_;PlatformApplicationArn of platform application object to delete.
}Input for DeletePlatformApplication action.
Input for DeleteEndpoint action.
type nonrec delegates_list = delegate listtype nonrec create_topic_response = {topic_arn : topic_ar_n option;The Amazon Resource Name (ARN) assigned to the created topic.
*)}Response from CreateTopic action.
type nonrec create_topic_input = {data_protection_policy : attribute_value option;The body of the policy document you want to use for this topic.
You can only add one policy per topic.
The policy must be in JSON string format.
Length Constraints: Maximum length of 30,720.
*)attributes : topic_attributes_map option;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.Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.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.HTTP
HTTPSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.HTTPSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.HTTPFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.Amazon Data Firehose
FirehoseSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint.FirehoseSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint.FirehoseFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint.Lambda
LambdaSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.LambdaSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.LambdaFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.Platform application endpoint
ApplicationSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.ApplicationSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an platform application endpoint.ApplicationFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an platform application endpoint.In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services.
For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status.
Amazon SQS
SQSSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.SQSSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.SQSFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.The SuccessFeedbackRoleArn and FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs.
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 – 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.
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.
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.name : topic_name;The name of the topic you want to create.
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.
}Input for CreateTopic action.
type nonrec create_sms_sandbox_phone_number_input = {language_code : language_code_string option;The language to use for sending the OTP. The default value is en-US.
phone_number : phone_number_string;The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to.
*)}type nonrec create_platform_endpoint_input = {attributes : map_string_to_string option;custom_user_data : string_ option;Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
*)token : string_;Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.
*)platform_application_arn : string_;PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
}Input for CreatePlatformEndpoint action.
type nonrec create_endpoint_response = {endpoint_arn : string_ option;EndpointArn returned from CreateEndpoint action.
*)}Response from CreateEndpoint action.
type nonrec create_platform_application_response = {platform_application_arn : string_ option;PlatformApplicationArn is returned.
}Response from CreatePlatformApplication action.
type nonrec create_platform_application_input = {attributes : map_string_to_string;platform : string_;The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).
*)name : string_;Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.
*)}Input for CreatePlatformApplication action.
type nonrec confirm_subscription_response = {subscription_arn : subscription_ar_n option;The ARN of the created subscription.
*)}Response for ConfirmSubscriptions action.
type nonrec confirm_subscription_input = {authenticate_on_unsubscribe : authenticate_on_unsubscribe option;Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.
token : token;Short-lived token sent to an endpoint during the Subscribe action.
topic_arn : topic_ar_n;The ARN of the topic for which you wish to confirm a subscription.
*)}Input for ConfirmSubscription action.
type nonrec check_if_phone_number_is_opted_out_response = {is_opted_out : boolean_ option;Indicates whether the phone number is opted out:
true – The phone number is opted out, meaning you cannot publish SMS messages to it.false – The phone number is opted in, meaning you can publish SMS messages to it.}The response from the CheckIfPhoneNumberIsOptedOut action.
type nonrec check_if_phone_number_is_opted_out_input = {phone_number : phone_number;The phone number for which you want to check the opt out status.
*)}The input for the CheckIfPhoneNumberIsOptedOut action.
type nonrec actions_list = action listtype nonrec add_permission_input = {action_name : actions_list;The action you want to allow for the specified principal(s).
Valid values: Any Amazon SNS action name, for example Publish.
aws_account_id : delegates_list;The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service.
*)label : label;A unique identifier for the new policy statement.
*)topic_arn : topic_ar_n;The ARN of the topic whose access control policy you wish to modify.
*)}