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

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.

Exception error indicating endpoint disabled.

Indicates that a parameter in the request is invalid.

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

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

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

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

Exception error indicating platform application disabled.

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

Indicates an internal service error.

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

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

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

Indicates that the requested resource does not exist.

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.

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

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

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

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

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

Indicates that the specified phone number opted out of receiving SMS messages from your account. You can't send SMS messages to phone numbers that opt out.

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

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

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

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

Indicates that the number of filter polices in your account exceeds the limit. To add more filter polices, submit an SNS Limit Increase case in the Amazon Web Services Support Center.

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

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.

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 - EndpointArn for mobile app and device.

Attributes for endpoint.

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:status:PhoneNumberInformation', phoneNumberInformation_status - The status of the phone number.

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

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

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

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

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

The status of the phone number.

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

The date and time when the phone number was created.

The phone number.

The capabilities of each phone number.

The list of supported routes.

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:platformApplicationArn:PlatformApplication', platformApplication_platformApplicationArn - PlatformApplicationArn for platform application object.

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

PlatformApplicationArn for platform application object.

Attributes for platform application object.

A verified or pending destination phone number in the SMS sandbox.

When you start using Amazon SNS to send SMS messages, your 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 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:status:SMSSandboxPhoneNumber', sMSSandboxPhoneNumber_status - The destination phone number's verification status.

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

The destination phone number's verification status.

The destination phone number.

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:protocol:Subscription', subscription_protocol - The subscription's protocol.

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

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

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

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

The subscription's protocol.

The subscription's owner.

The ARN of the subscription's topic.

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

The subscription's ARN.

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

See: newTag smart constructor.

Create a value of Tag 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:key:Tag', tag_key - The required key portion of the tag.

$sel:value:Tag', tag_value - The optional value portion of the tag.

The required key portion of the tag.

The optional value portion of the tag.

A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.

See: newTopic smart constructor.

Create a value of Topic 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:topicArn:Topic', topic_topicArn - The topic's ARN.

The topic's ARN.