💾 Archived View for gmi.noulin.net › gitRepositories › git-off › file › src › node_modules › aws-sdk… captured on 2023-07-10 at 16:19:30. Gemini links have been rewritten to link to archived content
⬅️ Previous capture (2023-01-29)
-=-=-=-=-=-=-
sns.d.ts (60132B)
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';
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 AWS 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 AWS 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, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is "Package Security Identifier". For MPNS, PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key". For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS.
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, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is "Package Security Identifier". For MPNS, PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key". For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS.
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 and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action 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 and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action 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 * Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see http://aws.amazon.com/sns. 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.
56 */
57 createTopic(params: SNS.Types.CreateTopicInput, callback?: (err: AWSError, data: SNS.Types.CreateTopicResponse) => void): Request<SNS.Types.CreateTopicResponse, AWSError>;
58 /**
59 * Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see http://aws.amazon.com/sns. 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.
60 */
61 createTopic(callback?: (err: AWSError, data: SNS.Types.CreateTopicResponse) => void): Request<SNS.Types.CreateTopicResponse, AWSError>;
62 /**
63 * 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.
64 */
65 deleteEndpoint(params: SNS.Types.DeleteEndpointInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
66 /**
67 * 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.
68 */
69 deleteEndpoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
70 /**
71 * Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
72 */
73 deletePlatformApplication(params: SNS.Types.DeletePlatformApplicationInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
74 /**
75 * Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
76 */
77 deletePlatformApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
78 /**
79 * 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.
80 */
81 deleteTopic(params: SNS.Types.DeleteTopicInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
82 /**
83 * 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.
84 */
85 deleteTopic(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
86 /**
87 * Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
88 */
89 getEndpointAttributes(params: SNS.Types.GetEndpointAttributesInput, callback?: (err: AWSError, data: SNS.Types.GetEndpointAttributesResponse) => void): Request<SNS.Types.GetEndpointAttributesResponse, AWSError>;
90 /**
91 * Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
92 */
93 getEndpointAttributes(callback?: (err: AWSError, data: SNS.Types.GetEndpointAttributesResponse) => void): Request<SNS.Types.GetEndpointAttributesResponse, AWSError>;
94 /**
95 * Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
96 */
97 getPlatformApplicationAttributes(params: SNS.Types.GetPlatformApplicationAttributesInput, callback?: (err: AWSError, data: SNS.Types.GetPlatformApplicationAttributesResponse) => void): Request<SNS.Types.GetPlatformApplicationAttributesResponse, AWSError>;
98 /**
99 * Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
100 */
101 getPlatformApplicationAttributes(callback?: (err: AWSError, data: SNS.Types.GetPlatformApplicationAttributesResponse) => void): Request<SNS.Types.GetPlatformApplicationAttributesResponse, AWSError>;
102 /**
103 * Returns the settings for sending SMS messages from your account. These settings are set with the SetSMSAttributes action.
104 */
105 getSMSAttributes(params: SNS.Types.GetSMSAttributesInput, callback?: (err: AWSError, data: SNS.Types.GetSMSAttributesResponse) => void): Request<SNS.Types.GetSMSAttributesResponse, AWSError>;
106 /**
107 * Returns the settings for sending SMS messages from your account. These settings are set with the SetSMSAttributes action.
108 */
109 getSMSAttributes(callback?: (err: AWSError, data: SNS.Types.GetSMSAttributesResponse) => void): Request<SNS.Types.GetSMSAttributesResponse, AWSError>;
110 /**
111 * Returns all of the properties of a subscription.
112 */
113 getSubscriptionAttributes(params: SNS.Types.GetSubscriptionAttributesInput, callback?: (err: AWSError, data: SNS.Types.GetSubscriptionAttributesResponse) => void): Request<SNS.Types.GetSubscriptionAttributesResponse, AWSError>;
114 /**
115 * Returns all of the properties of a subscription.
116 */
117 getSubscriptionAttributes(callback?: (err: AWSError, data: SNS.Types.GetSubscriptionAttributesResponse) => void): Request<SNS.Types.GetSubscriptionAttributesResponse, AWSError>;
118 /**
119 * Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
120 */
121 getTopicAttributes(params: SNS.Types.GetTopicAttributesInput, callback?: (err: AWSError, data: SNS.Types.GetTopicAttributesResponse) => void): Request<SNS.Types.GetTopicAttributesResponse, AWSError>;
122 /**
123 * Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
124 */
125 getTopicAttributes(callback?: (err: AWSError, data: SNS.Types.GetTopicAttributesResponse) => void): Request<SNS.Types.GetTopicAttributesResponse, AWSError>;
126 /**
127 * Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM 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.
128 */
129 listEndpointsByPlatformApplication(params: SNS.Types.ListEndpointsByPlatformApplicationInput, callback?: (err: AWSError, data: SNS.Types.ListEndpointsByPlatformApplicationResponse) => void): Request<SNS.Types.ListEndpointsByPlatformApplicationResponse, AWSError>;
130 /**
131 * Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM 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.
132 */
133 listEndpointsByPlatformApplication(callback?: (err: AWSError, data: SNS.Types.ListEndpointsByPlatformApplicationResponse) => void): Request<SNS.Types.ListEndpointsByPlatformApplicationResponse, AWSError>;
134 /**
135 * 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.
136 */
137 listPhoneNumbersOptedOut(params: SNS.Types.ListPhoneNumbersOptedOutInput, callback?: (err: AWSError, data: SNS.Types.ListPhoneNumbersOptedOutResponse) => void): Request<SNS.Types.ListPhoneNumbersOptedOutResponse, AWSError>;
138 /**
139 * 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.
140 */
141 listPhoneNumbersOptedOut(callback?: (err: AWSError, data: SNS.Types.ListPhoneNumbersOptedOutResponse) => void): Request<SNS.Types.ListPhoneNumbersOptedOutResponse, AWSError>;
142 /**
143 * Lists the platform application objects for the supported push notification services, such as APNS and GCM. 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.
144 */
145 listPlatformApplications(params: SNS.Types.ListPlatformApplicationsInput, callback?: (err: AWSError, data: SNS.Types.ListPlatformApplicationsResponse) => void): Request<SNS.Types.ListPlatformApplicationsResponse, AWSError>;
146 /**
147 * Lists the platform application objects for the supported push notification services, such as APNS and GCM. 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.
148 */
149 listPlatformApplications(callback?: (err: AWSError, data: SNS.Types.ListPlatformApplicationsResponse) => void): Request<SNS.Types.ListPlatformApplicationsResponse, AWSError>;
150 /**
151 * 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.
152 */
153 listSubscriptions(params: SNS.Types.ListSubscriptionsInput, callback?: (err: AWSError, data: SNS.Types.ListSubscriptionsResponse) => void): Request<SNS.Types.ListSubscriptionsResponse, AWSError>;
154 /**
155 * 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.
156 */
157 listSubscriptions(callback?: (err: AWSError, data: SNS.Types.ListSubscriptionsResponse) => void): Request<SNS.Types.ListSubscriptionsResponse, AWSError>;
158 /**
159 * 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.
160 */
161 listSubscriptionsByTopic(params: SNS.Types.ListSubscriptionsByTopicInput, callback?: (err: AWSError, data: SNS.Types.ListSubscriptionsByTopicResponse) => void): Request<SNS.Types.ListSubscriptionsByTopicResponse, AWSError>;
162 /**
163 * 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.
164 */
165 listSubscriptionsByTopic(callback?: (err: AWSError, data: SNS.Types.ListSubscriptionsByTopicResponse) => void): Request<SNS.Types.ListSubscriptionsByTopicResponse, AWSError>;
166 /**
167 * 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.
168 */
169 listTopics(params: SNS.Types.ListTopicsInput, callback?: (err: AWSError, data: SNS.Types.ListTopicsResponse) => void): Request<SNS.Types.ListTopicsResponse, AWSError>;
170 /**
171 * 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.
172 */
173 listTopics(callback?: (err: AWSError, data: SNS.Types.ListTopicsResponse) => void): Request<SNS.Types.ListTopicsResponse, AWSError>;
174 /**
175 * 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.
176 */
177 optInPhoneNumber(params: SNS.Types.OptInPhoneNumberInput, callback?: (err: AWSError, data: SNS.Types.OptInPhoneNumberResponse) => void): Request<SNS.Types.OptInPhoneNumberResponse, AWSError>;
178 /**
179 * 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.
180 */
181 optInPhoneNumber(callback?: (err: AWSError, data: SNS.Types.OptInPhoneNumberResponse) => void): Request<SNS.Types.OptInPhoneNumberResponse, AWSError>;
182 /**
183 * Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol. 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.
184 */
185 publish(params: SNS.Types.PublishInput, callback?: (err: AWSError, data: SNS.Types.PublishResponse) => void): Request<SNS.Types.PublishResponse, AWSError>;
186 /**
187 * Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol. 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.
188 */
189 publish(callback?: (err: AWSError, data: SNS.Types.PublishResponse) => void): Request<SNS.Types.PublishResponse, AWSError>;
190 /**
191 * Removes a statement from a topic's access control policy.
192 */
193 removePermission(params: SNS.Types.RemovePermissionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
194 /**
195 * Removes a statement from a topic's access control policy.
196 */
197 removePermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
198 /**
199 * Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
200 */
201 setEndpointAttributes(params: SNS.Types.SetEndpointAttributesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
202 /**
203 * Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
204 */
205 setEndpointAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
206 /**
207 * Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. 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.
208 */
209 setPlatformApplicationAttributes(params: SNS.Types.SetPlatformApplicationAttributesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
210 /**
211 * Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. 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.
212 */
213 setPlatformApplicationAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
214 /**
215 * 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 Sending an SMS Message in the Amazon SNS Developer Guide.
216 */
217 setSMSAttributes(params: SNS.Types.SetSMSAttributesInput, callback?: (err: AWSError, data: SNS.Types.SetSMSAttributesResponse) => void): Request<SNS.Types.SetSMSAttributesResponse, AWSError>;
218 /**
219 * 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 Sending an SMS Message in the Amazon SNS Developer Guide.
220 */
221 setSMSAttributes(callback?: (err: AWSError, data: SNS.Types.SetSMSAttributesResponse) => void): Request<SNS.Types.SetSMSAttributesResponse, AWSError>;
222 /**
223 * Allows a subscription owner to set an attribute of the topic to a new value.
224 */
225 setSubscriptionAttributes(params: SNS.Types.SetSubscriptionAttributesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
226 /**
227 * Allows a subscription owner to set an attribute of the topic to a new value.
228 */
229 setSubscriptionAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
230 /**
231 * Allows a topic owner to set an attribute of the topic to a new value.
232 */
233 setTopicAttributes(params: SNS.Types.SetTopicAttributesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
234 /**
235 * Allows a topic owner to set an attribute of the topic to a new value.
236 */
237 setTopicAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
238 /**
239 * Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.
240 */
241 subscribe(params: SNS.Types.SubscribeInput, callback?: (err: AWSError, data: SNS.Types.SubscribeResponse) => void): Request<SNS.Types.SubscribeResponse, AWSError>;
242 /**
243 * Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.
244 */
245 subscribe(callback?: (err: AWSError, data: SNS.Types.SubscribeResponse) => void): Request<SNS.Types.SubscribeResponse, AWSError>;
246 /**
247 * 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 AWS 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.
248 */
249 unsubscribe(params: SNS.Types.UnsubscribeInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
250 /**
251 * 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 AWS 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.
252 */
253 unsubscribe(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
254 }
255 declare namespace SNS.Types {
256 export type ActionsList = action[];
257 export interface AddPermissionInput {
258 /**
259 * The ARN of the topic whose access control policy you wish to modify.
260 */
261 TopicArn: topicARN;
262 /**
263 * A unique identifier for the new policy statement.
264 */
265 Label: label;
266 /**
267 * The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.
268 */
269 AWSAccountId: DelegatesList;
270 /**
271 * The action you want to allow for the specified principal(s). Valid values: any Amazon SNS action name.
272 */
273 ActionName: ActionsList;
274 }
275 export type Binary = Buffer|Uint8Array|Blob|string;
276 export interface CheckIfPhoneNumberIsOptedOutInput {
277 /**
278 * The phone number for which you want to check the opt out status.
279 */
280 phoneNumber: PhoneNumber;
281 }
282 export interface CheckIfPhoneNumberIsOptedOutResponse {
283 /**
284 * 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.
285 */
286 isOptedOut?: boolean;
287 }
288 export interface ConfirmSubscriptionInput {
289 /**
290 * The ARN of the topic for which you wish to confirm a subscription.
291 */
292 TopicArn: topicARN;
293 /**
294 * Short-lived token sent to an endpoint during the Subscribe action.
295 */
296 Token: token;
297 /**
298 * Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
299 */
300 AuthenticateOnUnsubscribe?: authenticateOnUnsubscribe;
301 }
302 export interface ConfirmSubscriptionResponse {
303 /**
304 * The ARN of the created subscription.
305 */
306 SubscriptionArn?: subscriptionARN;
307 }
308 export interface CreateEndpointResponse {
309 /**
310 * EndpointArn returned from CreateEndpoint action.
311 */
312 EndpointArn?: String;
313 }
314 export interface CreatePlatformApplicationInput {
315 /**
316 * 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.
317 */
318 Name: String;
319 /**
320 * The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).
321 */
322 Platform: String;
323 /**
324 * For a list of attributes, see SetPlatformApplicationAttributes
325 */
326 Attributes: MapStringToString;
327 }
328 export interface CreatePlatformApplicationResponse {
329 /**
330 * PlatformApplicationArn is returned.
331 */
332 PlatformApplicationArn?: String;
333 }
334 export interface CreatePlatformEndpointInput {
335 /**
336 * PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
337 */
338 PlatformApplicationArn: String;
339 /**
340 * 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 or ADM, the device token equivalent is called the registration ID.
341 */
342 Token: String;
343 /**
344 * 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.
345 */
346 CustomUserData?: String;
347 /**
348 * For a list of attributes, see SetEndpointAttributes.
349 */
350 Attributes?: MapStringToString;
351 }
352 export interface CreateTopicInput {
353 /**
354 * 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.
355 */
356 Name: topicName;
357 }
358 export interface CreateTopicResponse {
359 /**
360 * The Amazon Resource Name (ARN) assigned to the created topic.
361 */
362 TopicArn?: topicARN;
363 }
364 export type DelegatesList = delegate[];
365 export interface DeleteEndpointInput {
366 /**
367 * EndpointArn of endpoint to delete.
368 */
369 EndpointArn: String;
370 }
371 export interface DeletePlatformApplicationInput {
372 /**
373 * PlatformApplicationArn of platform application object to delete.
374 */
375 PlatformApplicationArn: String;
376 }
377 export interface DeleteTopicInput {
378 /**
379 * The ARN of the topic you want to delete.
380 */
381 TopicArn: topicARN;
382 }
383 export interface Endpoint {
384 /**
385 * EndpointArn for mobile app and device.
386 */
387 EndpointArn?: String;
388 /**
389 * Attributes for endpoint.
390 */
391 Attributes?: MapStringToString;
392 }
393 export interface GetEndpointAttributesInput {
394 /**
395 * EndpointArn for GetEndpointAttributes input.
396 */
397 EndpointArn: String;
398 }
399 export interface GetEndpointAttributesResponse {
400 /**
401 * 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.
402 */
403 Attributes?: MapStringToString;
404 }
405 export interface GetPlatformApplicationAttributesInput {
406 /**
407 * PlatformApplicationArn for GetPlatformApplicationAttributesInput.
408 */
409 PlatformApplicationArn: String;
410 }
411 export interface GetPlatformApplicationAttributesResponse {
412 /**
413 * 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.
414 */
415 Attributes?: MapStringToString;
416 }
417 export interface GetSMSAttributesInput {
418 /**
419 * 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.
420 */
421 attributes?: ListString;
422 }
423 export interface GetSMSAttributesResponse {
424 /**
425 * The SMS attribute names and their values.
426 */
427 attributes?: MapStringToString;
428 }
429 export interface GetSubscriptionAttributesInput {
430 /**
431 * The ARN of the subscription whose properties you want to get.
432 */
433 SubscriptionArn: subscriptionARN;
434 }
435 export interface GetSubscriptionAttributesResponse {
436 /**
437 * A map of the subscription's attributes. Attributes in this map include the following: SubscriptionArn -- the subscription's ARN TopicArn -- the topic ARN that the subscription is associated with Owner -- the AWS account ID of the subscription's owner 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
438 */
439 Attributes?: SubscriptionAttributesMap;
440 }
441 export interface GetTopicAttributesInput {
442 /**
443 * The ARN of the topic whose properties you want to get.
444 */
445 TopicArn: topicARN;
446 }
447 export interface GetTopicAttributesResponse {
448 /**
449 * A map of the topic's attributes. Attributes in this map include the following: TopicArn -- the topic's ARN Owner -- the AWS account ID of the topic's owner Policy -- the JSON serialization of the topic's access control policy DisplayName -- the human-readable name used in the "From" field for notifications to email and email-json endpoints SubscriptionsPending -- the number of subscriptions pending confirmation on this topic SubscriptionsConfirmed -- the number of confirmed subscriptions on this topic SubscriptionsDeleted -- the number of deleted subscriptions on this topic DeliveryPolicy -- the JSON serialization of the topic's delivery policy EffectiveDeliveryPolicy -- the JSON serialization of the effective delivery policy that takes into account system defaults
450 */
451 Attributes?: TopicAttributesMap;
452 }
453 export interface ListEndpointsByPlatformApplicationInput {
454 /**
455 * PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
456 */
457 PlatformApplicationArn: String;
458 /**
459 * NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.
460 */
461 NextToken?: String;
462 }
463 export interface ListEndpointsByPlatformApplicationResponse {
464 /**
465 * Endpoints returned for ListEndpointsByPlatformApplication action.
466 */
467 Endpoints?: ListOfEndpoints;
468 /**
469 * NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.
470 */
471 NextToken?: String;
472 }
473 export type ListOfEndpoints = Endpoint[];
474 export type ListOfPlatformApplications = PlatformApplication[];
475 export interface ListPhoneNumbersOptedOutInput {
476 /**
477 * A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.
478 */
479 nextToken?: string;
480 }
481 export interface ListPhoneNumbersOptedOutResponse {
482 /**
483 * 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.
484 */
485 phoneNumbers?: PhoneNumberList;
486 /**
487 * A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.
488 */
489 nextToken?: string;
490 }
491 export interface ListPlatformApplicationsInput {
492 /**
493 * NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.
494 */
495 NextToken?: String;
496 }
497 export interface ListPlatformApplicationsResponse {
498 /**
499 * Platform applications returned when calling ListPlatformApplications action.
500 */
501 PlatformApplications?: ListOfPlatformApplications;
502 /**
503 * NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.
504 */
505 NextToken?: String;
506 }
507 export type ListString = String[];
508 export interface ListSubscriptionsByTopicInput {
509 /**
510 * The ARN of the topic for which you wish to find subscriptions.
511 */
512 TopicArn: topicARN;
513 /**
514 * Token returned by the previous ListSubscriptionsByTopic request.
515 */
516 NextToken?: nextToken;
517 }
518 export interface ListSubscriptionsByTopicResponse {
519 /**
520 * A list of subscriptions.
521 */
522 Subscriptions?: SubscriptionsList;
523 /**
524 * Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.
525 */
526 NextToken?: nextToken;
527 }
528 export interface ListSubscriptionsInput {
529 /**
530 * Token returned by the previous ListSubscriptions request.
531 */
532 NextToken?: nextToken;
533 }
534 export interface ListSubscriptionsResponse {
535 /**
536 * A list of subscriptions.
537 */
538 Subscriptions?: SubscriptionsList;
539 /**
540 * Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.
541 */
542 NextToken?: nextToken;
543 }
544 export interface ListTopicsInput {
545 /**
546 * Token returned by the previous ListTopics request.
547 */
548 NextToken?: nextToken;
549 }
550 export interface ListTopicsResponse {
551 /**
552 * A list of topic ARNs.
553 */
554 Topics?: TopicsList;
555 /**
556 * Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
557 */
558 NextToken?: nextToken;
559 }
560 export type MapStringToString = {[key: string]: String};
561 export type MessageAttributeMap = {[key: string]: MessageAttributeValue};
562 export interface MessageAttributeValue {
563 /**
564 * Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
565 */
566 DataType: String;
567 /**
568 * Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
569 */
570 StringValue?: String;
571 /**
572 * Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
573 */
574 BinaryValue?: Binary;
575 }
576 export interface OptInPhoneNumberInput {
577 /**
578 * The phone number to opt in.
579 */
580 phoneNumber: PhoneNumber;
581 }
582 export interface OptInPhoneNumberResponse {
583 }
584 export type PhoneNumber = string;
585 export type PhoneNumberList = PhoneNumber[];
586 export interface PlatformApplication {
587 /**
588 * PlatformApplicationArn for platform application object.
589 */
590 PlatformApplicationArn?: String;
591 /**
592 * Attributes for platform application object.
593 */
594 Attributes?: MapStringToString;
595 }
596 export interface PublishInput {
597 /**
598 * 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.
599 */
600 TopicArn?: topicARN;
601 /**
602 * Either TopicArn or EndpointArn, but not both. If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.
603 */
604 TargetArn?: String;
605 /**
606 * 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.
607 */
608 PhoneNumber?: String;
609 /**
610 * The message you want to send to the topic. If 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: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 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).
611 */
612 Message: message;
613 /**
614 * 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.
615 */
616 Subject?: subject;
617 /**
618 * 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"). For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide. Valid value: json
619 */
620 MessageStructure?: messageStructure;
621 /**
622 * Message attributes for Publish action.
623 */
624 MessageAttributes?: MessageAttributeMap;
625 }
626 export interface PublishResponse {
627 /**
628 * Unique identifier assigned to the published message. Length Constraint: Maximum 100 characters
629 */
630 MessageId?: messageId;
631 }
632 export interface RemovePermissionInput {
633 /**
634 * The ARN of the topic whose access control policy you wish to modify.
635 */
636 TopicArn: topicARN;
637 /**
638 * The unique label of the statement you want to remove.
639 */
640 Label: label;
641 }
642 export interface SetEndpointAttributesInput {
643 /**
644 * EndpointArn used for SetEndpointAttributes action.
645 */
646 EndpointArn: String;
647 /**
648 * 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.
649 */
650 Attributes: MapStringToString;
651 }
652 export interface SetPlatformApplicationAttributesInput {
653 /**
654 * PlatformApplicationArn for SetPlatformApplicationAttributes action.
655 */
656 PlatformApplicationArn: String;
657 /**
658 * A map of the platform application attributes. Attributes in this map include the following: PlatformCredential -- The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is private key. For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". PlatformPrincipal -- The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". 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. 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.
659 */
660 Attributes: MapStringToString;
661 }
662 export interface SetSMSAttributesInput {
663 /**
664 * 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 exceed the maximum, contact AWS Support or your AWS sales representative for a service 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 principle 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.
665 */
666 attributes: MapStringToString;
667 }
668 export interface SetSMSAttributesResponse {
669 }
670 export interface SetSubscriptionAttributesInput {
671 /**
672 * The ARN of the subscription to modify.
673 */
674 SubscriptionArn: subscriptionARN;
675 /**
676 * The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable. Valid values: DeliveryPolicy | RawMessageDelivery
677 */
678 AttributeName: attributeName;
679 /**
680 * The new value for the attribute in JSON format.
681 */
682 AttributeValue?: attributeValue;
683 }
684 export interface SetTopicAttributesInput {
685 /**
686 * The ARN of the topic to modify.
687 */
688 TopicArn: topicARN;
689 /**
690 * The name of the attribute you want to set. Only a subset of the topic's attributes are mutable. Valid values: Policy | DisplayName | DeliveryPolicy
691 */
692 AttributeName: attributeName;
693 /**
694 * The new value for the attribute.
695 */
696 AttributeValue?: attributeValue;
697 }
698 export type String = string;
699 export interface SubscribeInput {
700 /**
701 * The ARN of the topic you want to subscribe to.
702 */
703 TopicArn: topicARN;
704 /**
705 * The protocol 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 AWS Lambda function.
706 */
707 Protocol: protocol;
708 /**
709 * The endpoint that you want to receive notifications. Endpoints vary by protocol: For the http protocol, the endpoint is an URL beginning with "http://" For the https protocol, the 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 AWS Lambda function.
710 */
711 Endpoint?: endpoint;
712 }
713 export interface SubscribeResponse {
714 /**
715 * The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
716 */
717 SubscriptionArn?: subscriptionARN;
718 }
719 export interface Subscription {
720 /**
721 * The subscription's ARN.
722 */
723 SubscriptionArn?: subscriptionARN;
724 /**
725 * The subscription's owner.
726 */
727 Owner?: account;
728 /**
729 * The subscription's protocol.
730 */
731 Protocol?: protocol;
732 /**
733 * The subscription's endpoint (format depends on the protocol).
734 */
735 Endpoint?: endpoint;
736 /**
737 * The ARN of the subscription's topic.
738 */
739 TopicArn?: topicARN;
740 }
741 export type SubscriptionAttributesMap = {[key: string]: attributeValue};
742 export type SubscriptionsList = Subscription[];
743 export interface Topic {
744 /**
745 * The topic's ARN.
746 */
747 TopicArn?: topicARN;
748 }
749 export type TopicAttributesMap = {[key: string]: attributeValue};
750 export type TopicsList = Topic[];
751 export interface UnsubscribeInput {
752 /**
753 * The ARN of the subscription to be deleted.
754 */
755 SubscriptionArn: subscriptionARN;
756 }
757 export type account = string;
758 export type action = string;
759 export type attributeName = string;
760 export type attributeValue = string;
761 export type authenticateOnUnsubscribe = string;
762 export type delegate = string;
763 export type endpoint = string;
764 export type label = string;
765 export type message = string;
766 export type messageId = string;
767 export type messageStructure = string;
768 export type nextToken = string;
769 export type protocol = string;
770 export type subject = string;
771 export type subscriptionARN = string;
772 export type token = string;
773 export type topicARN = string;
774 export type topicName = string;
775 /**
776 * 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.
777 */
778 export type apiVersion = "2010-03-31"|"latest"|string;
779 export interface ClientApiVersions {
780 /**
781 * 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.
782 */
783 apiVersion?: apiVersion;
784 }
785 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
786 }
787 export = SNS;