API version 2010-03-31 of the Amazon Simple Notification Service SDK configuration.

Indicates that the user has been denied access to the requested resource.

Two or more batch entries in the request have the same Id.

The length of all the batch messages put together is more than the limit.

Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.

The batch request doesn't contain any entries.

Exception error indicating endpoint disabled.

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.

Indicates an internal service error.

The Id of a batch entry in a batch request doesn't abide by the specification.

Indicates that a request parameter does not comply with the associated constraints.

Indicates that a request parameter does not comply with the associated constraints.

The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.

The ciphertext references a key that doesn't exist or that you don't have access to.

The request was rejected because the specified customer master key (CMK) isn't enabled.

The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the Key Management Service Developer Guide.

The request was rejected because the specified entity or resource can't be found.

The Amazon Web Services access key ID needs a subscription for the service.

The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide.

Indicates that the requested resource does not exist.

Indicates 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.

Exception error indicating platform application disabled.

Can’t perform the action on the specified resource. Make sure that the resource exists.

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.

Indicates that the customer already owns the maximum allowed number of subscriptions.

Can't add more than 50 tags to a topic.

The request doesn't comply with the IAM tag policy. Correct your request and then retry it.

Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.

The batch request contains more entries than permissible.

Indicates that the customer already owns the maximum allowed number of topics.

Indicates that a request parameter does not comply with the associated constraints.

Indicates that a parameter in the request is invalid.

Indicates that the one-time password (OTP) used for verification is invalid.

Supported language code for sending OTP message

Enum listing out all supported number capabilities.

Enum 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

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.

Gives a detailed description of failed messages in the batch.

See: newBatchResultErrorEntry smart constructor.

Create a value of BatchResultErrorEntry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:message:BatchResultErrorEntry', batchResultErrorEntry_message - A message explaining why the action failed on this entry.

$sel:id:BatchResultErrorEntry', batchResultErrorEntry_id - The Id of an entry in a batch request

$sel:code:BatchResultErrorEntry', batchResultErrorEntry_code - An error code representing why the action failed on this entry.

$sel:senderFault:BatchResultErrorEntry', batchResultErrorEntry_senderFault - Specifies whether the error happened due to the caller of the batch API action.

A message explaining why the action failed on this entry.

The Id of an entry in a batch request

An error code representing why the action failed on this entry.

Specifies whether the error happened due to the caller of the batch API action.

The endpoint for mobile app and device.

See: newEndpoint smart constructor.

Create a value of Endpoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributes:Endpoint', endpoint_attributes - Attributes for endpoint.

$sel:endpointArn:Endpoint', endpoint_endpointArn - The EndpointArn for mobile app and device.

Attributes for endpoint.

The EndpointArn for mobile app and device.

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.

See: newMessageAttributeValue smart constructor.

Create a value of MessageAttributeValue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:binaryValue:MessageAttributeValue', messageAttributeValue_binaryValue - Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:stringValue:MessageAttributeValue', messageAttributeValue_stringValue - Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.

$sel:dataType:MessageAttributeValue', messageAttributeValue_dataType - Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types.

Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.

Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types.

A list of phone numbers and their metadata.

See: newPhoneNumberInformation smart constructor.

Create a value of PhoneNumberInformation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdAt:PhoneNumberInformation', phoneNumberInformation_createdAt - The date and time when the phone number was created.

$sel:iso2CountryCode:PhoneNumberInformation', phoneNumberInformation_iso2CountryCode - The two-character code for the country or region, in ISO 3166-1 alpha-2 format.

$sel:numberCapabilities:PhoneNumberInformation', phoneNumberInformation_numberCapabilities - The capabilities of each phone number.

$sel:phoneNumber:PhoneNumberInformation', phoneNumberInformation_phoneNumber - The phone number.

$sel:routeType:PhoneNumberInformation', phoneNumberInformation_routeType - The list of supported routes.

$sel:status:PhoneNumberInformation', phoneNumberInformation_status - The status of the phone number.

The date and time when the phone number was created.

The two-character code for the country or region, in ISO 3166-1 alpha-2 format.

The capabilities of each phone number.

The phone number.

The list of supported routes.

The status of the phone number.

Platform application object.

See: newPlatformApplication smart constructor.

Create a value of PlatformApplication with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributes:PlatformApplication', platformApplication_attributes - Attributes for platform application object.

$sel:platformApplicationArn:PlatformApplication', platformApplication_platformApplicationArn - PlatformApplicationArn for platform application object.

Attributes for platform application object.

PlatformApplicationArn for platform application object.

Contains the details of a single Amazon SNS message along with an Id that identifies a message within the batch.

