{ "version":"2.0", "metadata":{ "apiVersion":"2010-03-31", "endpointPrefix":"sns", "protocol":"query", "serviceAbbreviation":"Amazon SNS", "serviceFullName":"Amazon Simple Notification Service", "serviceId":"SNS", "signatureVersion":"v4", "uid":"sns-2010-03-31", "xmlNamespace":"http://sns.amazonaws.com/doc/2010-03-31/" }, "operations":{ "AddPermission":{ "name":"AddPermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddPermissionInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.

To remove the ability to change topic permissions, you must deny permissions to the `AddPermission`, `RemovePermission`, and `SetTopicAttributes` actions in your IAM policy.

" }, "CheckIfPhoneNumberIsOptedOut":{ "name":"CheckIfPhoneNumberIsOptedOut", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CheckIfPhoneNumberIsOptedOutInput"}, "output":{ "shape":"CheckIfPhoneNumberIsOptedOutResponse", "resultWrapper":"CheckIfPhoneNumberIsOptedOutResult" }, "errors":[ {"shape":"ThrottledException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out.

To resume sending messages, you can opt in the number by using the `OptInPhoneNumber` action.

" }, "ConfirmSubscription":{ "name":"ConfirmSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmSubscriptionInput"}, "output":{ "shape":"ConfirmSubscriptionResponse", "resultWrapper":"ConfirmSubscriptionResult" }, "errors":[ {"shape":"SubscriptionLimitExceededException"}, {"shape":"InvalidParameterException"}, {"shape":"NotFoundException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"FilterPolicyLimitExceededException"}, {"shape":"ReplayLimitExceededException"} ], "documentation":"

Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier `Subscribe` action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the `AuthenticateOnUnsubscribe` flag is set to \"true\".

" }, "CreatePlatformApplication":{ "name":"CreatePlatformApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlatformApplicationInput"}, "output":{ "shape":"CreatePlatformApplicationResponse", "resultWrapper":"CreatePlatformApplicationResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify `PlatformPrincipal` and `PlatformCredential` attributes when using the `CreatePlatformApplication` action.

`PlatformPrincipal` and `PlatformCredential` are received from the notification service.

- For `ADM`, `PlatformPrincipal` is `client id` and `PlatformCredential` is `client secret`.

- For `Baidu`, `PlatformPrincipal` is `API key` and `PlatformCredential` is `secret key`.

- For `APNS` and `APNS_SANDBOX` using certificate credentials, `PlatformPrincipal` is `SSL certificate` and `PlatformCredential` is `private key`.

- For `APNS` and `APNS_SANDBOX` using token credentials, `PlatformPrincipal` is `signing key ID` and `PlatformCredential` is `signing key`.

- For `GCM` (Firebase Cloud Messaging), there is no `PlatformPrincipal` and the `PlatformCredential` is `API key`.

- For `MPNS`, `PlatformPrincipal` is `TLS certificate` and `PlatformCredential` is `private key`.

- For `WNS`, `PlatformPrincipal` is `Package Security Identifier` and `PlatformCredential` is `secret key`.

You can use the returned `PlatformApplicationArn` as an attribute for the `CreatePlatformEndpoint` action.

" }, "CreatePlatformEndpoint":{ "name":"CreatePlatformEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlatformEndpointInput"}, "output":{ "shape":"CreateEndpointResponse", "resultWrapper":"CreatePlatformEndpointResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. `CreatePlatformEndpoint` requires the `PlatformApplicationArn` that is returned from `CreatePlatformApplication`. You can use the returned `EndpointArn` to send a message to a mobile app or by the `Subscribe` action for subscription to a topic. The `CreatePlatformEndpoint` action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.

When using `CreatePlatformEndpoint` with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.

" }, "CreateSMSSandboxPhoneNumber":{ "name":"CreateSMSSandboxPhoneNumber", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSMSSandboxPhoneNumberInput"}, "output":{ "shape":"CreateSMSSandboxPhoneNumberResult", "resultWrapper":"CreateSMSSandboxPhoneNumberResult" }, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"OptedOutException"}, {"shape":"UserErrorException"}, {"shape":"ThrottledException"} ], "documentation":"

Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number.

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.

" }, "CreateTopic":{ "name":"CreateTopic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTopicInput"}, "output":{ "shape":"CreateTopicResponse", "resultWrapper":"CreateTopicResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"TopicLimitExceededException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidSecurityException"}, {"shape":"TagLimitExceededException"}, {"shape":"StaleTagException"}, {"shape":"TagPolicyException"}, {"shape":"ConcurrentAccessException"} ], "documentation":"

Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.

" }, "DeleteEndpoint":{ "name":"DeleteEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteEndpointInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.

When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.

" }, "DeletePlatformApplication":{ "name":"DeletePlatformApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePlatformApplicationInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "DeleteSMSSandboxPhoneNumber":{ "name":"DeleteSMSSandboxPhoneNumber", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSMSSandboxPhoneNumberInput"}, "output":{ "shape":"DeleteSMSSandboxPhoneNumberResult", "resultWrapper":"DeleteSMSSandboxPhoneNumberResult" }, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"UserErrorException"}, {"shape":"ThrottledException"} ], "documentation":"

Deletes an Amazon Web Services account's verified or pending phone number from 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.

" }, "DeleteTopic":{ "name":"DeleteTopic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTopicInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InvalidStateException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"}, {"shape":"StaleTagException"}, {"shape":"TagPolicyException"}, {"shape":"ConcurrentAccessException"} ], "documentation":"

Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.

" }, "GetDataProtectionPolicy":{ "name":"GetDataProtectionPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDataProtectionPolicyInput"}, "output":{ "shape":"GetDataProtectionPolicyResponse", "resultWrapper":"GetDataProtectionPolicyResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidSecurityException"} ], "documentation":"

Retrieves the specified inline `DataProtectionPolicy` document that is stored in the specified Amazon SNS topic.

" }, "GetEndpointAttributes":{ "name":"GetEndpointAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetEndpointAttributesInput"}, "output":{ "shape":"GetEndpointAttributesResponse", "resultWrapper":"GetEndpointAttributesResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "GetPlatformApplicationAttributes":{ "name":"GetPlatformApplicationAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPlatformApplicationAttributesInput"}, "output":{ "shape":"GetPlatformApplicationAttributesResponse", "resultWrapper":"GetPlatformApplicationAttributesResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "GetSMSAttributes":{ "name":"GetSMSAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSMSAttributesInput"}, "output":{ "shape":"GetSMSAttributesResponse", "resultWrapper":"GetSMSAttributesResult" }, "errors":[ {"shape":"ThrottledException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Returns the settings for sending SMS messages from your Amazon Web Services account.

These settings are set with the `SetSMSAttributes` action.

" }, "GetSMSSandboxAccountStatus":{ "name":"GetSMSSandboxAccountStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSMSSandboxAccountStatusInput"}, "output":{ "shape":"GetSMSSandboxAccountStatusResult", "resultWrapper":"GetSMSSandboxAccountStatusResult" }, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InternalErrorException"}, {"shape":"ThrottledException"} ], "documentation":"

Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.

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.

" }, "GetSubscriptionAttributes":{ "name":"GetSubscriptionAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSubscriptionAttributesInput"}, "output":{ "shape":"GetSubscriptionAttributesResponse", "resultWrapper":"GetSubscriptionAttributesResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Returns all of the properties of a subscription.

