@aws-sdk/client-sns 3.315.0 → 3.319.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/SNS.js +46 -588
- package/dist-es/SNS.js +46 -588
- package/dist-types/SNS.d.ts +61 -384
- package/dist-types/ts3.4/SNS.d.ts +2 -1
- package/package.json +8 -8
package/dist-types/SNS.d.ts
CHANGED
|
@@ -42,598 +42,275 @@ import { UnsubscribeCommandInput, UnsubscribeCommandOutput } from "./commands/Un
|
|
|
42
42
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
43
43
|
import { VerifySMSSandboxPhoneNumberCommandInput, VerifySMSSandboxPhoneNumberCommandOutput } from "./commands/VerifySMSSandboxPhoneNumberCommand";
|
|
44
44
|
import { SNSClient } from "./SNSClient";
|
|
45
|
-
|
|
46
|
-
* @public
|
|
47
|
-
* <fullname>Amazon Simple Notification Service</fullname>
|
|
48
|
-
* <p>Amazon Simple Notification Service (Amazon SNS) is a web service that enables you
|
|
49
|
-
* to build distributed web-enabled applications. Applications can use Amazon SNS to easily push
|
|
50
|
-
* real-time notification messages to interested subscribers over multiple delivery
|
|
51
|
-
* protocols. For more information about this product see the <a href="http://aws.amazon.com/sns/">Amazon SNS product page</a>. For detailed information about Amazon SNS features
|
|
52
|
-
* and their associated API calls, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/">Amazon SNS Developer Guide</a>. </p>
|
|
53
|
-
* <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-authentication-and-access-control.html">Identity and access management in Amazon SNS</a> in the <i>Amazon SNS Developer
|
|
54
|
-
* Guide.</i>
|
|
55
|
-
* </p>
|
|
56
|
-
* <p>We also provide SDKs that enable you to access Amazon SNS from your preferred programming
|
|
57
|
-
* language. The SDKs contain functionality that automatically takes care of tasks such as:
|
|
58
|
-
* cryptographically signing your service requests, retrying requests, and handling error
|
|
59
|
-
* responses. For a list of available SDKs, go to <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>. </p>
|
|
60
|
-
*/
|
|
61
|
-
export declare class SNS extends SNSClient {
|
|
45
|
+
export interface SNS {
|
|
62
46
|
/**
|
|
63
|
-
* @
|
|
64
|
-
* <p>Adds a statement to a topic's access control policy, granting access for the specified
|
|
65
|
-
* Amazon Web Services accounts to the specified actions.</p>
|
|
66
|
-
* <note>
|
|
67
|
-
* <p>To remove the ability to change topic permissions, you must deny permissions to
|
|
68
|
-
* the <code>AddPermission</code>, <code>RemovePermission</code>, and
|
|
69
|
-
* <code>SetTopicAttributes</code> actions in your IAM policy.</p>
|
|
70
|
-
* </note>
|
|
47
|
+
* @see {@link AddPermissionCommand}
|
|
71
48
|
*/
|
|
72
49
|
addPermission(args: AddPermissionCommandInput, options?: __HttpHandlerOptions): Promise<AddPermissionCommandOutput>;
|
|
73
50
|
addPermission(args: AddPermissionCommandInput, cb: (err: any, data?: AddPermissionCommandOutput) => void): void;
|
|
74
51
|
addPermission(args: AddPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddPermissionCommandOutput) => void): void;
|
|
75
52
|
/**
|
|
76
|
-
* @
|
|
77
|
-
* <p>Accepts a phone number and indicates whether the phone holder has opted out of
|
|
78
|
-
* receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number
|
|
79
|
-
* that is opted out.</p>
|
|
80
|
-
* <p>To resume sending messages, you can opt in the number by using the
|
|
81
|
-
* <code>OptInPhoneNumber</code> action.</p>
|
|
53
|
+
* @see {@link CheckIfPhoneNumberIsOptedOutCommand}
|
|
82
54
|
*/
|
|
83
55
|
checkIfPhoneNumberIsOptedOut(args: CheckIfPhoneNumberIsOptedOutCommandInput, options?: __HttpHandlerOptions): Promise<CheckIfPhoneNumberIsOptedOutCommandOutput>;
|
|
84
56
|
checkIfPhoneNumberIsOptedOut(args: CheckIfPhoneNumberIsOptedOutCommandInput, cb: (err: any, data?: CheckIfPhoneNumberIsOptedOutCommandOutput) => void): void;
|
|
85
57
|
checkIfPhoneNumberIsOptedOut(args: CheckIfPhoneNumberIsOptedOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CheckIfPhoneNumberIsOptedOutCommandOutput) => void): void;
|
|
86
58
|
/**
|
|
87
|
-
* @
|
|
88
|
-
* <p>Verifies an endpoint owner's intent to receive messages by validating the token sent
|
|
89
|
-
* to the endpoint by an earlier <code>Subscribe</code> action. If the token is valid, the
|
|
90
|
-
* action creates a new subscription and returns its Amazon Resource Name (ARN). This call
|
|
91
|
-
* requires an AWS signature only when the <code>AuthenticateOnUnsubscribe</code> flag is
|
|
92
|
-
* set to "true".</p>
|
|
59
|
+
* @see {@link ConfirmSubscriptionCommand}
|
|
93
60
|
*/
|
|
94
61
|
confirmSubscription(args: ConfirmSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<ConfirmSubscriptionCommandOutput>;
|
|
95
62
|
confirmSubscription(args: ConfirmSubscriptionCommandInput, cb: (err: any, data?: ConfirmSubscriptionCommandOutput) => void): void;
|
|
96
63
|
confirmSubscription(args: ConfirmSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmSubscriptionCommandOutput) => void): void;
|
|
97
64
|
/**
|
|
98
|
-
* @
|
|
99
|
-
* <p>Creates a platform application object for one of the supported push notification
|
|
100
|
-
* services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile
|
|
101
|
-
* apps may register. You must specify <code>PlatformPrincipal</code> and
|
|
102
|
-
* <code>PlatformCredential</code> attributes when using the
|
|
103
|
-
* <code>CreatePlatformApplication</code> action.</p>
|
|
104
|
-
* <p>
|
|
105
|
-
* <code>PlatformPrincipal</code> and <code>PlatformCredential</code> are received from
|
|
106
|
-
* the notification service.</p>
|
|
107
|
-
* <ul>
|
|
108
|
-
* <li>
|
|
109
|
-
* <p>For <code>ADM</code>, <code>PlatformPrincipal</code> is <code>client id</code>
|
|
110
|
-
* and <code>PlatformCredential</code> is <code>client secret</code>.</p>
|
|
111
|
-
* </li>
|
|
112
|
-
* <li>
|
|
113
|
-
* <p>For <code>Baidu</code>, <code>PlatformPrincipal</code> is <code>API key</code>
|
|
114
|
-
* and <code>PlatformCredential</code> is <code>secret key</code>.</p>
|
|
115
|
-
* </li>
|
|
116
|
-
* <li>
|
|
117
|
-
* <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using certificate
|
|
118
|
-
* credentials, <code>PlatformPrincipal</code> is <code>SSL certificate</code> and
|
|
119
|
-
* <code>PlatformCredential</code> is <code>private key</code>.</p>
|
|
120
|
-
* </li>
|
|
121
|
-
* <li>
|
|
122
|
-
* <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using token credentials,
|
|
123
|
-
* <code>PlatformPrincipal</code> is <code>signing key ID</code> and
|
|
124
|
-
* <code>PlatformCredential</code> is <code>signing key</code>.</p>
|
|
125
|
-
* </li>
|
|
126
|
-
* <li>
|
|
127
|
-
* <p>For <code>GCM</code> (Firebase Cloud Messaging), there is no
|
|
128
|
-
* <code>PlatformPrincipal</code> and the <code>PlatformCredential</code> is
|
|
129
|
-
* <code>API key</code>.</p>
|
|
130
|
-
* </li>
|
|
131
|
-
* <li>
|
|
132
|
-
* <p>For <code>MPNS</code>, <code>PlatformPrincipal</code> is <code>TLS
|
|
133
|
-
* certificate</code> and <code>PlatformCredential</code> is <code>private
|
|
134
|
-
* key</code>.</p>
|
|
135
|
-
* </li>
|
|
136
|
-
* <li>
|
|
137
|
-
* <p>For <code>WNS</code>, <code>PlatformPrincipal</code> is <code>Package Security
|
|
138
|
-
* Identifier</code> and <code>PlatformCredential</code> is <code>secret
|
|
139
|
-
* key</code>.</p>
|
|
140
|
-
* </li>
|
|
141
|
-
* </ul>
|
|
142
|
-
* <p>You can use the returned <code>PlatformApplicationArn</code> as an attribute for the
|
|
143
|
-
* <code>CreatePlatformEndpoint</code> action.</p>
|
|
65
|
+
* @see {@link CreatePlatformApplicationCommand}
|
|
144
66
|
*/
|
|
145
67
|
createPlatformApplication(args: CreatePlatformApplicationCommandInput, options?: __HttpHandlerOptions): Promise<CreatePlatformApplicationCommandOutput>;
|
|
146
68
|
createPlatformApplication(args: CreatePlatformApplicationCommandInput, cb: (err: any, data?: CreatePlatformApplicationCommandOutput) => void): void;
|
|
147
69
|
createPlatformApplication(args: CreatePlatformApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlatformApplicationCommandOutput) => void): void;
|
|
148
70
|
/**
|
|
149
|
-
* @
|
|
150
|
-
* <p>Creates an endpoint for a device and mobile app on one of the supported push
|
|
151
|
-
* notification services, such as GCM (Firebase Cloud Messaging) and APNS.
|
|
152
|
-
* <code>CreatePlatformEndpoint</code> requires the <code>PlatformApplicationArn</code>
|
|
153
|
-
* that is returned from <code>CreatePlatformApplication</code>. You can use the returned
|
|
154
|
-
* <code>EndpointArn</code> to send a message to a mobile app or by the
|
|
155
|
-
* <code>Subscribe</code> action for subscription to a topic. The
|
|
156
|
-
* <code>CreatePlatformEndpoint</code> action is idempotent, so if the requester
|
|
157
|
-
* already owns an endpoint with the same device token and attributes, that endpoint's ARN
|
|
158
|
-
* is returned without creating a new endpoint. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push
|
|
159
|
-
* Notifications</a>. </p>
|
|
160
|
-
* <p>When using <code>CreatePlatformEndpoint</code> with Baidu, two attributes must be
|
|
161
|
-
* provided: ChannelId and UserId. The token field must also contain the ChannelId. For
|
|
162
|
-
* more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html">Creating an Amazon SNS Endpoint for
|
|
163
|
-
* Baidu</a>. </p>
|
|
71
|
+
* @see {@link CreatePlatformEndpointCommand}
|
|
164
72
|
*/
|
|
165
73
|
createPlatformEndpoint(args: CreatePlatformEndpointCommandInput, options?: __HttpHandlerOptions): Promise<CreatePlatformEndpointCommandOutput>;
|
|
166
74
|
createPlatformEndpoint(args: CreatePlatformEndpointCommandInput, cb: (err: any, data?: CreatePlatformEndpointCommandOutput) => void): void;
|
|
167
75
|
createPlatformEndpoint(args: CreatePlatformEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlatformEndpointCommandOutput) => void): void;
|
|
168
76
|
/**
|
|
169
|
-
* @
|
|
170
|
-
* <p>Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a
|
|
171
|
-
* one-time password (OTP) to that phone number.</p>
|
|
172
|
-
* <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
|
|
173
|
-
* <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
|
|
174
|
-
* you to try Amazon SNS features without risking your reputation as an SMS sender. While your
|
|
175
|
-
* Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send
|
|
176
|
-
* SMS messages only to verified destination phone numbers. For more information, including how to
|
|
177
|
-
* move out of the sandbox to send messages without restrictions,
|
|
178
|
-
* see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in
|
|
179
|
-
* the <i>Amazon SNS Developer Guide</i>.</p>
|
|
77
|
+
* @see {@link CreateSMSSandboxPhoneNumberCommand}
|
|
180
78
|
*/
|
|
181
79
|
createSMSSandboxPhoneNumber(args: CreateSMSSandboxPhoneNumberCommandInput, options?: __HttpHandlerOptions): Promise<CreateSMSSandboxPhoneNumberCommandOutput>;
|
|
182
80
|
createSMSSandboxPhoneNumber(args: CreateSMSSandboxPhoneNumberCommandInput, cb: (err: any, data?: CreateSMSSandboxPhoneNumberCommandOutput) => void): void;
|
|
183
81
|
createSMSSandboxPhoneNumber(args: CreateSMSSandboxPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSMSSandboxPhoneNumberCommandOutput) => void): void;
|
|
184
82
|
/**
|
|
185
|
-
* @
|
|
186
|
-
* <p>Creates a topic to which notifications can be published. Users can create at most
|
|
187
|
-
* 100,000 standard topics (at most 1,000 FIFO topics). For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html">Creating an Amazon SNS
|
|
188
|
-
* topic</a> in the <i>Amazon SNS Developer Guide</i>. This action is
|
|
189
|
-
* idempotent, so if the requester already owns a topic with the specified name, that
|
|
190
|
-
* topic's ARN is returned without creating a new topic.</p>
|
|
83
|
+
* @see {@link CreateTopicCommand}
|
|
191
84
|
*/
|
|
192
85
|
createTopic(args: CreateTopicCommandInput, options?: __HttpHandlerOptions): Promise<CreateTopicCommandOutput>;
|
|
193
86
|
createTopic(args: CreateTopicCommandInput, cb: (err: any, data?: CreateTopicCommandOutput) => void): void;
|
|
194
87
|
createTopic(args: CreateTopicCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTopicCommandOutput) => void): void;
|
|
195
88
|
/**
|
|
196
|
-
* @
|
|
197
|
-
* <p>Deletes the endpoint for a device and mobile app from Amazon SNS. This action is
|
|
198
|
-
* idempotent. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push
|
|
199
|
-
* Notifications</a>. </p>
|
|
200
|
-
* <p>When you delete an endpoint that is also subscribed to a topic, then you must also
|
|
201
|
-
* unsubscribe the endpoint from the topic.</p>
|
|
89
|
+
* @see {@link DeleteEndpointCommand}
|
|
202
90
|
*/
|
|
203
91
|
deleteEndpoint(args: DeleteEndpointCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEndpointCommandOutput>;
|
|
204
92
|
deleteEndpoint(args: DeleteEndpointCommandInput, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void;
|
|
205
93
|
deleteEndpoint(args: DeleteEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void;
|
|
206
94
|
/**
|
|
207
|
-
* @
|
|
208
|
-
* <p>Deletes a platform application object for one of the supported push notification
|
|
209
|
-
* services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see
|
|
210
|
-
* <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS
|
|
211
|
-
* Mobile Push Notifications</a>. </p>
|
|
95
|
+
* @see {@link DeletePlatformApplicationCommand}
|
|
212
96
|
*/
|
|
213
97
|
deletePlatformApplication(args: DeletePlatformApplicationCommandInput, options?: __HttpHandlerOptions): Promise<DeletePlatformApplicationCommandOutput>;
|
|
214
98
|
deletePlatformApplication(args: DeletePlatformApplicationCommandInput, cb: (err: any, data?: DeletePlatformApplicationCommandOutput) => void): void;
|
|
215
99
|
deletePlatformApplication(args: DeletePlatformApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePlatformApplicationCommandOutput) => void): void;
|
|
216
100
|
/**
|
|
217
|
-
* @
|
|
218
|
-
* <p>Deletes an Amazon Web Services account's verified or pending phone number from the SMS
|
|
219
|
-
* sandbox.</p>
|
|
220
|
-
* <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
|
|
221
|
-
* <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
|
|
222
|
-
* you to try Amazon SNS features without risking your reputation as an SMS sender. While your
|
|
223
|
-
* Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send
|
|
224
|
-
* SMS messages only to verified destination phone numbers. For more information, including how to
|
|
225
|
-
* move out of the sandbox to send messages without restrictions,
|
|
226
|
-
* see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in
|
|
227
|
-
* the <i>Amazon SNS Developer Guide</i>.</p>
|
|
101
|
+
* @see {@link DeleteSMSSandboxPhoneNumberCommand}
|
|
228
102
|
*/
|
|
229
103
|
deleteSMSSandboxPhoneNumber(args: DeleteSMSSandboxPhoneNumberCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSMSSandboxPhoneNumberCommandOutput>;
|
|
230
104
|
deleteSMSSandboxPhoneNumber(args: DeleteSMSSandboxPhoneNumberCommandInput, cb: (err: any, data?: DeleteSMSSandboxPhoneNumberCommandOutput) => void): void;
|
|
231
105
|
deleteSMSSandboxPhoneNumber(args: DeleteSMSSandboxPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSMSSandboxPhoneNumberCommandOutput) => void): void;
|
|
232
106
|
/**
|
|
233
|
-
* @
|
|
234
|
-
* <p>Deletes a topic and all its subscriptions. Deleting a topic might prevent some
|
|
235
|
-
* messages previously sent to the topic from being delivered to subscribers. This action
|
|
236
|
-
* is idempotent, so deleting a topic that does not exist does not result in an
|
|
237
|
-
* error.</p>
|
|
107
|
+
* @see {@link DeleteTopicCommand}
|
|
238
108
|
*/
|
|
239
109
|
deleteTopic(args: DeleteTopicCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTopicCommandOutput>;
|
|
240
110
|
deleteTopic(args: DeleteTopicCommandInput, cb: (err: any, data?: DeleteTopicCommandOutput) => void): void;
|
|
241
111
|
deleteTopic(args: DeleteTopicCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTopicCommandOutput) => void): void;
|
|
242
112
|
/**
|
|
243
|
-
* @
|
|
244
|
-
* <p>Retrieves the specified inline <code>DataProtectionPolicy</code> document that is
|
|
245
|
-
* stored in the specified Amazon SNS topic. </p>
|
|
113
|
+
* @see {@link GetDataProtectionPolicyCommand}
|
|
246
114
|
*/
|
|
247
115
|
getDataProtectionPolicy(args: GetDataProtectionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetDataProtectionPolicyCommandOutput>;
|
|
248
116
|
getDataProtectionPolicy(args: GetDataProtectionPolicyCommandInput, cb: (err: any, data?: GetDataProtectionPolicyCommandOutput) => void): void;
|
|
249
117
|
getDataProtectionPolicy(args: GetDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataProtectionPolicyCommandOutput) => void): void;
|
|
250
118
|
/**
|
|
251
|
-
* @
|
|
252
|
-
* <p>Retrieves the endpoint attributes for a device on one of the supported push
|
|
253
|
-
* notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more
|
|
254
|
-
* information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
|
|
119
|
+
* @see {@link GetEndpointAttributesCommand}
|
|
255
120
|
*/
|
|
256
121
|
getEndpointAttributes(args: GetEndpointAttributesCommandInput, options?: __HttpHandlerOptions): Promise<GetEndpointAttributesCommandOutput>;
|
|
257
122
|
getEndpointAttributes(args: GetEndpointAttributesCommandInput, cb: (err: any, data?: GetEndpointAttributesCommandOutput) => void): void;
|
|
258
123
|
getEndpointAttributes(args: GetEndpointAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEndpointAttributesCommandOutput) => void): void;
|
|
259
124
|
/**
|
|
260
|
-
* @
|
|
261
|
-
* <p>Retrieves the attributes of the platform application object for the supported push
|
|
262
|
-
* notification services, such as APNS and GCM (Firebase Cloud Messaging). For more
|
|
263
|
-
* information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
|
|
125
|
+
* @see {@link GetPlatformApplicationAttributesCommand}
|
|
264
126
|
*/
|
|
265
127
|
getPlatformApplicationAttributes(args: GetPlatformApplicationAttributesCommandInput, options?: __HttpHandlerOptions): Promise<GetPlatformApplicationAttributesCommandOutput>;
|
|
266
128
|
getPlatformApplicationAttributes(args: GetPlatformApplicationAttributesCommandInput, cb: (err: any, data?: GetPlatformApplicationAttributesCommandOutput) => void): void;
|
|
267
129
|
getPlatformApplicationAttributes(args: GetPlatformApplicationAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPlatformApplicationAttributesCommandOutput) => void): void;
|
|
268
130
|
/**
|
|
269
|
-
* @
|
|
270
|
-
* <p>Returns the settings for sending SMS messages from your Amazon Web Services account.</p>
|
|
271
|
-
* <p>These settings are set with the <code>SetSMSAttributes</code> action.</p>
|
|
131
|
+
* @see {@link GetSMSAttributesCommand}
|
|
272
132
|
*/
|
|
273
133
|
getSMSAttributes(args: GetSMSAttributesCommandInput, options?: __HttpHandlerOptions): Promise<GetSMSAttributesCommandOutput>;
|
|
274
134
|
getSMSAttributes(args: GetSMSAttributesCommandInput, cb: (err: any, data?: GetSMSAttributesCommandOutput) => void): void;
|
|
275
135
|
getSMSAttributes(args: GetSMSAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSMSAttributesCommandOutput) => void): void;
|
|
276
136
|
/**
|
|
277
|
-
* @
|
|
278
|
-
* <p>Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target
|
|
279
|
-
* Amazon Web Services Region.</p>
|
|
280
|
-
* <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
|
|
281
|
-
* <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
|
|
282
|
-
* you to try Amazon SNS features without risking your reputation as an SMS sender. While your
|
|
283
|
-
* Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send
|
|
284
|
-
* SMS messages only to verified destination phone numbers. For more information, including how to
|
|
285
|
-
* move out of the sandbox to send messages without restrictions,
|
|
286
|
-
* see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in
|
|
287
|
-
* the <i>Amazon SNS Developer Guide</i>.</p>
|
|
137
|
+
* @see {@link GetSMSSandboxAccountStatusCommand}
|
|
288
138
|
*/
|
|
289
139
|
getSMSSandboxAccountStatus(args: GetSMSSandboxAccountStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetSMSSandboxAccountStatusCommandOutput>;
|
|
290
140
|
getSMSSandboxAccountStatus(args: GetSMSSandboxAccountStatusCommandInput, cb: (err: any, data?: GetSMSSandboxAccountStatusCommandOutput) => void): void;
|
|
291
141
|
getSMSSandboxAccountStatus(args: GetSMSSandboxAccountStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSMSSandboxAccountStatusCommandOutput) => void): void;
|
|
292
142
|
/**
|
|
293
|
-
* @
|
|
294
|
-
* <p>Returns all of the properties of a subscription.</p>
|
|
143
|
+
* @see {@link GetSubscriptionAttributesCommand}
|
|
295
144
|
*/
|
|
296
145
|
getSubscriptionAttributes(args: GetSubscriptionAttributesCommandInput, options?: __HttpHandlerOptions): Promise<GetSubscriptionAttributesCommandOutput>;
|
|
297
146
|
getSubscriptionAttributes(args: GetSubscriptionAttributesCommandInput, cb: (err: any, data?: GetSubscriptionAttributesCommandOutput) => void): void;
|
|
298
147
|
getSubscriptionAttributes(args: GetSubscriptionAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubscriptionAttributesCommandOutput) => void): void;
|
|
299
148
|
/**
|
|
300
|
-
* @
|
|
301
|
-
* <p>Returns all of the properties of a topic. Topic properties returned might differ based
|
|
302
|
-
* on the authorization of the user.</p>
|
|
149
|
+
* @see {@link GetTopicAttributesCommand}
|
|
303
150
|
*/
|
|
304
151
|
getTopicAttributes(args: GetTopicAttributesCommandInput, options?: __HttpHandlerOptions): Promise<GetTopicAttributesCommandOutput>;
|
|
305
152
|
getTopicAttributes(args: GetTopicAttributesCommandInput, cb: (err: any, data?: GetTopicAttributesCommandOutput) => void): void;
|
|
306
153
|
getTopicAttributes(args: GetTopicAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTopicAttributesCommandOutput) => void): void;
|
|
307
154
|
/**
|
|
308
|
-
* @
|
|
309
|
-
* <p>Lists the endpoints and endpoint attributes for devices in a supported push
|
|
310
|
-
* notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for
|
|
311
|
-
* <code>ListEndpointsByPlatformApplication</code> are paginated and return a limited
|
|
312
|
-
* list of endpoints, up to 100. If additional records are available after the first page
|
|
313
|
-
* results, then a NextToken string will be returned. To receive the next page, you call
|
|
314
|
-
* <code>ListEndpointsByPlatformApplication</code> again using the NextToken string
|
|
315
|
-
* received from the previous call. When there are no more records to return, NextToken
|
|
316
|
-
* will be null. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push
|
|
317
|
-
* Notifications</a>. </p>
|
|
318
|
-
* <p>This action is throttled at 30 transactions per second (TPS).</p>
|
|
155
|
+
* @see {@link ListEndpointsByPlatformApplicationCommand}
|
|
319
156
|
*/
|
|
320
157
|
listEndpointsByPlatformApplication(args: ListEndpointsByPlatformApplicationCommandInput, options?: __HttpHandlerOptions): Promise<ListEndpointsByPlatformApplicationCommandOutput>;
|
|
321
158
|
listEndpointsByPlatformApplication(args: ListEndpointsByPlatformApplicationCommandInput, cb: (err: any, data?: ListEndpointsByPlatformApplicationCommandOutput) => void): void;
|
|
322
159
|
listEndpointsByPlatformApplication(args: ListEndpointsByPlatformApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEndpointsByPlatformApplicationCommandOutput) => void): void;
|
|
323
160
|
/**
|
|
324
|
-
* @
|
|
325
|
-
* <p>Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata.
|
|
326
|
-
* For more information about origination numbers, see <a href="https://docs.aws.amazon.com/sns/latest/dg/channels-sms-originating-identities-origination-numbers.html">Origination numbers</a> in the <i>Amazon SNS Developer
|
|
327
|
-
* Guide</i>.</p>
|
|
161
|
+
* @see {@link ListOriginationNumbersCommand}
|
|
328
162
|
*/
|
|
329
163
|
listOriginationNumbers(args: ListOriginationNumbersCommandInput, options?: __HttpHandlerOptions): Promise<ListOriginationNumbersCommandOutput>;
|
|
330
164
|
listOriginationNumbers(args: ListOriginationNumbersCommandInput, cb: (err: any, data?: ListOriginationNumbersCommandOutput) => void): void;
|
|
331
165
|
listOriginationNumbers(args: ListOriginationNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOriginationNumbersCommandOutput) => void): void;
|
|
332
166
|
/**
|
|
333
|
-
* @
|
|
334
|
-
* <p>Returns a list of phone numbers that are opted out, meaning you cannot send SMS
|
|
335
|
-
* messages to them.</p>
|
|
336
|
-
* <p>The results for <code>ListPhoneNumbersOptedOut</code> are paginated, and each page
|
|
337
|
-
* returns up to 100 phone numbers. If additional phone numbers are available after the
|
|
338
|
-
* first page of results, then a <code>NextToken</code> string will be returned. To receive
|
|
339
|
-
* the next page, you call <code>ListPhoneNumbersOptedOut</code> again using the
|
|
340
|
-
* <code>NextToken</code> string received from the previous call. When there are no
|
|
341
|
-
* more records to return, <code>NextToken</code> will be null.</p>
|
|
167
|
+
* @see {@link ListPhoneNumbersOptedOutCommand}
|
|
342
168
|
*/
|
|
343
169
|
listPhoneNumbersOptedOut(args: ListPhoneNumbersOptedOutCommandInput, options?: __HttpHandlerOptions): Promise<ListPhoneNumbersOptedOutCommandOutput>;
|
|
344
170
|
listPhoneNumbersOptedOut(args: ListPhoneNumbersOptedOutCommandInput, cb: (err: any, data?: ListPhoneNumbersOptedOutCommandOutput) => void): void;
|
|
345
171
|
listPhoneNumbersOptedOut(args: ListPhoneNumbersOptedOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPhoneNumbersOptedOutCommandOutput) => void): void;
|
|
346
172
|
/**
|
|
347
|
-
* @
|
|
348
|
-
* <p>Lists the platform application objects for the supported push notification services,
|
|
349
|
-
* such as APNS and GCM (Firebase Cloud Messaging). The results for
|
|
350
|
-
* <code>ListPlatformApplications</code> are paginated and return a limited list of
|
|
351
|
-
* applications, up to 100. If additional records are available after the first page
|
|
352
|
-
* results, then a NextToken string will be returned. To receive the next page, you call
|
|
353
|
-
* <code>ListPlatformApplications</code> using the NextToken string received from the
|
|
354
|
-
* previous call. When there are no more records to return, <code>NextToken</code> will be
|
|
355
|
-
* null. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push
|
|
356
|
-
* Notifications</a>. </p>
|
|
357
|
-
* <p>This action is throttled at 15 transactions per second (TPS).</p>
|
|
173
|
+
* @see {@link ListPlatformApplicationsCommand}
|
|
358
174
|
*/
|
|
359
175
|
listPlatformApplications(args: ListPlatformApplicationsCommandInput, options?: __HttpHandlerOptions): Promise<ListPlatformApplicationsCommandOutput>;
|
|
360
176
|
listPlatformApplications(args: ListPlatformApplicationsCommandInput, cb: (err: any, data?: ListPlatformApplicationsCommandOutput) => void): void;
|
|
361
177
|
listPlatformApplications(args: ListPlatformApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPlatformApplicationsCommandOutput) => void): void;
|
|
362
178
|
/**
|
|
363
|
-
* @
|
|
364
|
-
* <p>Lists the calling Amazon Web Services account's current verified and pending destination phone
|
|
365
|
-
* numbers in the SMS sandbox.</p>
|
|
366
|
-
* <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
|
|
367
|
-
* <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
|
|
368
|
-
* you to try Amazon SNS features without risking your reputation as an SMS sender. While your
|
|
369
|
-
* Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send
|
|
370
|
-
* SMS messages only to verified destination phone numbers. For more information, including how to
|
|
371
|
-
* move out of the sandbox to send messages without restrictions,
|
|
372
|
-
* see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in
|
|
373
|
-
* the <i>Amazon SNS Developer Guide</i>.</p>
|
|
179
|
+
* @see {@link ListSMSSandboxPhoneNumbersCommand}
|
|
374
180
|
*/
|
|
375
181
|
listSMSSandboxPhoneNumbers(args: ListSMSSandboxPhoneNumbersCommandInput, options?: __HttpHandlerOptions): Promise<ListSMSSandboxPhoneNumbersCommandOutput>;
|
|
376
182
|
listSMSSandboxPhoneNumbers(args: ListSMSSandboxPhoneNumbersCommandInput, cb: (err: any, data?: ListSMSSandboxPhoneNumbersCommandOutput) => void): void;
|
|
377
183
|
listSMSSandboxPhoneNumbers(args: ListSMSSandboxPhoneNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSMSSandboxPhoneNumbersCommandOutput) => void): void;
|
|
378
184
|
/**
|
|
379
|
-
* @
|
|
380
|
-
* <p>Returns a list of the requester's subscriptions. Each call returns a limited list of
|
|
381
|
-
* subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is
|
|
382
|
-
* also returned. Use the <code>NextToken</code> parameter in a new
|
|
383
|
-
* <code>ListSubscriptions</code> call to get further results.</p>
|
|
384
|
-
* <p>This action is throttled at 30 transactions per second (TPS).</p>
|
|
185
|
+
* @see {@link ListSubscriptionsCommand}
|
|
385
186
|
*/
|
|
386
187
|
listSubscriptions(args: ListSubscriptionsCommandInput, options?: __HttpHandlerOptions): Promise<ListSubscriptionsCommandOutput>;
|
|
387
188
|
listSubscriptions(args: ListSubscriptionsCommandInput, cb: (err: any, data?: ListSubscriptionsCommandOutput) => void): void;
|
|
388
189
|
listSubscriptions(args: ListSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubscriptionsCommandOutput) => void): void;
|
|
389
190
|
/**
|
|
390
|
-
* @
|
|
391
|
-
* <p>Returns a list of the subscriptions to a specific topic. Each call returns a limited
|
|
392
|
-
* list of subscriptions, up to 100. If there are more subscriptions, a
|
|
393
|
-
* <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in
|
|
394
|
-
* a new <code>ListSubscriptionsByTopic</code> call to get further results.</p>
|
|
395
|
-
* <p>This action is throttled at 30 transactions per second (TPS).</p>
|
|
191
|
+
* @see {@link ListSubscriptionsByTopicCommand}
|
|
396
192
|
*/
|
|
397
193
|
listSubscriptionsByTopic(args: ListSubscriptionsByTopicCommandInput, options?: __HttpHandlerOptions): Promise<ListSubscriptionsByTopicCommandOutput>;
|
|
398
194
|
listSubscriptionsByTopic(args: ListSubscriptionsByTopicCommandInput, cb: (err: any, data?: ListSubscriptionsByTopicCommandOutput) => void): void;
|
|
399
195
|
listSubscriptionsByTopic(args: ListSubscriptionsByTopicCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubscriptionsByTopicCommandOutput) => void): void;
|
|
400
196
|
/**
|
|
401
|
-
* @
|
|
402
|
-
* <p>List all tags added to the specified Amazon SNS topic. For an overview, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html">Amazon SNS Tags</a> in the
|
|
403
|
-
* <i>Amazon Simple Notification Service Developer Guide</i>.</p>
|
|
197
|
+
* @see {@link ListTagsForResourceCommand}
|
|
404
198
|
*/
|
|
405
199
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
406
200
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
407
201
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
408
202
|
/**
|
|
409
|
-
* @
|
|
410
|
-
* <p>Returns a list of the requester's topics. Each call returns a limited list of topics,
|
|
411
|
-
* up to 100. If there are more topics, a <code>NextToken</code> is also returned. Use the
|
|
412
|
-
* <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get
|
|
413
|
-
* further results.</p>
|
|
414
|
-
* <p>This action is throttled at 30 transactions per second (TPS).</p>
|
|
203
|
+
* @see {@link ListTopicsCommand}
|
|
415
204
|
*/
|
|
416
205
|
listTopics(args: ListTopicsCommandInput, options?: __HttpHandlerOptions): Promise<ListTopicsCommandOutput>;
|
|
417
206
|
listTopics(args: ListTopicsCommandInput, cb: (err: any, data?: ListTopicsCommandOutput) => void): void;
|
|
418
207
|
listTopics(args: ListTopicsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTopicsCommandOutput) => void): void;
|
|
419
208
|
/**
|
|
420
|
-
* @
|
|
421
|
-
* <p>Use this request to opt in a phone number that is opted out, which enables you to
|
|
422
|
-
* resume sending SMS messages to the number.</p>
|
|
423
|
-
* <p>You can opt in a phone number only once every 30 days.</p>
|
|
209
|
+
* @see {@link OptInPhoneNumberCommand}
|
|
424
210
|
*/
|
|
425
211
|
optInPhoneNumber(args: OptInPhoneNumberCommandInput, options?: __HttpHandlerOptions): Promise<OptInPhoneNumberCommandOutput>;
|
|
426
212
|
optInPhoneNumber(args: OptInPhoneNumberCommandInput, cb: (err: any, data?: OptInPhoneNumberCommandOutput) => void): void;
|
|
427
213
|
optInPhoneNumber(args: OptInPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OptInPhoneNumberCommandOutput) => void): void;
|
|
428
214
|
/**
|
|
429
|
-
* @
|
|
430
|
-
* <p>Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone
|
|
431
|
-
* number, or a message to a mobile platform endpoint (when you specify the
|
|
432
|
-
* <code>TargetArn</code>).</p>
|
|
433
|
-
* <p>If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is
|
|
434
|
-
* subscribed to the topic. The format of the message depends on the notification protocol
|
|
435
|
-
* for each subscribed endpoint.</p>
|
|
436
|
-
* <p>When a <code>messageId</code> is returned, the message is saved and Amazon SNS immediately
|
|
437
|
-
* delivers it to subscribers.</p>
|
|
438
|
-
* <p>To use the <code>Publish</code> action for publishing a message to a mobile endpoint,
|
|
439
|
-
* such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for
|
|
440
|
-
* the TargetArn parameter. The EndpointArn is returned when making a call with the
|
|
441
|
-
* <code>CreatePlatformEndpoint</code> action. </p>
|
|
442
|
-
* <p>For more information about formatting messages, see <a href="https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html">Send Custom
|
|
443
|
-
* Platform-Specific Payloads in Messages to Mobile Devices</a>. </p>
|
|
444
|
-
* <important>
|
|
445
|
-
* <p>You can publish messages only to topics and endpoints in the same
|
|
446
|
-
* Amazon Web Services Region.</p>
|
|
447
|
-
* </important>
|
|
215
|
+
* @see {@link PublishCommand}
|
|
448
216
|
*/
|
|
449
217
|
publish(args: PublishCommandInput, options?: __HttpHandlerOptions): Promise<PublishCommandOutput>;
|
|
450
218
|
publish(args: PublishCommandInput, cb: (err: any, data?: PublishCommandOutput) => void): void;
|
|
451
219
|
publish(args: PublishCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishCommandOutput) => void): void;
|
|
452
220
|
/**
|
|
453
|
-
* @
|
|
454
|
-
* <p>Publishes up to ten messages to the specified topic. This is a batch version of
|
|
455
|
-
* <code>Publish</code>. For FIFO topics, multiple messages within a single batch are
|
|
456
|
-
* published in the order they are sent, and messages are deduplicated within the batch and
|
|
457
|
-
* across batches for 5 minutes.</p>
|
|
458
|
-
* <p>The result of publishing each message is reported individually in the response.
|
|
459
|
-
* Because the batch request can result in a combination of successful and unsuccessful
|
|
460
|
-
* actions, you should check for batch errors even when the call returns an HTTP status
|
|
461
|
-
* code of <code>200</code>.</p>
|
|
462
|
-
* <p>The maximum allowed individual message size and the maximum total payload size (the
|
|
463
|
-
* sum of the individual lengths of all of the batched messages) are both 256 KB (262,144
|
|
464
|
-
* bytes). </p>
|
|
465
|
-
* <p>Some actions take lists of parameters. These lists are specified using the
|
|
466
|
-
* <code>param.n</code> notation. Values of <code>n</code> are integers starting from
|
|
467
|
-
* 1. For example, a parameter list with two elements looks like this: </p>
|
|
468
|
-
* <p>&AttributeName.1=first</p>
|
|
469
|
-
* <p>&AttributeName.2=second</p>
|
|
470
|
-
* <p>If you send a batch message to a topic, Amazon SNS publishes the batch message to each
|
|
471
|
-
* endpoint that is subscribed to the topic. The format of the batch message depends on the
|
|
472
|
-
* notification protocol for each subscribed endpoint.</p>
|
|
473
|
-
* <p>When a <code>messageId</code> is returned, the batch message is saved and Amazon SNS
|
|
474
|
-
* immediately delivers the message to subscribers.</p>
|
|
221
|
+
* @see {@link PublishBatchCommand}
|
|
475
222
|
*/
|
|
476
223
|
publishBatch(args: PublishBatchCommandInput, options?: __HttpHandlerOptions): Promise<PublishBatchCommandOutput>;
|
|
477
224
|
publishBatch(args: PublishBatchCommandInput, cb: (err: any, data?: PublishBatchCommandOutput) => void): void;
|
|
478
225
|
publishBatch(args: PublishBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishBatchCommandOutput) => void): void;
|
|
479
226
|
/**
|
|
480
|
-
* @
|
|
481
|
-
* <p>Adds or updates an inline policy document that is stored in the specified Amazon SNS
|
|
482
|
-
* topic.</p>
|
|
227
|
+
* @see {@link PutDataProtectionPolicyCommand}
|
|
483
228
|
*/
|
|
484
229
|
putDataProtectionPolicy(args: PutDataProtectionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutDataProtectionPolicyCommandOutput>;
|
|
485
230
|
putDataProtectionPolicy(args: PutDataProtectionPolicyCommandInput, cb: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void): void;
|
|
486
231
|
putDataProtectionPolicy(args: PutDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void): void;
|
|
487
232
|
/**
|
|
488
|
-
* @
|
|
489
|
-
* <p>Removes a statement from a topic's access control policy.</p>
|
|
490
|
-
* <note>
|
|
491
|
-
* <p>To remove the ability to change topic permissions, you must deny permissions to
|
|
492
|
-
* the <code>AddPermission</code>, <code>RemovePermission</code>, and
|
|
493
|
-
* <code>SetTopicAttributes</code> actions in your IAM policy.</p>
|
|
494
|
-
* </note>
|
|
233
|
+
* @see {@link RemovePermissionCommand}
|
|
495
234
|
*/
|
|
496
235
|
removePermission(args: RemovePermissionCommandInput, options?: __HttpHandlerOptions): Promise<RemovePermissionCommandOutput>;
|
|
497
236
|
removePermission(args: RemovePermissionCommandInput, cb: (err: any, data?: RemovePermissionCommandOutput) => void): void;
|
|
498
237
|
removePermission(args: RemovePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemovePermissionCommandOutput) => void): void;
|
|
499
238
|
/**
|
|
500
|
-
* @
|
|
501
|
-
* <p>Sets the attributes for an endpoint for a device on one of the supported push
|
|
502
|
-
* notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more
|
|
503
|
-
* information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </p>
|
|
239
|
+
* @see {@link SetEndpointAttributesCommand}
|
|
504
240
|
*/
|
|
505
241
|
setEndpointAttributes(args: SetEndpointAttributesCommandInput, options?: __HttpHandlerOptions): Promise<SetEndpointAttributesCommandOutput>;
|
|
506
242
|
setEndpointAttributes(args: SetEndpointAttributesCommandInput, cb: (err: any, data?: SetEndpointAttributesCommandOutput) => void): void;
|
|
507
243
|
setEndpointAttributes(args: SetEndpointAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetEndpointAttributesCommandOutput) => void): void;
|
|
508
244
|
/**
|
|
509
|
-
* @
|
|
510
|
-
* <p>Sets the attributes of the platform application object for the supported push
|
|
511
|
-
* notification services, such as APNS and GCM (Firebase Cloud Messaging). For more
|
|
512
|
-
* information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. For information on configuring
|
|
513
|
-
* attributes for message delivery status, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html">Using Amazon SNS Application Attributes for
|
|
514
|
-
* Message Delivery Status</a>. </p>
|
|
245
|
+
* @see {@link SetPlatformApplicationAttributesCommand}
|
|
515
246
|
*/
|
|
516
247
|
setPlatformApplicationAttributes(args: SetPlatformApplicationAttributesCommandInput, options?: __HttpHandlerOptions): Promise<SetPlatformApplicationAttributesCommandOutput>;
|
|
517
248
|
setPlatformApplicationAttributes(args: SetPlatformApplicationAttributesCommandInput, cb: (err: any, data?: SetPlatformApplicationAttributesCommandOutput) => void): void;
|
|
518
249
|
setPlatformApplicationAttributes(args: SetPlatformApplicationAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetPlatformApplicationAttributesCommandOutput) => void): void;
|
|
519
250
|
/**
|
|
520
|
-
* @
|
|
521
|
-
* <p>Use this request to set the default settings for sending SMS messages and receiving
|
|
522
|
-
* daily SMS usage reports.</p>
|
|
523
|
-
* <p>You can override some of these settings for a single message when you use the
|
|
524
|
-
* <code>Publish</code> action with the <code>MessageAttributes.entry.N</code>
|
|
525
|
-
* parameter. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html">Publishing to a mobile phone</a>
|
|
526
|
-
* in the <i>Amazon SNS Developer Guide</i>.</p>
|
|
527
|
-
* <note>
|
|
528
|
-
* <p>To use this operation, you must grant the Amazon SNS service principal
|
|
529
|
-
* (<code>sns.amazonaws.com</code>) permission to perform the
|
|
530
|
-
* <code>s3:ListBucket</code> action. </p>
|
|
531
|
-
* </note>
|
|
251
|
+
* @see {@link SetSMSAttributesCommand}
|
|
532
252
|
*/
|
|
533
253
|
setSMSAttributes(args: SetSMSAttributesCommandInput, options?: __HttpHandlerOptions): Promise<SetSMSAttributesCommandOutput>;
|
|
534
254
|
setSMSAttributes(args: SetSMSAttributesCommandInput, cb: (err: any, data?: SetSMSAttributesCommandOutput) => void): void;
|
|
535
255
|
setSMSAttributes(args: SetSMSAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetSMSAttributesCommandOutput) => void): void;
|
|
536
256
|
/**
|
|
537
|
-
* @
|
|
538
|
-
* <p>Allows a subscription owner to set an attribute of the subscription to a new
|
|
539
|
-
* value.</p>
|
|
257
|
+
* @see {@link SetSubscriptionAttributesCommand}
|
|
540
258
|
*/
|
|
541
259
|
setSubscriptionAttributes(args: SetSubscriptionAttributesCommandInput, options?: __HttpHandlerOptions): Promise<SetSubscriptionAttributesCommandOutput>;
|
|
542
260
|
setSubscriptionAttributes(args: SetSubscriptionAttributesCommandInput, cb: (err: any, data?: SetSubscriptionAttributesCommandOutput) => void): void;
|
|
543
261
|
setSubscriptionAttributes(args: SetSubscriptionAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetSubscriptionAttributesCommandOutput) => void): void;
|
|
544
262
|
/**
|
|
545
|
-
* @
|
|
546
|
-
* <p>Allows a topic owner to set an attribute of the topic to a new value.</p>
|
|
547
|
-
* <note>
|
|
548
|
-
* <p>To remove the ability to change topic permissions, you must deny permissions to
|
|
549
|
-
* the <code>AddPermission</code>, <code>RemovePermission</code>, and
|
|
550
|
-
* <code>SetTopicAttributes</code> actions in your IAM policy.</p>
|
|
551
|
-
* </note>
|
|
263
|
+
* @see {@link SetTopicAttributesCommand}
|
|
552
264
|
*/
|
|
553
265
|
setTopicAttributes(args: SetTopicAttributesCommandInput, options?: __HttpHandlerOptions): Promise<SetTopicAttributesCommandOutput>;
|
|
554
266
|
setTopicAttributes(args: SetTopicAttributesCommandInput, cb: (err: any, data?: SetTopicAttributesCommandOutput) => void): void;
|
|
555
267
|
setTopicAttributes(args: SetTopicAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetTopicAttributesCommandOutput) => void): void;
|
|
556
268
|
/**
|
|
557
|
-
* @
|
|
558
|
-
* <p>Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or
|
|
559
|
-
* if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must
|
|
560
|
-
* run the <code>ConfirmSubscription</code> action to confirm the subscription.</p>
|
|
561
|
-
* <p>You call the <code>ConfirmSubscription</code> action with the token from the
|
|
562
|
-
* subscription response. Confirmation tokens are valid for three days.</p>
|
|
563
|
-
* <p>This action is throttled at 100 transactions per second (TPS).</p>
|
|
269
|
+
* @see {@link SubscribeCommand}
|
|
564
270
|
*/
|
|
565
271
|
subscribe(args: SubscribeCommandInput, options?: __HttpHandlerOptions): Promise<SubscribeCommandOutput>;
|
|
566
272
|
subscribe(args: SubscribeCommandInput, cb: (err: any, data?: SubscribeCommandOutput) => void): void;
|
|
567
273
|
subscribe(args: SubscribeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubscribeCommandOutput) => void): void;
|
|
568
274
|
/**
|
|
569
|
-
* @
|
|
570
|
-
* <p>Add tags to the specified Amazon SNS topic. For an overview, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html">Amazon SNS Tags</a> in the
|
|
571
|
-
* <i>Amazon SNS Developer Guide</i>.</p>
|
|
572
|
-
* <p>When you use topic tags, keep the following guidelines in mind:</p>
|
|
573
|
-
* <ul>
|
|
574
|
-
* <li>
|
|
575
|
-
* <p>Adding more than 50 tags to a topic isn't recommended.</p>
|
|
576
|
-
* </li>
|
|
577
|
-
* <li>
|
|
578
|
-
* <p>Tags don't have any semantic meaning. Amazon SNS interprets tags as character
|
|
579
|
-
* strings.</p>
|
|
580
|
-
* </li>
|
|
581
|
-
* <li>
|
|
582
|
-
* <p>Tags are case-sensitive.</p>
|
|
583
|
-
* </li>
|
|
584
|
-
* <li>
|
|
585
|
-
* <p>A new tag with a key identical to that of an existing tag overwrites the
|
|
586
|
-
* existing tag.</p>
|
|
587
|
-
* </li>
|
|
588
|
-
* <li>
|
|
589
|
-
* <p>Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If
|
|
590
|
-
* your application requires a higher throughput, file a <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=technical">technical support request</a>.</p>
|
|
591
|
-
* </li>
|
|
592
|
-
* </ul>
|
|
275
|
+
* @see {@link TagResourceCommand}
|
|
593
276
|
*/
|
|
594
277
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
595
278
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
596
279
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
597
280
|
/**
|
|
598
|
-
* @
|
|
599
|
-
* <p>Deletes a subscription. If the subscription requires authentication for deletion, only
|
|
600
|
-
* the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services
|
|
601
|
-
* signature is required. If the <code>Unsubscribe</code> call does not require
|
|
602
|
-
* authentication and the requester is not the subscription owner, a final cancellation
|
|
603
|
-
* message is delivered to the endpoint, so that the endpoint owner can easily resubscribe
|
|
604
|
-
* to the topic if the <code>Unsubscribe</code> request was unintended.</p>
|
|
605
|
-
* <note>
|
|
606
|
-
* <p>Amazon SQS queue subscriptions require authentication for deletion. Only the owner of
|
|
607
|
-
* the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services
|
|
608
|
-
* signature.</p>
|
|
609
|
-
* </note>
|
|
610
|
-
* <p>This action is throttled at 100 transactions per second (TPS).</p>
|
|
281
|
+
* @see {@link UnsubscribeCommand}
|
|
611
282
|
*/
|
|
612
283
|
unsubscribe(args: UnsubscribeCommandInput, options?: __HttpHandlerOptions): Promise<UnsubscribeCommandOutput>;
|
|
613
284
|
unsubscribe(args: UnsubscribeCommandInput, cb: (err: any, data?: UnsubscribeCommandOutput) => void): void;
|
|
614
285
|
unsubscribe(args: UnsubscribeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnsubscribeCommandOutput) => void): void;
|
|
615
286
|
/**
|
|
616
|
-
* @
|
|
617
|
-
* <p>Remove tags from the specified Amazon SNS topic. For an overview, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html">Amazon SNS Tags</a> in the
|
|
618
|
-
* <i>Amazon SNS Developer Guide</i>.</p>
|
|
287
|
+
* @see {@link UntagResourceCommand}
|
|
619
288
|
*/
|
|
620
289
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
621
290
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
622
291
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
623
292
|
/**
|
|
624
|
-
* @
|
|
625
|
-
* <p>Verifies a destination phone number with a one-time password (OTP) for the calling
|
|
626
|
-
* Amazon Web Services account.</p>
|
|
627
|
-
* <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
|
|
628
|
-
* <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
|
|
629
|
-
* you to try Amazon SNS features without risking your reputation as an SMS sender. While your
|
|
630
|
-
* Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send
|
|
631
|
-
* SMS messages only to verified destination phone numbers. For more information, including how to
|
|
632
|
-
* move out of the sandbox to send messages without restrictions,
|
|
633
|
-
* see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in
|
|
634
|
-
* the <i>Amazon SNS Developer Guide</i>.</p>
|
|
293
|
+
* @see {@link VerifySMSSandboxPhoneNumberCommand}
|
|
635
294
|
*/
|
|
636
295
|
verifySMSSandboxPhoneNumber(args: VerifySMSSandboxPhoneNumberCommandInput, options?: __HttpHandlerOptions): Promise<VerifySMSSandboxPhoneNumberCommandOutput>;
|
|
637
296
|
verifySMSSandboxPhoneNumber(args: VerifySMSSandboxPhoneNumberCommandInput, cb: (err: any, data?: VerifySMSSandboxPhoneNumberCommandOutput) => void): void;
|
|
638
297
|
verifySMSSandboxPhoneNumber(args: VerifySMSSandboxPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifySMSSandboxPhoneNumberCommandOutput) => void): void;
|
|
639
298
|
}
|
|
299
|
+
/**
|
|
300
|
+
* @public
|
|
301
|
+
* <fullname>Amazon Simple Notification Service</fullname>
|
|
302
|
+
* <p>Amazon Simple Notification Service (Amazon SNS) is a web service that enables you
|
|
303
|
+
* to build distributed web-enabled applications. Applications can use Amazon SNS to easily push
|
|
304
|
+
* real-time notification messages to interested subscribers over multiple delivery
|
|
305
|
+
* protocols. For more information about this product see the <a href="http://aws.amazon.com/sns/">Amazon SNS product page</a>. For detailed information about Amazon SNS features
|
|
306
|
+
* and their associated API calls, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/">Amazon SNS Developer Guide</a>. </p>
|
|
307
|
+
* <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-authentication-and-access-control.html">Identity and access management in Amazon SNS</a> in the <i>Amazon SNS Developer
|
|
308
|
+
* Guide.</i>
|
|
309
|
+
* </p>
|
|
310
|
+
* <p>We also provide SDKs that enable you to access Amazon SNS from your preferred programming
|
|
311
|
+
* language. The SDKs contain functionality that automatically takes care of tasks such as:
|
|
312
|
+
* cryptographically signing your service requests, retrying requests, and handling error
|
|
313
|
+
* responses. For a list of available SDKs, go to <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>. </p>
|
|
314
|
+
*/
|
|
315
|
+
export declare class SNS extends SNSClient implements SNS {
|
|
316
|
+
}
|