See: newPublishBatchRequestEntry smart constructor.

Create a value of PublishBatchRequestEntry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:messageAttributes:PublishBatchRequestEntry', publishBatchRequestEntry_messageAttributes - Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SNS message attributes in the Amazon SNS Developer Guide.

$sel:messageDeduplicationId:PublishBatchRequestEntry', publishBatchRequestEntry_messageDeduplicationId - This parameter applies only to FIFO (first-in-first-out) topics.

The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered.

• Every message must have a unique MessageDeduplicationId.

  • You may provide a MessageDeduplicationId explicitly.
  • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your topic, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
  • If you don't provide a MessageDeduplicationId and the topic doesn't have ContentBasedDeduplication set, the action fails with an error.
  • If the topic has a ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
• When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
• If you send one message with ContentBasedDeduplication enabled, and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

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.

The length of MessageDeduplicationId is 128 characters.

MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

$sel:messageGroupId:PublishBatchRequestEntry', publishBatchRequestEntry_messageGroupId - This parameter applies only to FIFO (first-in-first-out) 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 don't provide a MessageGroupId, the action fails.

The length of MessageGroupId is 128 characters.

MessageGroupId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

MessageGroupId is required for FIFO topics. You can't use it for standard topics.

$sel:messageStructure:PublishBatchRequestEntry', publishBatchRequestEntry_messageStructure - 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:

• be a syntactically valid JSON object; and
• contain at least a top-level JSON key of "default" with a value that is a string.

You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g. http).

$sel:subject:PublishBatchRequestEntry', publishBatchRequestEntry_subject - The subject of the batch message.

$sel:id:PublishBatchRequestEntry', publishBatchRequestEntry_id - 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 (_).

$sel:message:PublishBatchRequestEntry', publishBatchRequestEntry_message - The body of the message.

Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SNS message attributes in the Amazon SNS Developer Guide.

This parameter applies only to FIFO (first-in-first-out) topics.

The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered.

• Every message must have a unique MessageDeduplicationId.

  • You may provide a MessageDeduplicationId explicitly.
  • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your topic, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
  • If you don't provide a MessageDeduplicationId and the topic doesn't have ContentBasedDeduplication set, the action fails with an error.
  • If the topic has a ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
• When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
• If you send one message with ContentBasedDeduplication enabled, and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

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.

The length of MessageDeduplicationId is 128 characters.

MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

This parameter applies only to FIFO (first-in-first-out) 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 don't provide a MessageGroupId, the action fails.

The length of MessageGroupId is 128 characters.

MessageGroupId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

MessageGroupId is required for FIFO topics. You can't use it for standard topics.

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:

• be a syntactically valid JSON object; and
• contain at least a top-level JSON key of "default" with a value that is a string.

You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g. http).

The subject of the batch message.

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 (_).

The body of the message.

Encloses data related to a successful message in a batch request for topic.

See: newPublishBatchResultEntry smart constructor.

Create a value of PublishBatchResultEntry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:PublishBatchResultEntry', publishBatchResultEntry_id - The Id of an entry in a batch request.

$sel:messageId:PublishBatchResultEntry', publishBatchResultEntry_messageId - An identifier for the message.

$sel:sequenceNumber:PublishBatchResultEntry', publishBatchResultEntry_sequenceNumber - 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.

The Id of an entry in a batch request.

An identifier for the message.

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.

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.

See: newSMSSandboxPhoneNumber smart constructor.

Create a value of SMSSandboxPhoneNumber with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:phoneNumber:SMSSandboxPhoneNumber', sMSSandboxPhoneNumber_phoneNumber - The destination phone number.

$sel:status:SMSSandboxPhoneNumber', sMSSandboxPhoneNumber_status - The destination phone number's verification status.

The destination phone number.

The destination phone number's verification status.

A wrapper type for the attributes of an Amazon SNS subscription.

See: newSubscription smart constructor.

Create a value of Subscription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endpoint:Subscription', subscription_endpoint - The subscription's endpoint (format depends on the protocol).

$sel:owner:Subscription', subscription_owner - The subscription's owner.

$sel:protocol:Subscription', subscription_protocol - The subscription's protocol.

$sel:subscriptionArn:Subscription', subscription_subscriptionArn - The subscription's ARN.

$sel:topicArn:Subscription', subscription_topicArn - The ARN of the subscription's topic.

The subscription's endpoint (format depends on the protocol).

The subscription's owner.

The subscription's protocol.

The subscription's ARN.

The ARN of the subscription's topic.

The list of tags to be added to the specified topic.

See: newTag smart constructor.