" }, "GetTopicAttributes":{ "name":"GetTopicAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetTopicAttributesInput"}, "output":{ "shape":"GetTopicAttributesResponse", "resultWrapper":"GetTopicAttributesResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidSecurityException"} ], "documentation":"

Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

" }, "ListEndpointsByPlatformApplication":{ "name":"ListEndpointsByPlatformApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEndpointsByPlatformApplicationInput"}, "output":{ "shape":"ListEndpointsByPlatformApplicationResponse", "resultWrapper":"ListEndpointsByPlatformApplicationResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for `ListEndpointsByPlatformApplication` are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call `ListEndpointsByPlatformApplication` again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

This action is throttled at 30 transactions per second (TPS).

" }, "ListOriginationNumbers":{ "name":"ListOriginationNumbers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListOriginationNumbersRequest"}, "output":{ "shape":"ListOriginationNumbersResult", "resultWrapper":"ListOriginationNumbersResult" }, "errors":[ {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"ThrottledException"}, {"shape":"InvalidParameterException"}, {"shape":"ValidationException"} ], "documentation":"

Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.

" }, "ListPhoneNumbersOptedOut":{ "name":"ListPhoneNumbersOptedOut", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPhoneNumbersOptedOutInput"}, "output":{ "shape":"ListPhoneNumbersOptedOutResponse", "resultWrapper":"ListPhoneNumbersOptedOutResult" }, "errors":[ {"shape":"ThrottledException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.

The results for `ListPhoneNumbersOptedOut` are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a `NextToken` string will be returned. To receive the next page, you call `ListPhoneNumbersOptedOut` again using the `NextToken` string received from the previous call. When there are no more records to return, `NextToken` will be null.

" }, "ListPlatformApplications":{ "name":"ListPlatformApplications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPlatformApplicationsInput"}, "output":{ "shape":"ListPlatformApplicationsResponse", "resultWrapper":"ListPlatformApplicationsResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for `ListPlatformApplications` are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call `ListPlatformApplications` using the NextToken string received from the previous call. When there are no more records to return, `NextToken` will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

This action is throttled at 15 transactions per second (TPS).

" }, "ListSMSSandboxPhoneNumbers":{ "name":"ListSMSSandboxPhoneNumbers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSMSSandboxPhoneNumbersInput"}, "output":{ "shape":"ListSMSSandboxPhoneNumbersResult", "resultWrapper":"ListSMSSandboxPhoneNumbersResult" }, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottledException"} ], "documentation":"

Lists the calling Amazon Web Services account's current verified and pending destination phone numbers 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.

" }, "ListSubscriptions":{ "name":"ListSubscriptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSubscriptionsInput"}, "output":{ "shape":"ListSubscriptionsResponse", "resultWrapper":"ListSubscriptionsResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a `NextToken` is also returned. Use the `NextToken` parameter in a new `ListSubscriptions` call to get further results.

This action is throttled at 30 transactions per second (TPS).

" }, "ListSubscriptionsByTopic":{ "name":"ListSubscriptionsByTopic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSubscriptionsByTopicInput"}, "output":{ "shape":"ListSubscriptionsByTopicResponse", "resultWrapper":"ListSubscriptionsByTopicResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a `NextToken` is also returned. Use the `NextToken` parameter in a new `ListSubscriptionsByTopic` call to get further results.

This action is throttled at 30 transactions per second (TPS).

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{ "shape":"ListTagsForResourceResponse", "resultWrapper":"ListTagsForResourceResult" }, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"TagPolicyException"}, {"shape":"InvalidParameterException"}, {"shape":"AuthorizationErrorException"}, {"shape":"ConcurrentAccessException"} ], "documentation":"

List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.

" }, "ListTopics":{ "name":"ListTopics", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTopicsInput"}, "output":{ "shape":"ListTopicsResponse", "resultWrapper":"ListTopicsResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a `NextToken` is also returned. Use the `NextToken` parameter in a new `ListTopics` call to get further results.

This action is throttled at 30 transactions per second (TPS).

" }, "OptInPhoneNumber":{ "name":"OptInPhoneNumber", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"OptInPhoneNumberInput"}, "output":{ "shape":"OptInPhoneNumberResponse", "resultWrapper":"OptInPhoneNumberResult" }, "errors":[ {"shape":"ThrottledException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.

You can opt in a phone number only once every 30 days.

" }, "Publish":{ "name":"Publish", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PublishInput"}, "output":{ "shape":"PublishResponse", "resultWrapper":"PublishResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"EndpointDisabledException"}, {"shape":"PlatformApplicationDisabledException"}, {"shape":"AuthorizationErrorException"}, {"shape":"KMSDisabledException"}, {"shape":"KMSInvalidStateException"}, {"shape":"KMSNotFoundException"}, {"shape":"KMSOptInRequired"}, {"shape":"KMSThrottlingException"}, {"shape":"KMSAccessDeniedException"}, {"shape":"InvalidSecurityException"}, {"shape":"ValidationException"} ], "documentation":"

Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the `TargetArn`).

If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.

When a `messageId` is returned, the message is saved and Amazon SNS immediately delivers it to subscribers.

To use the `Publish` action for publishing a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the `CreatePlatformEndpoint` action.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.

You can publish messages only to topics and endpoints in the same Amazon Web Services Region.

" }, "PublishBatch":{ "name":"PublishBatch", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PublishBatchInput"}, "output":{ "shape":"PublishBatchResponse", "resultWrapper":"PublishBatchResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"EndpointDisabledException"}, {"shape":"PlatformApplicationDisabledException"}, {"shape":"AuthorizationErrorException"}, {"shape":"BatchEntryIdsNotDistinctException"}, {"shape":"BatchRequestTooLongException"}, {"shape":"EmptyBatchRequestException"}, {"shape":"InvalidBatchEntryIdException"}, {"shape":"TooManyEntriesInBatchRequestException"}, {"shape":"KMSDisabledException"}, {"shape":"KMSInvalidStateException"}, {"shape":"KMSNotFoundException"}, {"shape":"KMSOptInRequired"}, {"shape":"KMSThrottlingException"}, {"shape":"KMSAccessDeniedException"}, {"shape":"InvalidSecurityException"}, {"shape":"ValidationException"} ], "documentation":"

Publishes up to ten messages to the specified topic. This is a batch version of `Publish`. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.

The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of `200`.

The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

Some actions take lists of parameters. These lists are specified using the `param.n` notation. Values of `n` are integers starting from 1. For example, a parameter list with two elements looks like this:

&AttributeName.1=first

&AttributeName.2=second

If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.

When a `messageId` is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers.

" }, "PutDataProtectionPolicy":{ "name":"PutDataProtectionPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutDataProtectionPolicyInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidSecurityException"} ], "documentation":"

Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.

" }, "RemovePermission":{ "name":"RemovePermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemovePermissionInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Removes a statement from a topic's access control policy.

To remove the ability to change topic permissions, you must deny permissions to the `AddPermission`, `RemovePermission`, and `SetTopicAttributes` actions in your IAM policy.

" }, "SetEndpointAttributes":{ "name":"SetEndpointAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetEndpointAttributesInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "SetPlatformApplicationAttributes":{ "name":"SetPlatformApplicationAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetPlatformApplicationAttributesInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.

" }, "SetSMSAttributes":{ "name":"SetSMSAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetSMSAttributesInput"}, "output":{ "shape":"SetSMSAttributesResponse", "resultWrapper":"SetSMSAttributesResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ThrottledException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.

You can override some of these settings for a single message when you use the `Publish` action with the `MessageAttributes.entry.N` parameter. For more information, see Publishing to a mobile phone in the Amazon SNS Developer Guide.

To use this operation, you must grant the Amazon SNS service principal (`sns.amazonaws.com`) permission to perform the `s3:ListBucket` action.

" }, "SetSubscriptionAttributes":{ "name":"SetSubscriptionAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetSubscriptionAttributesInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"FilterPolicyLimitExceededException"}, {"shape":"ReplayLimitExceededException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Allows a subscription owner to set an attribute of the subscription to a new value.

" }, "SetTopicAttributes":{ "name":"SetTopicAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetTopicAttributesInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidSecurityException"} ], "documentation":"

Allows a topic owner to set an attribute of the topic to a new value.

To remove the ability to change topic permissions, you must deny permissions to the `AddPermission`, `RemovePermission`, and `SetTopicAttributes` actions in your IAM policy.

" }, "Subscribe":{ "name":"Subscribe", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SubscribeInput"}, "output":{ "shape":"SubscribeResponse", "resultWrapper":"SubscribeResult" }, "errors":[ {"shape":"SubscriptionLimitExceededException"}, {"shape":"FilterPolicyLimitExceededException"}, {"shape":"ReplayLimitExceededException"}, {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidSecurityException"} ], "documentation":"

Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must run the `ConfirmSubscription` action to confirm the subscription.

You call the `ConfirmSubscription` action with the token from the subscription response. Confirmation tokens are valid for two days.

This action is throttled at 100 transactions per second (TPS).

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "output":{ "shape":"TagResourceResponse", "resultWrapper":"TagResourceResult" }, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"TagLimitExceededException"}, {"shape":"StaleTagException"}, {"shape":"TagPolicyException"}, {"shape":"InvalidParameterException"}, {"shape":"AuthorizationErrorException"}, {"shape":"ConcurrentAccessException"} ], "documentation":"

Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

When you use topic tags, keep the following guidelines in mind:

- Adding more than 50 tags to a topic isn't recommended.

- Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.

- Tags are case-sensitive.

- A new tag with a key identical to that of an existing tag overwrites the existing tag.

- Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request.

" }, "Unsubscribe":{ "name":"Unsubscribe", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnsubscribeInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"}, {"shape":"InvalidSecurityException"} ], "documentation":"

Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services signature is required. If the `Unsubscribe` call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the `Unsubscribe` request was unintended.

Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature.

