sns.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class SNS extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: SNS.Types.ClientConfiguration) 13 config: Config & SNS.Types.ClientConfiguration; 14 /** 15 * Adds a statement to a topic's access control policy, granting access for the specified accounts to the specified actions. 16 */ 17 addPermission(params: SNS.Types.AddPermissionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 18 /** 19 * Adds a statement to a topic's access control policy, granting access for the specified accounts to the specified actions. 20 */ 21 addPermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 22 /** 23 * Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your 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. 24 */ 25 checkIfPhoneNumberIsOptedOut(params: SNS.Types.CheckIfPhoneNumberIsOptedOutInput, callback?: (err: AWSError, data: SNS.Types.CheckIfPhoneNumberIsOptedOutResponse) => void): Request<SNS.Types.CheckIfPhoneNumberIsOptedOutResponse, AWSError>; 26 /** 27 * Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your 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. 28 */ 29 checkIfPhoneNumberIsOptedOut(callback?: (err: AWSError, data: SNS.Types.CheckIfPhoneNumberIsOptedOutResponse) => void): Request<SNS.Types.CheckIfPhoneNumberIsOptedOutResponse, AWSError>; 30 /** 31 * 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". 32 */ 33 confirmSubscription(params: SNS.Types.ConfirmSubscriptionInput, callback?: (err: AWSError, data: SNS.Types.ConfirmSubscriptionResponse) => void): Request<SNS.Types.ConfirmSubscriptionResponse, AWSError>; 34 /** 35 * 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". 36 */ 37 confirmSubscription(callback?: (err: AWSError, data: SNS.Types.ConfirmSubscriptionResponse) => void): Request<SNS.Types.ConfirmSubscriptionResponse, AWSError>; 38 /** 39 * 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, PlatformPrincipal is SSL certificate and PlatformCredential is private 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. 40 */ 41 createPlatformApplication(params: SNS.Types.CreatePlatformApplicationInput, callback?: (err: AWSError, data: SNS.Types.CreatePlatformApplicationResponse) => void): Request<SNS.Types.CreatePlatformApplicationResponse, AWSError>; 42 /** 43 * 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, PlatformPrincipal is SSL certificate and PlatformCredential is private 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. 44 */ 45 createPlatformApplication(callback?: (err: AWSError, data: SNS.Types.CreatePlatformApplicationResponse) => void): Request<SNS.Types.CreatePlatformApplicationResponse, AWSError>; 46 /** 47 * 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. 48 */ 49 createPlatformEndpoint(params: SNS.Types.CreatePlatformEndpointInput, callback?: (err: AWSError, data: SNS.Types.CreateEndpointResponse) => void): Request<SNS.Types.CreateEndpointResponse, AWSError>; 50 /** 51 * 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. 52 */ 53 createPlatformEndpoint(callback?: (err: AWSError, data: SNS.Types.CreateEndpointResponse) => void): Request<SNS.Types.CreateEndpointResponse, AWSError>; 54 /** 55 * Adds a destination phone number to an 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 account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide. 56 */ 57 createSMSSandboxPhoneNumber(params: SNS.Types.CreateSMSSandboxPhoneNumberInput, callback?: (err: AWSError, data: SNS.Types.CreateSMSSandboxPhoneNumberResult) => void): Request<SNS.Types.CreateSMSSandboxPhoneNumberResult, AWSError>; 58 /** 59 * Adds a destination phone number to an 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 account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide. 60 */ 61 createSMSSandboxPhoneNumber(callback?: (err: AWSError, data: SNS.Types.CreateSMSSandboxPhoneNumberResult) => void): Request<SNS.Types.CreateSMSSandboxPhoneNumberResult, AWSError>; 62 /** 63 * 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. 64 */ 65 createTopic(params: SNS.Types.CreateTopicInput, callback?: (err: AWSError, data: SNS.Types.CreateTopicResponse) => void): Request<SNS.Types.CreateTopicResponse, AWSError>; 66 /** 67 * 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. 68 */ 69 createTopic(callback?: (err: AWSError, data: SNS.Types.CreateTopicResponse) => void): Request<SNS.Types.CreateTopicResponse, AWSError>; 70 /** 71 * 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. 72 */ 73 deleteEndpoint(params: SNS.Types.DeleteEndpointInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 74 /** 75 * 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. 76 */ 77 deleteEndpoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 78 /** 79 * 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. 80 */ 81 deletePlatformApplication(params: SNS.Types.DeletePlatformApplicationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 82 /** 83 * 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. 84 */ 85 deletePlatformApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 86 /** 87 * Deletes an account's verified or pending phone number from the SMS sandbox. When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide. 88 */ 89 deleteSMSSandboxPhoneNumber(params: SNS.Types.DeleteSMSSandboxPhoneNumberInput, callback?: (err: AWSError, data: SNS.Types.DeleteSMSSandboxPhoneNumberResult) => void): Request<SNS.Types.DeleteSMSSandboxPhoneNumberResult, AWSError>; 90 /** 91 * Deletes an account's verified or pending phone number from the SMS sandbox. When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide. 92 */ 93 deleteSMSSandboxPhoneNumber(callback?: (err: AWSError, data: SNS.Types.DeleteSMSSandboxPhoneNumberResult) => void): Request<SNS.Types.DeleteSMSSandboxPhoneNumberResult, AWSError>; 94 /** 95 * 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. 96 */ 97 deleteTopic(params: SNS.Types.DeleteTopicInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 98 /** 99 * 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. 100 */ 101 deleteTopic(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 102 /** 103 * 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. 104 */ 105 getEndpointAttributes(params: SNS.Types.GetEndpointAttributesInput, callback?: (err: AWSError, data: SNS.Types.GetEndpointAttributesResponse) => void): Request<SNS.Types.GetEndpointAttributesResponse, AWSError>; 106 /** 107 * 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. 108 */ 109 getEndpointAttributes(callback?: (err: AWSError, data: SNS.Types.GetEndpointAttributesResponse) => void): Request<SNS.Types.GetEndpointAttributesResponse, AWSError>; 110 /** 111 * 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. 112 */ 113 getPlatformApplicationAttributes(params: SNS.Types.GetPlatformApplicationAttributesInput, callback?: (err: AWSError, data: SNS.Types.GetPlatformApplicationAttributesResponse) => void): Request<SNS.Types.GetPlatformApplicationAttributesResponse, AWSError>; 114 /** 115 * 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. 116 */ 117 getPlatformApplicationAttributes(callback?: (err: AWSError, data: SNS.Types.GetPlatformApplicationAttributesResponse) => void): Request<SNS.Types.GetPlatformApplicationAttributesResponse, AWSError>; 118 /** 119 * Returns the settings for sending SMS messages from your account. These settings are set with the SetSMSAttributes action. 120 */ 121 getSMSAttributes(params: SNS.Types.GetSMSAttributesInput, callback?: (err: AWSError, data: SNS.Types.GetSMSAttributesResponse) => void): Request<SNS.Types.GetSMSAttributesResponse, AWSError>; 122 /** 123 * Returns the settings for sending SMS messages from your account. These settings are set with the SetSMSAttributes action. 124 */ 125 getSMSAttributes(callback?: (err: AWSError, data: SNS.Types.GetSMSAttributesResponse) => void): Request<SNS.Types.GetSMSAttributesResponse, AWSError>; 126 /** 127 * Retrieves the SMS sandbox status for the calling account in the target Region. When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide. 128 */ 129 getSMSSandboxAccountStatus(params: SNS.Types.GetSMSSandboxAccountStatusInput, callback?: (err: AWSError, data: SNS.Types.GetSMSSandboxAccountStatusResult) => void): Request<SNS.Types.GetSMSSandboxAccountStatusResult, AWSError>; 130 /** 131 * Retrieves the SMS sandbox status for the calling account in the target Region. When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide. 132 */ 133 getSMSSandboxAccountStatus(callback?: (err: AWSError, data: SNS.Types.GetSMSSandboxAccountStatusResult) => void): Request<SNS.Types.GetSMSSandboxAccountStatusResult, AWSError>; 134 /** 135 * Returns all of the properties of a subscription. 136 */ 137 getSubscriptionAttributes(params: SNS.Types.GetSubscriptionAttributesInput, callback?: (err: AWSError, data: SNS.Types.GetSubscriptionAttributesResponse) => void): Request<SNS.Types.GetSubscriptionAttributesResponse, AWSError>; 138 /** 139 * Returns all of the properties of a subscription. 140 */ 141 getSubscriptionAttributes(callback?: (err: AWSError, data: SNS.Types.GetSubscriptionAttributesResponse) => void): Request<SNS.Types.GetSubscriptionAttributesResponse, AWSError>; 142 /** 143 * Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. 144 */ 145 getTopicAttributes(params: SNS.Types.GetTopicAttributesInput, callback?: (err: AWSError, data: SNS.Types.GetTopicAttributesResponse) => void): Request<SNS.Types.GetTopicAttributesResponse, AWSError>; 146 /** 147 * Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. 148 */ 149 getTopicAttributes(callback?: (err: AWSError, data: SNS.Types.GetTopicAttributesResponse) => void): Request<SNS.Types.GetTopicAttributesResponse, AWSError>; 150 /** 151 * 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). 152 */ 153 listEndpointsByPlatformApplication(params: SNS.Types.ListEndpointsByPlatformApplicationInput, callback?: (err: AWSError, data: SNS.Types.ListEndpointsByPlatformApplicationResponse) => void): Request<SNS.Types.ListEndpointsByPlatformApplicationResponse, AWSError>; 154 /** 155 * 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). 156 */ 157 listEndpointsByPlatformApplication(callback?: (err: AWSError, data: SNS.Types.ListEndpointsByPlatformApplicationResponse) => void): Request<SNS.Types.ListEndpointsByPlatformApplicationResponse, AWSError>; 158 /** 159 * Lists the calling account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide. 160 */ 161 listOriginationNumbers(params: SNS.Types.ListOriginationNumbersRequest, callback?: (err: AWSError, data: SNS.Types.ListOriginationNumbersResult) => void): Request<SNS.Types.ListOriginationNumbersResult, AWSError>; 162 /** 163 * Lists the calling account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide. 164 */ 165 listOriginationNumbers(callback?: (err: AWSError, data: SNS.Types.ListOriginationNumbersResult) => void): Request<SNS.Types.ListOriginationNumbersResult, AWSError>; 166 /** 167 * 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. 168 */ 169 listPhoneNumbersOptedOut(params: SNS.Types.ListPhoneNumbersOptedOutInput, callback?: (err: AWSError, data: SNS.Types.ListPhoneNumbersOptedOutResponse) => void): Request<SNS.Types.ListPhoneNumbersOptedOutResponse, AWSError>; 170 /** 171 * 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. 172 */ 173 listPhoneNumbersOptedOut(callback?: (err: AWSError, data: SNS.Types.ListPhoneNumbersOptedOutResponse) => void): Request<SNS.Types.ListPhoneNumbersOptedOutResponse, AWSError>; 174 /** 175 * 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). 176 */ 177 listPlatformApplications(params: SNS.Types.ListPlatformApplicationsInput, callback?: (err: AWSError, data: SNS.Types.ListPlatformApplicationsResponse) => void): Request<SNS.Types.ListPlatformApplicationsResponse, AWSError>; 178 /** 179 * 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). 180 */ 181 listPlatformApplications(callback?: (err: AWSError, data: SNS.Types.ListPlatformApplicationsResponse) => void): Request<SNS.Types.ListPlatformApplicationsResponse, AWSError>; 182 /** 183 * Lists the calling account's current verified and pending destination phone numbers in the SMS sandbox. When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide. 184 */ 185 listSMSSandboxPhoneNumbers(params: SNS.Types.ListSMSSandboxPhoneNumbersInput, callback?: (err: AWSError, data: SNS.Types.ListSMSSandboxPhoneNumbersResult) => void): Request<SNS.Types.ListSMSSandboxPhoneNumbersResult, AWSError>; 186 /** 187 * Lists the calling account's current verified and pending destination phone numbers in the SMS sandbox. When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide. 188 */ 189 listSMSSandboxPhoneNumbers(callback?: (err: AWSError, data: SNS.Types.ListSMSSandboxPhoneNumbersResult) => void): Request<SNS.Types.ListSMSSandboxPhoneNumbersResult, AWSError>; 190 /** 191 * 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). 192 */ 193 listSubscriptions(params: SNS.Types.ListSubscriptionsInput, callback?: (err: AWSError, data: SNS.Types.ListSubscriptionsResponse) => void): Request<SNS.Types.ListSubscriptionsResponse, AWSError>; 194 /** 195 * 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). 196 */ 197 listSubscriptions(callback?: (err: AWSError, data: SNS.Types.ListSubscriptionsResponse) => void): Request<SNS.Types.ListSubscriptionsResponse, AWSError>; 198 /** 199 * 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). 200 */ 201 listSubscriptionsByTopic(params: SNS.Types.ListSubscriptionsByTopicInput, callback?: (err: AWSError, data: SNS.Types.ListSubscriptionsByTopicResponse) => void): Request<SNS.Types.ListSubscriptionsByTopicResponse, AWSError>; 202 /** 203 * 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). 204 */ 205 listSubscriptionsByTopic(callback?: (err: AWSError, data: SNS.Types.ListSubscriptionsByTopicResponse) => void): Request<SNS.Types.ListSubscriptionsByTopicResponse, AWSError>; 206 /** 207 * 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. 208 */ 209 listTagsForResource(params: SNS.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: SNS.Types.ListTagsForResourceResponse) => void): Request<SNS.Types.ListTagsForResourceResponse, AWSError>; 210 /** 211 * 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. 212 */ 213 listTagsForResource(callback?: (err: AWSError, data: SNS.Types.ListTagsForResourceResponse) => void): Request<SNS.Types.ListTagsForResourceResponse, AWSError>; 214 /** 215 * 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). 216 */ 217 listTopics(params: SNS.Types.ListTopicsInput, callback?: (err: AWSError, data: SNS.Types.ListTopicsResponse) => void): Request<SNS.Types.ListTopicsResponse, AWSError>; 218 /** 219 * 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). 220 */ 221 listTopics(callback?: (err: AWSError, data: SNS.Types.ListTopicsResponse) => void): Request<SNS.Types.ListTopicsResponse, AWSError>; 222 /** 223 * 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. 224 */ 225 optInPhoneNumber(params: SNS.Types.OptInPhoneNumberInput, callback?: (err: AWSError, data: SNS.Types.OptInPhoneNumberResponse) => void): Request<SNS.Types.OptInPhoneNumberResponse, AWSError>; 226 /** 227 * 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. 228 */ 229 optInPhoneNumber(callback?: (err: AWSError, data: SNS.Types.OptInPhoneNumberResponse) => void): Request<SNS.Types.OptInPhoneNumberResponse, AWSError>; 230 /** 231 * 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 has been saved and Amazon SNS will attempt to deliver it shortly. To use the Publish action for sending 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 Region. 232 */ 233 publish(params: SNS.Types.PublishInput, callback?: (err: AWSError, data: SNS.Types.PublishResponse) => void): Request<SNS.Types.PublishResponse, AWSError>; 234 /** 235 * 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 has been saved and Amazon SNS will attempt to deliver it shortly. To use the Publish action for sending 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 Region. 236 */ 237 publish(callback?: (err: AWSError, data: SNS.Types.PublishResponse) => void): Request<SNS.Types.PublishResponse, AWSError>; 238 /** 239 * Removes a statement from a topic's access control policy. 240 */ 241 removePermission(params: SNS.Types.RemovePermissionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 242 /** 243 * Removes a statement from a topic's access control policy. 244 */ 245 removePermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 246 /** 247 * 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. 248 */ 249 setEndpointAttributes(params: SNS.Types.SetEndpointAttributesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 250 /** 251 * 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. 252 */ 253 setEndpointAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 254 /** 255 * 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. 256 */ 257 setPlatformApplicationAttributes(params: SNS.Types.SetPlatformApplicationAttributesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 258 /** 259 * 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. 260 */ 261 setPlatformApplicationAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 262 /** 263 * 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. 264 */ 265 setSMSAttributes(params: SNS.Types.SetSMSAttributesInput, callback?: (err: AWSError, data: SNS.Types.SetSMSAttributesResponse) => void): Request<SNS.Types.SetSMSAttributesResponse, AWSError>; 266 /** 267 * 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. 268 */ 269 setSMSAttributes(callback?: (err: AWSError, data: SNS.Types.SetSMSAttributesResponse) => void): Request<SNS.Types.SetSMSAttributesResponse, AWSError>; 270 /** 271 * Allows a subscription owner to set an attribute of the subscription to a new value. 272 */ 273 setSubscriptionAttributes(params: SNS.Types.SetSubscriptionAttributesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 274 /** 275 * Allows a subscription owner to set an attribute of the subscription to a new value. 276 */ 277 setSubscriptionAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 278 /** 279 * Allows a topic owner to set an attribute of the topic to a new value. 280 */ 281 setTopicAttributes(params: SNS.Types.SetTopicAttributesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 282 /** 283 * Allows a topic owner to set an attribute of the topic to a new value. 284 */ 285 setTopicAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 286 /** 287 * 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 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 three days. This action is throttled at 100 transactions per second (TPS). 288 */ 289 subscribe(params: SNS.Types.SubscribeInput, callback?: (err: AWSError, data: SNS.Types.SubscribeResponse) => void): Request<SNS.Types.SubscribeResponse, AWSError>; 290 /** 291 * 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 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 three days. This action is throttled at 100 transactions per second (TPS). 292 */ 293 subscribe(callback?: (err: AWSError, data: SNS.Types.SubscribeResponse) => void): Request<SNS.Types.SubscribeResponse, AWSError>; 294 /** 295 * 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 account, per Region. If your application requires a higher throughput, file a technical support request. 296 */ 297 tagResource(params: SNS.Types.TagResourceRequest, callback?: (err: AWSError, data: SNS.Types.TagResourceResponse) => void): Request<SNS.Types.TagResourceResponse, AWSError>; 298 /** 299 * 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 account, per Region. If your application requires a higher throughput, file a technical support request. 300 */ 301 tagResource(callback?: (err: AWSError, data: SNS.Types.TagResourceResponse) => void): Request<SNS.Types.TagResourceResponse, AWSError>; 302 /** 303 * 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. This action is throttled at 100 transactions per second (TPS). 304 */ 305 unsubscribe(params: SNS.Types.UnsubscribeInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 306 /** 307 * 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. This action is throttled at 100 transactions per second (TPS). 308 */ 309 unsubscribe(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 310 /** 311 * Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide. 312 */ 313 untagResource(params: SNS.Types.UntagResourceRequest, callback?: (err: AWSError, data: SNS.Types.UntagResourceResponse) => void): Request<SNS.Types.UntagResourceResponse, AWSError>; 314 /** 315 * Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide. 316 */ 317 untagResource(callback?: (err: AWSError, data: SNS.Types.UntagResourceResponse) => void): Request<SNS.Types.UntagResourceResponse, AWSError>; 318 /** 319 * Verifies a destination phone number with a one-time password (OTP) for the calling account. When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide. 320 */ 321 verifySMSSandboxPhoneNumber(params: SNS.Types.VerifySMSSandboxPhoneNumberInput, callback?: (err: AWSError, data: SNS.Types.VerifySMSSandboxPhoneNumberResult) => void): Request<SNS.Types.VerifySMSSandboxPhoneNumberResult, AWSError>; 322 /** 323 * Verifies a destination phone number with a one-time password (OTP) for the calling account. When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide. 324 */ 325 verifySMSSandboxPhoneNumber(callback?: (err: AWSError, data: SNS.Types.VerifySMSSandboxPhoneNumberResult) => void): Request<SNS.Types.VerifySMSSandboxPhoneNumberResult, AWSError>; 326 } 327 declare namespace SNS { 328 export type ActionsList = action[]; 329 export interface AddPermissionInput { 330 /** 331 * The ARN of the topic whose access control policy you wish to modify. 332 */ 333 TopicArn: topicARN; 334 /** 335 * A unique identifier for the new policy statement. 336 */ 337 Label: label; 338 /** 339 * The account IDs of the users (principals) who will be given access to the specified actions. The users must have account, but do not need to be signed up for this service. 340 */ 341 AWSAccountId: DelegatesList; 342 /** 343 * The action you want to allow for the specified principal(s). Valid values: Any Amazon SNS action name, for example Publish. 344 */ 345 ActionName: ActionsList; 346 } 347 export type AmazonResourceName = string; 348 export type Binary = Buffer|Uint8Array|Blob|string; 349 export interface CheckIfPhoneNumberIsOptedOutInput { 350 /** 351 * The phone number for which you want to check the opt out status. 352 */ 353 phoneNumber: PhoneNumber; 354 } 355 export interface CheckIfPhoneNumberIsOptedOutResponse { 356 /** 357 * 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. 358 */ 359 isOptedOut?: boolean; 360 } 361 export interface ConfirmSubscriptionInput { 362 /** 363 * The ARN of the topic for which you wish to confirm a subscription. 364 */ 365 TopicArn: topicARN; 366 /** 367 * Short-lived token sent to an endpoint during the Subscribe action. 368 */ 369 Token: token; 370 /** 371 * 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. 372 */ 373 AuthenticateOnUnsubscribe?: authenticateOnUnsubscribe; 374 } 375 export interface ConfirmSubscriptionResponse { 376 /** 377 * The ARN of the created subscription. 378 */ 379 SubscriptionArn?: subscriptionARN; 380 } 381 export interface CreateEndpointResponse { 382 /** 383 * EndpointArn returned from CreateEndpoint action. 384 */ 385 EndpointArn?: String; 386 } 387 export interface CreatePlatformApplicationInput { 388 /** 389 * 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. 390 */ 391 Name: String; 392 /** 393 * The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging). 394 */ 395 Platform: String; 396 /** 397 * For a list of attributes, see SetPlatformApplicationAttributes. 398 */ 399 Attributes: MapStringToString; 400 } 401 export interface CreatePlatformApplicationResponse { 402 /** 403 * PlatformApplicationArn is returned. 404 */ 405 PlatformApplicationArn?: String; 406 } 407 export interface CreatePlatformEndpointInput { 408 /** 409 * PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint. 410 */ 411 PlatformApplicationArn: String; 412 /** 413 * 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. 414 */ 415 Token: String; 416 /** 417 * 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. 418 */ 419 CustomUserData?: String; 420 /** 421 * For a list of attributes, see SetEndpointAttributes. 422 */ 423 Attributes?: MapStringToString; 424 } 425 export interface CreateSMSSandboxPhoneNumberInput { 426 /** 427 * 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. 428 */ 429 PhoneNumber: PhoneNumberString; 430 /** 431 * The language to use for sending the OTP. The default value is en-US. 432 */ 433 LanguageCode?: LanguageCodeString; 434 } 435 export interface CreateSMSSandboxPhoneNumberResult { 436 } 437 export interface CreateTopicInput { 438 /** 439 * 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. 440 */ 441 Name: topicName; 442 /** 443 * 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. 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. 444 */ 445 Attributes?: TopicAttributesMap; 446 /** 447 * 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. 448 */ 449 Tags?: TagList; 450 } 451 export interface CreateTopicResponse { 452 /** 453 * The Amazon Resource Name (ARN) assigned to the created topic. 454 */ 455 TopicArn?: topicARN; 456 } 457 export type DelegatesList = delegate[]; 458 export interface DeleteEndpointInput { 459 /** 460 * EndpointArn of endpoint to delete. 461 */ 462 EndpointArn: String; 463 } 464 export interface DeletePlatformApplicationInput { 465 /** 466 * PlatformApplicationArn of platform application object to delete. 467 */ 468 PlatformApplicationArn: String; 469 } 470 export interface DeleteSMSSandboxPhoneNumberInput { 471 /** 472 * The destination phone number to delete. 473 */ 474 PhoneNumber: PhoneNumberString; 475 } 476 export interface DeleteSMSSandboxPhoneNumberResult { 477 } 478 export interface DeleteTopicInput { 479 /** 480 * The ARN of the topic you want to delete. 481 */ 482 TopicArn: topicARN; 483 } 484 export interface Endpoint { 485 /** 486 * EndpointArn for mobile app and device. 487 */ 488 EndpointArn?: String; 489 /** 490 * Attributes for endpoint. 491 */ 492 Attributes?: MapStringToString; 493 } 494 export interface GetEndpointAttributesInput { 495 /** 496 * EndpointArn for GetEndpointAttributes input. 497 */ 498 EndpointArn: String; 499 } 500 export interface GetEndpointAttributesResponse { 501 /** 502 * 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. 503 */ 504 Attributes?: MapStringToString; 505 } 506 export interface GetPlatformApplicationAttributesInput { 507 /** 508 * PlatformApplicationArn for GetPlatformApplicationAttributesInput. 509 */ 510 PlatformApplicationArn: String; 511 } 512 export interface GetPlatformApplicationAttributesResponse { 513 /** 514 * Attributes include the following: 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. 515 */ 516 Attributes?: MapStringToString; 517 } 518 export interface GetSMSAttributesInput { 519 /** 520 * 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. 521 */ 522 attributes?: ListString; 523 } 524 export interface GetSMSAttributesResponse { 525 /** 526 * The SMS attribute names and their values. 527 */ 528 attributes?: MapStringToString; 529 } 530 export interface GetSMSSandboxAccountStatusInput { 531 } 532 export interface GetSMSSandboxAccountStatusResult { 533 /** 534 * Indicates whether the calling account is in the SMS sandbox. 535 */ 536 IsInSandbox: boolean; 537 } 538 export interface GetSubscriptionAttributesInput { 539 /** 540 * The ARN of the subscription whose properties you want to get. 541 */ 542 SubscriptionArn: subscriptionARN; 543 } 544 export interface GetSubscriptionAttributesResponse { 545 /** 546 * 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. Owner – The 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. 547 */ 548 Attributes?: SubscriptionAttributesMap; 549 } 550 export interface GetTopicAttributesInput { 551 /** 552 * The ARN of the topic whose properties you want to get. 553 */ 554 TopicArn: topicARN; 555 } 556 export interface GetTopicAttributesResponse { 557 /** 558 * 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. Owner – The account ID of the topic's owner. Policy – The JSON serialization of the topic's access control policy. 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. EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account. 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. 559 */ 560 Attributes?: TopicAttributesMap; 561 } 562 export type Iso2CountryCode = string; 563 export type LanguageCodeString = "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"|string; 564 export interface ListEndpointsByPlatformApplicationInput { 565 /** 566 * PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action. 567 */ 568 PlatformApplicationArn: String; 569 /** 570 * NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results. 571 */ 572 NextToken?: String; 573 } 574 export interface ListEndpointsByPlatformApplicationResponse { 575 /** 576 * Endpoints returned for ListEndpointsByPlatformApplication action. 577 */ 578 Endpoints?: ListOfEndpoints; 579 /** 580 * NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results. 581 */ 582 NextToken?: String; 583 } 584 export type ListOfEndpoints = Endpoint[]; 585 export type ListOfPlatformApplications = PlatformApplication[]; 586 export interface ListOriginationNumbersRequest { 587 /** 588 * Token that the previous ListOriginationNumbers request returns. 589 */ 590 NextToken?: nextToken; 591 /** 592 * The maximum number of origination numbers to return. 593 */ 594 MaxResults?: MaxItemsListOriginationNumbers; 595 } 596 export interface ListOriginationNumbersResult { 597 /** 598 * A NextToken string is returned when you call the ListOriginationNumbers operation if additional pages of records are available. 599 */ 600 NextToken?: nextToken; 601 /** 602 * A list of the calling account's verified and pending origination numbers. 603 */ 604 PhoneNumbers?: PhoneNumberInformationList; 605 } 606 export interface ListPhoneNumbersOptedOutInput { 607 /** 608 * A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results. 609 */ 610 nextToken?: string; 611 } 612 export interface ListPhoneNumbersOptedOutResponse { 613 /** 614 * 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. 615 */ 616 phoneNumbers?: PhoneNumberList; 617 /** 618 * A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results. 619 */ 620 nextToken?: string; 621 } 622 export interface ListPlatformApplicationsInput { 623 /** 624 * NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results. 625 */ 626 NextToken?: String; 627 } 628 export interface ListPlatformApplicationsResponse { 629 /** 630 * Platform applications returned when calling ListPlatformApplications action. 631 */ 632 PlatformApplications?: ListOfPlatformApplications; 633 /** 634 * NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results. 635 */ 636 NextToken?: String; 637 } 638 export interface ListSMSSandboxPhoneNumbersInput { 639 /** 640 * Token that the previous ListSMSSandboxPhoneNumbersInput request returns. 641 */ 642 NextToken?: nextToken; 643 /** 644 * The maximum number of phone numbers to return. 645 */ 646 MaxResults?: MaxItems; 647 } 648 export interface ListSMSSandboxPhoneNumbersResult { 649 /** 650 * A list of the calling account's pending and verified phone numbers. 651 */ 652 PhoneNumbers: SMSSandboxPhoneNumberList; 653 /** 654 * A NextToken string is returned when you call the ListSMSSandboxPhoneNumbersInput operation if additional pages of records are available. 655 */ 656 NextToken?: string; 657 } 658 export type ListString = String[]; 659 export interface ListSubscriptionsByTopicInput { 660 /** 661 * The ARN of the topic for which you wish to find subscriptions. 662 */ 663 TopicArn: topicARN; 664 /** 665 * Token returned by the previous ListSubscriptionsByTopic request. 666 */ 667 NextToken?: nextToken; 668 } 669 export interface ListSubscriptionsByTopicResponse { 670 /** 671 * A list of subscriptions. 672 */ 673 Subscriptions?: SubscriptionsList; 674 /** 675 * Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve. 676 */ 677 NextToken?: nextToken; 678 } 679 export interface ListSubscriptionsInput { 680 /** 681 * Token returned by the previous ListSubscriptions request. 682 */ 683 NextToken?: nextToken; 684 } 685 export interface ListSubscriptionsResponse { 686 /** 687 * A list of subscriptions. 688 */ 689 Subscriptions?: SubscriptionsList; 690 /** 691 * Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve. 692 */ 693 NextToken?: nextToken; 694 } 695 export interface ListTagsForResourceRequest { 696 /** 697 * The ARN of the topic for which to list tags. 698 */ 699 ResourceArn: AmazonResourceName; 700 } 701 export interface ListTagsForResourceResponse { 702 /** 703 * The tags associated with the specified topic. 704 */ 705 Tags?: TagList; 706 } 707 export interface ListTopicsInput { 708 /** 709 * Token returned by the previous ListTopics request. 710 */ 711 NextToken?: nextToken; 712 } 713 export interface ListTopicsResponse { 714 /** 715 * A list of topic ARNs. 716 */ 717 Topics?: TopicsList; 718 /** 719 * Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve. 720 */ 721 NextToken?: nextToken; 722 } 723 export type MapStringToString = {[key: string]: String}; 724 export type MaxItems = number; 725 export type MaxItemsListOriginationNumbers = number; 726 export type MessageAttributeMap = {[key: string]: MessageAttributeValue}; 727 export interface MessageAttributeValue { 728 /** 729 * Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types. 730 */ 731 DataType: String; 732 /** 733 * Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters. 734 */ 735 StringValue?: String; 736 /** 737 * Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images. 738 */ 739 BinaryValue?: Binary; 740 } 741 export type NumberCapability = "SMS"|"MMS"|"VOICE"|string; 742 export type NumberCapabilityList = NumberCapability[]; 743 export type OTPCode = string; 744 export interface OptInPhoneNumberInput { 745 /** 746 * The phone number to opt in. Use E.164 format. 747 */ 748 phoneNumber: PhoneNumber; 749 } 750 export interface OptInPhoneNumberResponse { 751 } 752 export type PhoneNumber = string; 753 export interface PhoneNumberInformation { 754 /** 755 * The date and time when the phone number was created. 756 */ 757 CreatedAt?: Timestamp; 758 /** 759 * The phone number. 760 */ 761 PhoneNumber?: String; 762 /** 763 * The status of the phone number. 764 */ 765 Status?: String; 766 /** 767 * The two-character code for the country or region, in ISO 3166-1 alpha-2 format. 768 */ 769 Iso2CountryCode?: Iso2CountryCode; 770 /** 771 * The list of supported routes. 772 */ 773 RouteType?: RouteType; 774 /** 775 * The capabilities of each phone number. 776 */ 777 NumberCapabilities?: NumberCapabilityList; 778 } 779 export type PhoneNumberInformationList = PhoneNumberInformation[]; 780 export type PhoneNumberList = PhoneNumber[]; 781 export type PhoneNumberString = string; 782 export interface PlatformApplication { 783 /** 784 * PlatformApplicationArn for platform application object. 785 */ 786 PlatformApplicationArn?: String; 787 /** 788 * Attributes for platform application object. 789 */ 790 Attributes?: MapStringToString; 791 } 792 export interface PublishInput { 793 /** 794 * 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. 795 */ 796 TopicArn?: topicARN; 797 /** 798 * If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters. 799 */ 800 TargetArn?: String; 801 /** 802 * 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. 803 */ 804 PhoneNumber?: String; 805 /** 806 * 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). 807 */ 808 Message: message; 809 /** 810 * 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. 811 */ 812 Subject?: subject; 813 /** 814 * 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 815 */ 816 MessageStructure?: messageStructure; 817 /** 818 * Message attributes for Publish action. 819 */ 820 MessageAttributes?: MessageAttributeMap; 821 /** 822 * 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. 823 */ 824 MessageDeduplicationId?: String; 825 /** 826 * 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. 827 */ 828 MessageGroupId?: String; 829 } 830 export interface PublishResponse { 831 /** 832 * Unique identifier assigned to the published message. Length Constraint: Maximum 100 characters 833 */ 834 MessageId?: messageId; 835 /** 836 * 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. 837 */ 838 SequenceNumber?: String; 839 } 840 export interface RemovePermissionInput { 841 /** 842 * The ARN of the topic whose access control policy you wish to modify. 843 */ 844 TopicArn: topicARN; 845 /** 846 * The unique label of the statement you want to remove. 847 */ 848 Label: label; 849 } 850 export type RouteType = "Transactional"|"Promotional"|"Premium"|string; 851 export interface SMSSandboxPhoneNumber { 852 /** 853 * The destination phone number. 854 */ 855 PhoneNumber?: PhoneNumberString; 856 /** 857 * The destination phone number's verification status. 858 */ 859 Status?: SMSSandboxPhoneNumberVerificationStatus; 860 } 861 export type SMSSandboxPhoneNumberList = SMSSandboxPhoneNumber[]; 862 export type SMSSandboxPhoneNumberVerificationStatus = "Pending"|"Verified"|string; 863 export interface SetEndpointAttributesInput { 864 /** 865 * EndpointArn used for SetEndpointAttributes action. 866 */ 867 EndpointArn: String; 868 /** 869 * 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. 870 */ 871 Attributes: MapStringToString; 872 } 873 export interface SetPlatformApplicationAttributesInput { 874 /** 875 * PlatformApplicationArn for SetPlatformApplicationAttributes action. 876 */ 877 PlatformApplicationArn: String; 878 /** 879 * A map of the platform application attributes. Attributes in this map include the following: PlatformCredential – The credential received from the notification service. For APNS and APNS_SANDBOX, PlatformCredential is private key. For GCM (Firebase Cloud Messaging), PlatformCredential is API key. For ADM, PlatformCredential is client secret. PlatformPrincipal – The principal received from the notification service. For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal. For ADM, PlatformPrincipal is client id. 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. 880 */ 881 Attributes: MapStringToString; 882 } 883 export interface SetSMSAttributesInput { 884 /** 885 * The default settings for sending SMS messages from your 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 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. 886 */ 887 attributes: MapStringToString; 888 } 889 export interface SetSMSAttributesResponse { 890 } 891 export interface SetSubscriptionAttributesInput { 892 /** 893 * The ARN of the subscription to modify. 894 */ 895 SubscriptionArn: subscriptionARN; 896 /** 897 * 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. 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. 898 */ 899 AttributeName: attributeName; 900 /** 901 * The new value for the attribute in JSON format. 902 */ 903 AttributeValue?: attributeValue; 904 } 905 export interface SetTopicAttributesInput { 906 /** 907 * The ARN of the topic to modify. 908 */ 909 TopicArn: topicARN; 910 /** 911 * A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses: DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints. DisplayName – The display name to use for a topic with SMS subscriptions. Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic. 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 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. 912 */ 913 AttributeName: attributeName; 914 /** 915 * The new value for the attribute. 916 */ 917 AttributeValue?: attributeValue; 918 } 919 export type String = string; 920 export interface SubscribeInput { 921 /** 922 * The ARN of the topic you want to subscribe to. 923 */ 924 TopicArn: topicARN; 925 /** 926 * 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. 927 */ 928 Protocol: protocol; 929 /** 930 * 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. 931 */ 932 Endpoint?: endpoint; 933 /** 934 * 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. 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. 935 */ 936 Attributes?: SubscriptionAttributesMap; 937 /** 938 * 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. 939 */ 940 ReturnSubscriptionArn?: boolean; 941 } 942 export interface SubscribeResponse { 943 /** 944 * 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. 945 */ 946 SubscriptionArn?: subscriptionARN; 947 } 948 export interface Subscription { 949 /** 950 * The subscription's ARN. 951 */ 952 SubscriptionArn?: subscriptionARN; 953 /** 954 * The subscription's owner. 955 */ 956 Owner?: account; 957 /** 958 * The subscription's protocol. 959 */ 960 Protocol?: protocol; 961 /** 962 * The subscription's endpoint (format depends on the protocol). 963 */ 964 Endpoint?: endpoint; 965 /** 966 * The ARN of the subscription's topic. 967 */ 968 TopicArn?: topicARN; 969 } 970 export type SubscriptionAttributesMap = {[key: string]: attributeValue}; 971 export type SubscriptionsList = Subscription[]; 972 export interface Tag { 973 /** 974 * The required key portion of the tag. 975 */ 976 Key: TagKey; 977 /** 978 * The optional value portion of the tag. 979 */ 980 Value: TagValue; 981 } 982 export type TagKey = string; 983 export type TagKeyList = TagKey[]; 984 export type TagList = Tag[]; 985 export interface TagResourceRequest { 986 /** 987 * The ARN of the topic to which to add tags. 988 */ 989 ResourceArn: AmazonResourceName; 990 /** 991 * The tags to be added to the specified topic. A tag consists of a required key and an optional value. 992 */ 993 Tags: TagList; 994 } 995 export interface TagResourceResponse { 996 } 997 export type TagValue = string; 998 export type Timestamp = Date; 999 export interface Topic { 1000 /** 1001 * The topic's ARN. 1002 */ 1003 TopicArn?: topicARN; 1004 } 1005 export type TopicAttributesMap = {[key: string]: attributeValue}; 1006 export type TopicsList = Topic[]; 1007 export interface UnsubscribeInput { 1008 /** 1009 * The ARN of the subscription to be deleted. 1010 */ 1011 SubscriptionArn: subscriptionARN; 1012 } 1013 export interface UntagResourceRequest { 1014 /** 1015 * The ARN of the topic from which to remove tags. 1016 */ 1017 ResourceArn: AmazonResourceName; 1018 /** 1019 * The list of tag keys to remove from the specified topic. 1020 */ 1021 TagKeys: TagKeyList; 1022 } 1023 export interface UntagResourceResponse { 1024 } 1025 export interface VerifySMSSandboxPhoneNumberInput { 1026 /** 1027 * The destination phone number to verify. 1028 */ 1029 PhoneNumber: PhoneNumberString; 1030 /** 1031 * The OTP sent to the destination number from the CreateSMSSandBoxPhoneNumber call. 1032 */ 1033 OneTimePassword: OTPCode; 1034 } 1035 export interface VerifySMSSandboxPhoneNumberResult { 1036 } 1037 export type account = string; 1038 export type action = string; 1039 export type attributeName = string; 1040 export type attributeValue = string; 1041 export type authenticateOnUnsubscribe = string; 1042 export type delegate = string; 1043 export type endpoint = string; 1044 export type label = string; 1045 export type message = string; 1046 export type messageId = string; 1047 export type messageStructure = string; 1048 export type nextToken = string; 1049 export type protocol = string; 1050 export type subject = string; 1051 export type subscriptionARN = string; 1052 export type token = string; 1053 export type topicARN = string; 1054 export type topicName = string; 1055 /** 1056 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1057 */ 1058 export type apiVersion = "2010-03-31"|"latest"|string; 1059 export interface ClientApiVersions { 1060 /** 1061 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1062 */ 1063 apiVersion?: apiVersion; 1064 } 1065 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1066 /** 1067 * Contains interfaces for use with the SNS client. 1068 */ 1069 export import Types = SNS; 1070 } 1071 export = SNS;