This action is throttled at 100 transactions per second (TPS).

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "output":{ "shape":"UntagResourceResponse", "resultWrapper":"UntagResourceResult" }, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"TagLimitExceededException"}, {"shape":"StaleTagException"}, {"shape":"TagPolicyException"}, {"shape":"InvalidParameterException"}, {"shape":"AuthorizationErrorException"}, {"shape":"ConcurrentAccessException"} ], "documentation":"

Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

" }, "VerifySMSSandboxPhoneNumber":{ "name":"VerifySMSSandboxPhoneNumber", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"VerifySMSSandboxPhoneNumberInput"}, "output":{ "shape":"VerifySMSSandboxPhoneNumberResult", "resultWrapper":"VerifySMSSandboxPhoneNumberResult" }, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"VerificationException"}, {"shape":"ThrottledException"} ], "documentation":"

Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.

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.

" } }, "shapes":{ "ActionsList":{ "type":"list", "member":{"shape":"action"} }, "AddPermissionInput":{ "type":"structure", "required":[ "TopicArn", "Label", "AWSAccountId", "ActionName" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic whose access control policy you wish to modify.

" }, "Label":{ "shape":"label", "documentation":"

A unique identifier for the new policy statement.

" }, "AWSAccountId":{ "shape":"DelegatesList", "documentation":"

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.

" }, "ActionName":{ "shape":"ActionsList", "documentation":"

The action you want to allow for the specified principal(s).

Valid values: Any Amazon SNS action name, for example `Publish`.

" } } }, "AmazonResourceName":{ "type":"string", "max":1011, "min":1 }, "AuthorizationErrorException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"AuthorizationError", "httpStatusCode":403, "senderFault":true }, "exception":true }, "BatchEntryIdsNotDistinctException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"BatchEntryIdsNotDistinct", "httpStatusCode":400, "senderFault":true }, "exception":true }, "BatchRequestTooLongException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"BatchRequestTooLong", "httpStatusCode":400, "senderFault":true }, "exception":true }, "BatchResultErrorEntry":{ "type":"structure", "required":[ "Id", "Code", "SenderFault" ], "members":{ "Id":{ "shape":"String", "documentation":"

The `Id` of an entry in a batch request

" }, "Code":{ "shape":"String", "documentation":"

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

" }, "Message":{ "shape":"String", "documentation":"

A message explaining why the action failed on this entry.

" }, "SenderFault":{ "shape":"boolean", "documentation":"

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

" } }, "documentation":"

Gives a detailed description of failed messages in the batch.

" }, "BatchResultErrorEntryList":{ "type":"list", "member":{"shape":"BatchResultErrorEntry"} }, "Binary":{"type":"blob"}, "CheckIfPhoneNumberIsOptedOutInput":{ "type":"structure", "required":["phoneNumber"], "members":{ "phoneNumber":{ "shape":"PhoneNumber", "documentation":"

The phone number for which you want to check the opt out status.

" } }, "documentation":"

The input for the `CheckIfPhoneNumberIsOptedOut` action.

" }, "CheckIfPhoneNumberIsOptedOutResponse":{ "type":"structure", "members":{ "isOptedOut":{ "shape":"boolean", "documentation":"

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.

" } }, "documentation":"

The response from the `CheckIfPhoneNumberIsOptedOut` action.

" }, "ConcurrentAccessException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"ConcurrentAccess", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ConfirmSubscriptionInput":{ "type":"structure", "required":[ "TopicArn", "Token" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic for which you wish to confirm a subscription.

" }, "Token":{ "shape":"token", "documentation":"

Short-lived token sent to an endpoint during the `Subscribe` action.

" }, "AuthenticateOnUnsubscribe":{ "shape":"authenticateOnUnsubscribe", "documentation":"

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.

" } }, "documentation":"

Input for ConfirmSubscription action.

" }, "ConfirmSubscriptionResponse":{ "type":"structure", "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The ARN of the created subscription.

" } }, "documentation":"

Response for ConfirmSubscriptions action.

" }, "CreateEndpointResponse":{ "type":"structure", "members":{ "EndpointArn":{ "shape":"String", "documentation":"

EndpointArn returned from CreateEndpoint action.

" } }, "documentation":"

Response from CreateEndpoint action.

" }, "CreatePlatformApplicationInput":{ "type":"structure", "required":[ "Name", "Platform", "Attributes" ], "members":{ "Name":{ "shape":"String", "documentation":"

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.

" }, "Platform":{ "shape":"String", "documentation":"

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

For a list of attributes, see SetPlatformApplicationAttributes.

" } }, "documentation":"

Input for CreatePlatformApplication action.

" }, "CreatePlatformApplicationResponse":{ "type":"structure", "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn is returned.

" } }, "documentation":"

Response from CreatePlatformApplication action.

" }, "CreatePlatformEndpointInput":{ "type":"structure", "required":[ "PlatformApplicationArn", "Token" ], "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

" }, "Token":{ "shape":"String", "documentation":"

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.

" }, "CustomUserData":{ "shape":"String", "documentation":"

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.

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

For a list of attributes, see SetEndpointAttributes.

" } }, "documentation":"

Input for CreatePlatformEndpoint action.

" }, "CreateSMSSandboxPhoneNumberInput":{ "type":"structure", "required":["PhoneNumber"], "members":{ "PhoneNumber":{ "shape":"PhoneNumberString", "documentation":"

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.

" }, "LanguageCode":{ "shape":"LanguageCodeString", "documentation":"

The language to use for sending the OTP. The default value is `en-US`.

" } } }, "CreateSMSSandboxPhoneNumberResult":{ "type":"structure", "members":{ } }, "CreateTopicInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"topicName", "documentation":"

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.

" }, "Attributes":{ "shape":"TopicAttributesMap", "documentation":"

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the `CreateTopic` action uses:

- `DeliveryPolicy` – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

- `DisplayName` – The display name to use for a topic with SMS subscriptions.

- `FifoTopic` – Set to true to create a FIFO topic.

- `Policy` – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

- `SignatureVersion` – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, `SignatureVersion` is set to `1`.

- `TracingConfig` – Tracing mode of an Amazon SNS topic. By default `TracingConfig` is set to `PassThrough`, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to `Active`, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.

The following attribute applies only to server-side encryption:

- `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.

The following attributes apply only to FIFO topics:

- `ArchivePolicy` – Adds or updates an inline policy document to archive messages stored in the specified Amazon SNS topic.

- `BeginningArchiveTime` – The earliest starting point at which a message in the topic’s archive can be replayed from. This point in time is based on the configured message retention period set by the topic’s message archiving policy.

- `ContentBasedDeduplication` – Enables content-based deduplication for FIFO topics.

  - By default, `ContentBasedDeduplication` is set to `false`. If you create a FIFO topic and this attribute is `false`, you must specify a value for the `MessageDeduplicationId` parameter for the Publish action.

  - When you set `ContentBasedDeduplication` to `true`, Amazon SNS uses a SHA-256 hash to generate the `MessageDeduplicationId` using the body of the message (but not the attributes of the message).

    (Optional) To override the generated value, you can specify a value for the `MessageDeduplicationId` parameter for the `Publish` action.

" }, "Tags":{ "shape":"TagList", "documentation":"

The list of tags to add to a new topic.

To be able to tag a topic on creation, you must have the `sns:CreateTopic` and `sns:TagResource` permissions.

" }, "DataProtectionPolicy":{ "shape":"attributeValue", "documentation":"

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.

" } }, "documentation":"

Input for CreateTopic action.

" }, "CreateTopicResponse":{ "type":"structure", "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The Amazon Resource Name (ARN) assigned to the created topic.

" } }, "documentation":"

Response from CreateTopic action.

" }, "DelegatesList":{ "type":"list", "member":{"shape":"delegate"} }, "DeleteEndpointInput":{ "type":"structure", "required":["EndpointArn"], "members":{ "EndpointArn":{ "shape":"String", "documentation":"

EndpointArn of endpoint to delete.

" } }, "documentation":"

Input for DeleteEndpoint action.

" }, "DeletePlatformApplicationInput":{ "type":"structure", "required":["PlatformApplicationArn"], "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn of platform application object to delete.

" } }, "documentation":"

Input for DeletePlatformApplication action.

" }, "DeleteSMSSandboxPhoneNumberInput":{ "type":"structure", "required":["PhoneNumber"], "members":{ "PhoneNumber":{ "shape":"PhoneNumberString", "documentation":"

The destination phone number to delete.

" } } }, "DeleteSMSSandboxPhoneNumberResult":{ "type":"structure", "members":{ } }, "DeleteTopicInput":{ "type":"structure", "required":["TopicArn"], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic you want to delete.

" } } }, "EmptyBatchRequestException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

The batch request doesn't contain any entries.

", "error":{ "code":"EmptyBatchRequest", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Endpoint":{ "type":"structure", "members":{ "EndpointArn":{ "shape":"String", "documentation":"

The `EndpointArn` for mobile app and device.

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

Attributes for endpoint.

" } }, "documentation":"

The endpoint for mobile app and device.

" }, "EndpointDisabledException":{ "type":"structure", "members":{ "message":{ "shape":"string", "documentation":"

Message for endpoint disabled.

" } }, "documentation":"

Exception error indicating endpoint disabled.

", "error":{ "code":"EndpointDisabled", "httpStatusCode":400, "senderFault":true }, "exception":true }, "FilterPolicyLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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.

", "error":{ "code":"FilterPolicyLimitExceeded", "httpStatusCode":403, "senderFault":true }, "exception":true }, "GetDataProtectionPolicyInput":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"topicARN", "documentation":"

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.

" } } }, "GetDataProtectionPolicyResponse":{ "type":"structure", "members":{ "DataProtectionPolicy":{ "shape":"attributeValue", "documentation":"

Retrieves the `DataProtectionPolicy` in JSON string format.

" } } }, "GetEndpointAttributesInput":{ "type":"structure", "required":["EndpointArn"], "members":{ "EndpointArn":{ "shape":"String", "documentation":"

EndpointArn for GetEndpointAttributes input.

" } }, "documentation":"

Input for GetEndpointAttributes action.

" }, "GetEndpointAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"MapStringToString", "documentation":"

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.

" } }, "documentation":"

Response from GetEndpointAttributes of the EndpointArn.

" }, "GetPlatformApplicationAttributesInput":{ "type":"structure", "required":["PlatformApplicationArn"], "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn for GetPlatformApplicationAttributesInput.

" } }, "documentation":"

Input for GetPlatformApplicationAttributes action.

" }, "GetPlatformApplicationAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"MapStringToString", "documentation":"

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.

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

" } }, "documentation":"

Response for GetPlatformApplicationAttributes action.

" }, "GetSMSAttributesInput":{ "type":"structure", "members":{ "attributes":{ "shape":"ListString", "documentation":"

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.

" } }, "documentation":"

The input for the `GetSMSAttributes` request.

" }, "GetSMSAttributesResponse":{ "type":"structure", "members":{ "attributes":{ "shape":"MapStringToString", "documentation":"

The SMS attribute names and their values.

" } }, "documentation":"

The response from the `GetSMSAttributes` request.

" }, "GetSMSSandboxAccountStatusInput":{ "type":"structure", "members":{ } }, "GetSMSSandboxAccountStatusResult":{ "type":"structure", "required":["IsInSandbox"], "members":{ "IsInSandbox":{ "shape":"boolean", "documentation":"

Indicates whether the calling Amazon Web Services account is in the SMS sandbox.

" } } }, "GetSubscriptionAttributesInput":{ "type":"structure", "required":["SubscriptionArn"], "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The ARN of the subscription whose properties you want to get.

" } }, "documentation":"

Input for GetSubscriptionAttributes.

" }, "GetSubscriptionAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"SubscriptionAttributesMap", "documentation":"

A map of the subscription's attributes. Attributes in this map include the following:

- `ConfirmationWasAuthenticated` – `true` if the subscription confirmation request was authenticated.

- `DeliveryPolicy` – The JSON serialization of the subscription's delivery policy.

- `EffectiveDeliveryPolicy` – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

- `FilterPolicy` – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

- `FilterPolicyScope` – This attribute lets you choose the filtering scope by using one of the following string value types:

  - `MessageAttributes` (default) – The filter is applied on the message attributes.

  - `MessageBody` – The filter is applied on the message body.

- `Owner` – The Amazon Web Services account ID of the subscription's owner.

- `PendingConfirmation` – `true` if the subscription hasn't been confirmed. To confirm a pending subscription, call the `ConfirmSubscription` action with a confirmation token.

- `RawMessageDelivery` – `true` if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

- `RedrivePolicy` – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

- `SubscriptionArn` – The subscription's ARN.

- `TopicArn` – The topic ARN that the subscription is associated with.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

- `SubscriptionRoleArn` – The ARN of the IAM role that has the following:

  - Permission to write to the Kinesis Data Firehose delivery stream

  - Amazon SNS listed as a trusted entity

  Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

" } }, "documentation":"

Response for GetSubscriptionAttributes action.

" }, "GetTopicAttributesInput":{ "type":"structure", "required":["TopicArn"], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic whose properties you want to get.

" } }, "documentation":"

Input for GetTopicAttributes action.

" }, "GetTopicAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"TopicAttributesMap", "documentation":"

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.

  - By default, `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:

- `FifoTopic` – When this is set to `true`, a FIFO topic is created.

- `ContentBasedDeduplication` – Enables content-based deduplication for FIFO topics.

  - By default, `ContentBasedDeduplication` is set to `false`. If you create a FIFO topic and this attribute is `false`, you must specify a value for the `MessageDeduplicationId` parameter for the Publish action.

  - When you set `ContentBasedDeduplication` to `true`, Amazon SNS uses a SHA-256 hash to generate the `MessageDeduplicationId` using the body of the message (but not the attributes of the message).

    (Optional) To override the generated value, you can specify a value for the `MessageDeduplicationId` parameter for the `Publish` action.

" } }, "documentation":"

Response for GetTopicAttributes action.

" }, "InternalErrorException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

Indicates an internal service error.

", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true }, "InvalidBatchEntryIdException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"InvalidBatchEntryId", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidParameterException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidParameterValueException":{ "type":"structure", "members":{ "message":{ "shape":"string", "documentation":"

The parameter of an entry in a request doesn't abide by the specification.

" } }, "documentation":"

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

", "error":{ "code":"ParameterValueInvalid", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidSecurityException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"InvalidSecurity", "httpStatusCode":403, "senderFault":true }, "exception":true }, "InvalidStateException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

Indicates that the specified state is not a valid state for an event source.

", "error":{ "code":"InvalidState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Iso2CountryCode":{ "type":"string", "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. For example, GB or US.", "max":2, "pattern":"^[A-Za-z]{2}$" }, "KMSAccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"KMSAccessDenied", "httpStatusCode":400, "senderFault":true }, "exception":true }, "KMSDisabledException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

The request was rejected because the specified Amazon Web Services KMS key isn't enabled.

", "error":{ "code":"KMSDisabled", "httpStatusCode":400, "senderFault":true }, "exception":true }, "KMSInvalidStateException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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.

", "error":{ "code":"KMSInvalidState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "KMSNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"KMSNotFound", "httpStatusCode":400, "senderFault":true }, "exception":true }, "KMSOptInRequired":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"KMSOptInRequired", "httpStatusCode":403, "senderFault":true }, "exception":true }, "KMSThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"KMSThrottling", "httpStatusCode":400, "senderFault":true }, "exception":true }, "LanguageCodeString":{ "type":"string", "documentation":"Supported language code for sending OTP message", "enum":[ "en-US", "en-GB", "es-419", "es-ES", "de-DE", "fr-CA", "fr-FR", "it-IT", "ja-JP", "pt-BR", "kr-KR", "zh-CN", "zh-TW" ] }, "ListEndpointsByPlatformApplicationInput":{ "type":"structure", "required":["PlatformApplicationArn"], "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

" }, "NextToken":{ "shape":"String", "documentation":"

NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

" } }, "documentation":"

Input for ListEndpointsByPlatformApplication action.

" }, "ListEndpointsByPlatformApplicationResponse":{ "type":"structure", "members":{ "Endpoints":{ "shape":"ListOfEndpoints", "documentation":"

Endpoints returned for ListEndpointsByPlatformApplication action.

" }, "NextToken":{ "shape":"String", "documentation":"

NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.

" } }, "documentation":"

Response for ListEndpointsByPlatformApplication action.

" }, "ListOfEndpoints":{ "type":"list", "member":{"shape":"Endpoint"} }, "ListOfPlatformApplications":{ "type":"list", "member":{"shape":"PlatformApplication"} }, "ListOriginationNumbersRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"nextToken", "documentation":"

Token that the previous `ListOriginationNumbers` request returns.

" }, "MaxResults":{ "shape":"MaxItemsListOriginationNumbers", "documentation":"

The maximum number of origination numbers to return.

" } } }, "ListOriginationNumbersResult":{ "type":"structure", "members":{ "NextToken":{ "shape":"nextToken", "documentation":"

A `NextToken` string is returned when you call the `ListOriginationNumbers` operation if additional pages of records are available.

" }, "PhoneNumbers":{ "shape":"PhoneNumberInformationList", "documentation":"

A list of the calling account's verified and pending origination numbers.

" } } }, "ListPhoneNumbersOptedOutInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"string", "documentation":"

A `NextToken` string is used when you call the `ListPhoneNumbersOptedOut` action to retrieve additional records that are available after the first page of results.

" } }, "documentation":"

The input for the `ListPhoneNumbersOptedOut` action.

" }, "ListPhoneNumbersOptedOutResponse":{ "type":"structure", "members":{ "phoneNumbers":{ "shape":"PhoneNumberList", "documentation":"

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.

" }, "nextToken":{ "shape":"string", "documentation":"

A `NextToken` string is returned when you call the `ListPhoneNumbersOptedOut` action if additional records are available after the first page of results.

" } }, "documentation":"

The response from the `ListPhoneNumbersOptedOut` action.

" }, "ListPlatformApplicationsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.

" } }, "documentation":"

Input for ListPlatformApplications action.

" }, "ListPlatformApplicationsResponse":{ "type":"structure", "members":{ "PlatformApplications":{ "shape":"ListOfPlatformApplications", "documentation":"

Platform applications returned when calling ListPlatformApplications action.

" }, "NextToken":{ "shape":"String", "documentation":"

NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.

" } }, "documentation":"

Response for ListPlatformApplications action.

" }, "ListSMSSandboxPhoneNumbersInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"nextToken", "documentation":"

Token that the previous `ListSMSSandboxPhoneNumbersInput` request returns.

" }, "MaxResults":{ "shape":"MaxItems", "documentation":"

The maximum number of phone numbers to return.

" } } }, "ListSMSSandboxPhoneNumbersResult":{ "type":"structure", "required":["PhoneNumbers"], "members":{ "PhoneNumbers":{ "shape":"SMSSandboxPhoneNumberList", "documentation":"

A list of the calling account's pending and verified phone numbers.

" }, "NextToken":{ "shape":"string", "documentation":"

A `NextToken` string is returned when you call the `ListSMSSandboxPhoneNumbersInput` operation if additional pages of records are available.

" } } }, "ListString":{ "type":"list", "member":{"shape":"String"} }, "ListSubscriptionsByTopicInput":{ "type":"structure", "required":["TopicArn"], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic for which you wish to find subscriptions.

" }, "NextToken":{ "shape":"nextToken", "documentation":"

Token returned by the previous `ListSubscriptionsByTopic` request.

" } }, "documentation":"

Input for ListSubscriptionsByTopic action.

" }, "ListSubscriptionsByTopicResponse":{ "type":"structure", "members":{ "Subscriptions":{ "shape":"SubscriptionsList", "documentation":"

A list of subscriptions.

" }, "NextToken":{ "shape":"nextToken", "documentation":"

Token to pass along to the next `ListSubscriptionsByTopic` request. This element is returned if there are more subscriptions to retrieve.

" } }, "documentation":"

Response for ListSubscriptionsByTopic action.

" }, "ListSubscriptionsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"nextToken", "documentation":"

Token returned by the previous `ListSubscriptions` request.

" } }, "documentation":"

Input for ListSubscriptions action.

" }, "ListSubscriptionsResponse":{ "type":"structure", "members":{ "Subscriptions":{ "shape":"SubscriptionsList", "documentation":"

A list of subscriptions.

" }, "NextToken":{ "shape":"nextToken", "documentation":"

Token to pass along to the next `ListSubscriptions` request. This element is returned if there are more subscriptions to retrieve.

" } }, "documentation":"

Response for ListSubscriptions action

" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the topic for which to list tags.

" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"

The tags associated with the specified topic.

" } } }, "ListTopicsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"nextToken", "documentation":"

Token returned by the previous `ListTopics` request.

" } } }, "ListTopicsResponse":{ "type":"structure", "members":{ "Topics":{ "shape":"TopicsList", "documentation":"

A list of topic ARNs.

" }, "NextToken":{ "shape":"nextToken", "documentation":"

Token to pass along to the next `ListTopics` request. This element is returned if there are additional topics to retrieve.

" } }, "documentation":"

Response for ListTopics action.

" }, "MapStringToString":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "MaxItems":{ "type":"integer", "max":100, "min":1 }, "MaxItemsListOriginationNumbers":{ "type":"integer", "max":30, "min":1 }, "MessageAttributeMap":{ "type":"map", "key":{ "shape":"String", "locationName":"Name" }, "value":{ "shape":"MessageAttributeValue", "locationName":"Value" } }, "MessageAttributeValue":{ "type":"structure", "required":["DataType"], "members":{ "DataType":{ "shape":"String", "documentation":"

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

" }, "StringValue":{ "shape":"String", "documentation":"

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

" }, "BinaryValue":{ "shape":"Binary", "documentation":"

Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

" } }, "documentation":"

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.

" }, "NotFoundException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

Indicates that the requested resource does not exist.

", "error":{ "code":"NotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "NumberCapability":{ "type":"string", "documentation":"Enum listing out all supported number capabilities.", "enum":[ "SMS", "MMS", "VOICE" ] }, "NumberCapabilityList":{ "type":"list", "member":{"shape":"NumberCapability"}, "documentation":"List of number capability (SMS,MMS,Voice)." }, "OTPCode":{ "type":"string", "documentation":"String of Origination/Destination address including phone numbers and email addresses", "max":8, "min":5, "pattern":"^[0-9]+$" }, "OptInPhoneNumberInput":{ "type":"structure", "required":["phoneNumber"], "members":{ "phoneNumber":{ "shape":"PhoneNumber", "documentation":"

The phone number to opt in. Use E.164 format.

" } }, "documentation":"

Input for the OptInPhoneNumber action.

" }, "OptInPhoneNumberResponse":{ "type":"structure", "members":{ }, "documentation":"

The response for the OptInPhoneNumber action.

" }, "OptedOutException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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.

", "error":{ "code":"OptedOut", "httpStatusCode":400, "senderFault":true }, "exception":true }, "PhoneNumber":{"type":"string"}, "PhoneNumberInformation":{ "type":"structure", "members":{ "CreatedAt":{ "shape":"Timestamp", "documentation":"

The date and time when the phone number was created.

" }, "PhoneNumber":{ "shape":"String", "documentation":"

The phone number.

" }, "Status":{ "shape":"String", "documentation":"

The status of the phone number.

" }, "Iso2CountryCode":{ "shape":"Iso2CountryCode", "documentation":"

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

" }, "RouteType":{ "shape":"RouteType", "documentation":"

The list of supported routes.

" }, "NumberCapabilities":{ "shape":"NumberCapabilityList", "documentation":"

The capabilities of each phone number.

" } }, "documentation":"

A list of phone numbers and their metadata.

" }, "PhoneNumberInformationList":{ "type":"list", "member":{"shape":"PhoneNumberInformation"}, "documentation":"List of customer owned phone numbers." }, "PhoneNumberList":{ "type":"list", "member":{"shape":"PhoneNumber"} }, "PhoneNumberString":{ "type":"string", "max":20, "pattern":"^(\\+[0-9]{8,}|[0-9]{0,9})$" }, "PlatformApplication":{ "type":"structure", "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn for platform application object.

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

Attributes for platform application object.

" } }, "documentation":"

Platform application object.

" }, "PlatformApplicationDisabledException":{ "type":"structure", "members":{ "message":{ "shape":"string", "documentation":"

Message for platform application disabled.

" } }, "documentation":"

Exception error indicating platform application disabled.

", "error":{ "code":"PlatformApplicationDisabled", "httpStatusCode":400, "senderFault":true }, "exception":true }, "PublishBatchInput":{ "type":"structure", "required":[ "TopicArn", "PublishBatchRequestEntries" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The Amazon resource name (ARN) of the topic you want to batch publish to.

" }, "PublishBatchRequestEntries":{ "shape":"PublishBatchRequestEntryList", "documentation":"

A list of `PublishBatch` request entries to be sent to the SNS topic.

" } } }, "PublishBatchRequestEntry":{ "type":"structure", "required":[ "Id", "Message" ], "members":{ "Id":{ "shape":"String", "documentation":"

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

" }, "Message":{ "shape":"message", "documentation":"

The body of the message.

" }, "Subject":{ "shape":"subject", "documentation":"

The subject of the batch message.

" }, "MessageStructure":{ "shape":"messageStructure", "documentation":"

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

" }, "MessageAttributes":{ "shape":"MessageAttributeMap", "documentation":"

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

" }, "MessageDeduplicationId":{ "shape":"String", "documentation":"

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 `(!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)`.

" }, "MessageGroupId":{ "shape":"String", "documentation":"

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.

" } }, "documentation":"

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

" }, "PublishBatchRequestEntryList":{ "type":"list", "member":{"shape":"PublishBatchRequestEntry"} }, "PublishBatchResponse":{ "type":"structure", "members":{ "Successful":{ "shape":"PublishBatchResultEntryList", "documentation":"

A list of successful `PublishBatch` responses.

" }, "Failed":{ "shape":"BatchResultErrorEntryList", "documentation":"

A list of failed `PublishBatch` responses.

" } } }, "PublishBatchResultEntry":{ "type":"structure", "members":{ "Id":{ "shape":"String", "documentation":"

The `Id` of an entry in a batch request.

" }, "MessageId":{ "shape":"messageId", "documentation":"

An identifier for the message.

" }, "SequenceNumber":{ "shape":"String", "documentation":"

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

" } }, "documentation":"

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

" }, "PublishBatchResultEntryList":{ "type":"list", "member":{"shape":"PublishBatchResultEntry"} }, "PublishInput":{ "type":"structure", "required":["Message"], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

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.

" }, "TargetArn":{ "shape":"String", "documentation":"

If you don't specify a value for the `TargetArn` parameter, you must specify a value for the `PhoneNumber` or `TopicArn` parameters.

" }, "PhoneNumber":{ "shape":"String", "documentation":"

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.

" }, "Message":{ "shape":"message", "documentation":"

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:

- With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).

- 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:

- Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.

- The values will be parsed (unescaped) before they are used in outgoing messages.

- Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).

- Values have a minimum length of 0 (the empty string, \"\", is allowed).

- Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).

- Non-string values will cause the key to be ignored.

- Keys that do not correspond to supported transport protocols are ignored.

- Duplicate keys are not allowed.

- Failure to parse or validate any key or value in the message will cause the `Publish` call to return an error (no partial delivery).

" }, "Subject":{ "shape":"subject", "documentation":"

Optional parameter to be used as the \"Subject\" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

" }, "MessageStructure":{ "shape":"messageStructure", "documentation":"

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\").

Valid value: `json`

" }, "MessageAttributes":{ "shape":"MessageAttributeMap", "documentation":"

Message attributes for Publish action.

" }, "MessageDeduplicationId":{ "shape":"String", "documentation":"

This parameter applies only to FIFO (first-in-first-out) topics. The `MessageDeduplicationId` can contain up to 128 alphanumeric characters `(a-z, A-Z, 0-9)` and punctuation `(!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)`.

Every message must have a unique `MessageDeduplicationId`, which is a token used for deduplication of sent messages. If a message with a particular `MessageDeduplicationId` is sent successfully, any message sent with the same `MessageDeduplicationId` during the 5-minute deduplication interval is treated as a duplicate.

If the topic has `ContentBasedDeduplication` set, the system generates a `MessageDeduplicationId` based on the contents of the message. Your `MessageDeduplicationId` overrides the generated one.

" }, "MessageGroupId":{ "shape":"String", "documentation":"

This parameter applies only to FIFO (first-in-first-out) topics. The `MessageGroupId` can contain up to 128 alphanumeric characters `(a-z, A-Z, 0-9)` and punctuation `(!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)`.

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

" } }, "documentation":"

Input for Publish action.

" }, "PublishResponse":{ "type":"structure", "members":{ "MessageId":{ "shape":"messageId", "documentation":"

Unique identifier assigned to the published message.

Length Constraint: Maximum 100 characters

" }, "SequenceNumber":{ "shape":"String", "documentation":"

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

" } }, "documentation":"

Response for Publish action.

" }, "PutDataProtectionPolicyInput":{ "type":"structure", "required":[ "ResourceArn", "DataProtectionPolicy" ], "members":{ "ResourceArn":{ "shape":"topicARN", "documentation":"

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.

" }, "DataProtectionPolicy":{ "shape":"attributeValue", "documentation":"

The JSON serialization of the topic's `DataProtectionPolicy`.

The `DataProtectionPolicy` must be in JSON string format.

Length Constraints: Maximum length of 30,720.

" } } }, "RemovePermissionInput":{ "type":"structure", "required":[ "TopicArn", "Label" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic whose access control policy you wish to modify.

" }, "Label":{ "shape":"label", "documentation":"

The unique label of the statement you want to remove.

" } }, "documentation":"

Input for RemovePermission action.

" }, "ReplayLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

Indicates that the request parameter has exceeded the maximum number of concurrent message replays.

", "error":{ "code":"ReplayLimitExceeded", "httpStatusCode":403, "senderFault":true }, "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "RouteType":{ "type":"string", "documentation":"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":[ "Transactional", "Promotional", "Premium" ] }, "SMSSandboxPhoneNumber":{ "type":"structure", "members":{ "PhoneNumber":{ "shape":"PhoneNumberString", "documentation":"

The destination phone number.

" }, "Status":{ "shape":"SMSSandboxPhoneNumberVerificationStatus", "documentation":"

The destination phone number's verification status.

" } }, "documentation":"

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.

" }, "SMSSandboxPhoneNumberList":{ "type":"list", "member":{"shape":"SMSSandboxPhoneNumber"} }, "SMSSandboxPhoneNumberVerificationStatus":{ "type":"string", "documentation":"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.", "enum":[ "Pending", "Verified" ] }, "SetEndpointAttributesInput":{ "type":"structure", "required":[ "EndpointArn", "Attributes" ], "members":{ "EndpointArn":{ "shape":"String", "documentation":"

EndpointArn used for SetEndpointAttributes action.

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

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.

" } }, "documentation":"

Input for SetEndpointAttributes action.

" }, "SetPlatformApplicationAttributesInput":{ "type":"structure", "required":[ "PlatformApplicationArn", "Attributes" ], "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn for SetPlatformApplicationAttributes action.

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

A map of the platform application attributes. Attributes in this map include the following:

- `PlatformCredential` – The credential received from the notification service.

  - For ADM, `PlatformCredential`is client secret.

  - For Apple Services using certificate credentials, `PlatformCredential` is private key.

  - For Apple Services using token credentials, `PlatformCredential` is signing key.

  - For GCM (Firebase Cloud Messaging), `PlatformCredential` is API key.

- `PlatformPrincipal` – The principal received from the notification service.

  - For ADM, `PlatformPrincipal`is client id.

  - For Apple Services using certificate credentials, `PlatformPrincipal` is SSL certificate.

  - For Apple Services using token credentials, `PlatformPrincipal` is signing key ID.

  - For GCM (Firebase Cloud Messaging), there is no `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.

" } }, "documentation":"

Input for SetPlatformApplicationAttributes action.

" }, "SetSMSAttributesInput":{ "type":"structure", "required":["attributes"], "members":{ "attributes":{ "shape":"MapStringToString", "documentation":"

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:

- Time that the message was published (in UTC)

- Message ID

- Destination phone number

- Message type

- Delivery status

- Message price (in USD)

- Part number (a message is split into multiple parts if it is too long for a single message)

- Total number of parts

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.

" } }, "documentation":"

The input for the SetSMSAttributes action.

" }, "SetSMSAttributesResponse":{ "type":"structure", "members":{ }, "documentation":"

The response for the SetSMSAttributes action.

" }, "SetSubscriptionAttributesInput":{ "type":"structure", "required":[ "SubscriptionArn", "AttributeName" ], "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The ARN of the subscription to modify.

" }, "AttributeName":{ "shape":"attributeName", "documentation":"

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that this action uses:

- `DeliveryPolicy` – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

- `FilterPolicy` – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

- `FilterPolicyScope` – This attribute lets you choose the filtering scope by using one of the following string value types:

  - `MessageAttributes` (default) – The filter is applied on the message attributes.

  - `MessageBody` – The filter is applied on the message body.

- `RawMessageDelivery` – When set to `true`, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

- `RedrivePolicy` – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

- `SubscriptionRoleArn` – The ARN of the IAM role that has the following:

  - Permission to write to the Kinesis Data Firehose delivery stream

  - Amazon SNS listed as a trusted entity

  Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

" }, "AttributeValue":{ "shape":"attributeValue", "documentation":"

The new value for the attribute in JSON format.

" } }, "documentation":"

Input for SetSubscriptionAttributes action.

" }, "SetTopicAttributesInput":{ "type":"structure", "required":[ "TopicArn", "AttributeName" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic to modify.

" }, "AttributeName":{ "shape":"attributeName", "documentation":"

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the `SetTopicAttributes` action uses:

- `ApplicationSuccessFeedbackRoleArn` – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.

- `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 Kinesis Data Firehose

  - `FirehoseSuccessFeedbackRoleArn` – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.

  - `FirehoseSuccessFeedbackSampleRate` – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.

  - `FirehoseFailureFeedbackRoleArn` – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis 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 Amazon Web Services application endpoint.

  - `ApplicationSuccessFeedbackSampleRate` – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.

  - `ApplicationFailureFeedbackRoleArn` – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services 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 <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>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:

- `ContentBasedDeduplication` – Enables content-based deduplication for FIFO topics.

  - By default, `ContentBasedDeduplication` is set to `false`. If you create a FIFO topic and this attribute is `false`, you must specify a value for the `MessageDeduplicationId` parameter for the Publish action.

  - When you set `ContentBasedDeduplication` to `true`, Amazon SNS uses a SHA-256 hash to generate the `MessageDeduplicationId` using the body of the message (but not the attributes of the message).

    (Optional) To override the generated value, you can specify a value for the `MessageDeduplicationId` parameter for the `Publish` action.

" }, "AttributeValue":{ "shape":"attributeValue", "documentation":"

The new value for the attribute.

" } }, "documentation":"

Input for SetTopicAttributes action.

" }, "StaleTagException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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.

", "error":{ "code":"StaleTag", "httpStatusCode":400, "senderFault":true }, "exception":true }, "String":{"type":"string"}, "SubscribeInput":{ "type":"structure", "required":[ "TopicArn", "Protocol" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic you want to subscribe to.

" }, "Protocol":{ "shape":"protocol", "documentation":"

The protocol that you want to use. Supported protocols include:

- `http` – delivery of JSON-encoded message via HTTP POST

- `https` – delivery of JSON-encoded message via HTTPS POST

- `email` – delivery of message via SMTP

- `email-json` – delivery of JSON-encoded message via SMTP

- `sms` – delivery of message via SMS

- `sqs` – delivery of JSON-encoded message to an Amazon SQS queue

- `application` – delivery of JSON-encoded message to an EndpointArn for a mobile app and device

- `lambda` – delivery of JSON-encoded message to an Lambda function

- `firehose` – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

" }, "Endpoint":{ "shape":"endpoint", "documentation":"

The endpoint that you want to receive notifications. Endpoints vary by protocol:

- For the `http` protocol, the (public) endpoint is a URL beginning with `http://`.

- For the `https` protocol, the (public) endpoint is a URL beginning with `https://`.

- For the `email` protocol, the endpoint is an email address.

- For the `email-json` protocol, the endpoint is an email address.

- For the `sms` protocol, the endpoint is a phone number of an SMS-enabled device.

- For the `sqs` protocol, the endpoint is the ARN of an Amazon SQS queue.

- For the `application` protocol, the endpoint is the EndpointArn of a mobile app and device.

- For the `lambda` protocol, the endpoint is the ARN of an Lambda function.

- For the `firehose` protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

" }, "Attributes":{ "shape":"SubscriptionAttributesMap", "documentation":"

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the `Subscribe` action uses:

- `DeliveryPolicy` – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

- `FilterPolicy` – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

- `FilterPolicyScope` – This attribute lets you choose the filtering scope by using one of the following string value types:

  - `MessageAttributes` (default) – The filter is applied on the message attributes.

  - `MessageBody` – The filter is applied on the message body.

- `RawMessageDelivery` – When set to `true`, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

- `RedrivePolicy` – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

- `SubscriptionRoleArn` – The ARN of the IAM role that has the following:

  - Permission to write to the Kinesis Data Firehose delivery stream

  - Amazon SNS listed as a trusted entity

  Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

The following attributes apply only to FIFO topics:

- `ReplayPolicy` – Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic.

- `ReplayStatus` – Retrieves the status of the subscription message replay, which can be one of the following:

  - `Completed` – The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in the `ReplayPolicy` then the subscription will no longer receive newly published messages.

  - `In progress` – The replay is currently replaying the selected messages.

  - `Failed` – The replay was unable to complete.

  - `Pending` – The default state while the replay initiates.

" }, "ReturnSubscriptionArn":{ "shape":"boolean", "documentation":"

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

" } }, "documentation":"

Input for Subscribe action.

" }, "SubscribeResponse":{ "type":"structure", "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

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.

" } }, "documentation":"

Response for Subscribe action.

" }, "Subscription":{ "type":"structure", "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The subscription's ARN.

" }, "Owner":{ "shape":"account", "documentation":"

The subscription's owner.

" }, "Protocol":{ "shape":"protocol", "documentation":"

The subscription's protocol.

" }, "Endpoint":{ "shape":"endpoint", "documentation":"

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

" }, "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the subscription's topic.

" } }, "documentation":"

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

" }, "SubscriptionAttributesMap":{ "type":"map", "key":{"shape":"attributeName"}, "value":{"shape":"attributeValue"} }, "SubscriptionLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"SubscriptionLimitExceeded", "httpStatusCode":403, "senderFault":true }, "exception":true }, "SubscriptionsList":{ "type":"list", "member":{"shape":"Subscription"} }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The required key portion of the tag.

" }, "Value":{ "shape":"TagValue", "documentation":"

The optional value portion of the tag.

" } }, "documentation":"

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

" }, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"} }, "TagLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"TagLimitExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TagPolicyException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"TagPolicy", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the topic to which to add tags.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be added to the specified topic. A tag consists of a required key and an optional value.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0 }, "ThrottledException":{ "type":"structure", "members":{ "message":{ "shape":"string", "documentation":"

Throttled request.

" } }, "documentation":"

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

", "error":{ "code":"Throttled", "httpStatusCode":429, "senderFault":true }, "exception":true }, "Timestamp":{"type":"timestamp"}, "TooManyEntriesInBatchRequestException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

The batch request contains more entries than permissible.

", "error":{ "code":"TooManyEntriesInBatchRequest", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Topic":{ "type":"structure", "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The topic's ARN.

" } }, "documentation":"

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

" }, "TopicAttributesMap":{ "type":"map", "key":{"shape":"attributeName"}, "value":{"shape":"attributeValue"} }, "TopicLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"TopicLimitExceeded", "httpStatusCode":403, "senderFault":true }, "exception":true }, "TopicsList":{ "type":"list", "member":{"shape":"Topic"} }, "UnsubscribeInput":{ "type":"structure", "required":["SubscriptionArn"], "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The ARN of the subscription to be deleted.

" } }, "documentation":"

Input for Unsubscribe action.

" }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the topic from which to remove tags.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

The list of tag keys to remove from the specified topic.

" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UserErrorException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"UserError", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"string"} }, "documentation":"

Indicates that a parameter in the request is invalid.

", "error":{ "code":"ValidationException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "VerificationException":{ "type":"structure", "required":[ "Message", "Status" ], "members":{ "Message":{"shape":"string"}, "Status":{ "shape":"string", "documentation":"

The status of the verification error.

" } }, "documentation":"

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

", "exception":true }, "VerifySMSSandboxPhoneNumberInput":{ "type":"structure", "required":[ "PhoneNumber", "OneTimePassword" ], "members":{ "PhoneNumber":{ "shape":"PhoneNumberString", "documentation":"

The destination phone number to verify.

" }, "OneTimePassword":{ "shape":"OTPCode", "documentation":"

The OTP sent to the destination number from the `CreateSMSSandBoxPhoneNumber` call.

" } } }, "VerifySMSSandboxPhoneNumberResult":{ "type":"structure", "members":{ }, "documentation":"

The destination phone number's verification status.

" }, "account":{"type":"string"}, "action":{"type":"string"}, "attributeName":{"type":"string"}, "attributeValue":{"type":"string"}, "authenticateOnUnsubscribe":{"type":"string"}, "boolean":{"type":"boolean"}, "delegate":{"type":"string"}, "endpoint":{"type":"string"}, "label":{"type":"string"}, "message":{"type":"string"}, "messageId":{"type":"string"}, "messageStructure":{"type":"string"}, "nextToken":{"type":"string"}, "protocol":{"type":"string"}, "string":{"type":"string"}, "subject":{"type":"string"}, "subscriptionARN":{"type":"string"}, "token":{"type":"string"}, "topicARN":{"type":"string"}, "topicName":{"type":"string"} }, "documentation":"Amazon Simple Notification Service

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.

For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer Guide.

We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.

" }