@aws-sdk/client-sns 3.218.0 → 3.223.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/README.md CHANGED
@@ -11,8 +11,8 @@ AWS SDK for JavaScript SNS Client for Node.js, Browser and React Native.
11
11
 
12
12
  <fullname>Amazon Simple Notification Service</fullname>
13
13
 
14
- <p>Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build
15
- distributed web-enabled applications. Applications can use Amazon SNS to easily push
14
+ <p>Amazon Simple Notification Service (Amazon SNS) is a web service that enables you
15
+ to build distributed web-enabled applications. Applications can use Amazon SNS to easily push
16
16
  real-time notification messages to interested subscribers over multiple delivery
17
17
  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
18
18
  and their associated API calls, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/">Amazon SNS Developer Guide</a>. </p>
@@ -239,12 +239,12 @@ exports.ruleSet = {
239
239
  {
240
240
  ref: "Region",
241
241
  },
242
- "us-gov-west-1",
242
+ "us-gov-east-1",
243
243
  ],
244
244
  },
245
245
  ],
246
246
  endpoint: {
247
- url: "https://sns.us-gov-west-1.amazonaws.com",
247
+ url: "https://sns.us-gov-east-1.amazonaws.com",
248
248
  properties: {},
249
249
  headers: {},
250
250
  },
@@ -258,12 +258,12 @@ exports.ruleSet = {
258
258
  {
259
259
  ref: "Region",
260
260
  },
261
- "us-gov-east-1",
261
+ "us-gov-west-1",
262
262
  ],
263
263
  },
264
264
  ],
265
265
  endpoint: {
266
- url: "https://sns.us-gov-east-1.amazonaws.com",
266
+ url: "https://sns.us-gov-west-1.amazonaws.com",
267
267
  properties: {},
268
268
  headers: {},
269
269
  },
@@ -236,12 +236,12 @@ export const ruleSet = {
236
236
  {
237
237
  ref: "Region",
238
238
  },
239
- "us-gov-west-1",
239
+ "us-gov-east-1",
240
240
  ],
241
241
  },
242
242
  ],
243
243
  endpoint: {
244
- url: "https://sns.us-gov-west-1.amazonaws.com",
244
+ url: "https://sns.us-gov-east-1.amazonaws.com",
245
245
  properties: {},
246
246
  headers: {},
247
247
  },
@@ -255,12 +255,12 @@ export const ruleSet = {
255
255
  {
256
256
  ref: "Region",
257
257
  },
258
- "us-gov-east-1",
258
+ "us-gov-west-1",
259
259
  ],
260
260
  },
261
261
  ],
262
262
  endpoint: {
263
- url: "https://sns.us-gov-east-1.amazonaws.com",
263
+ url: "https://sns.us-gov-west-1.amazonaws.com",
264
264
  properties: {},
265
265
  headers: {},
266
266
  },
@@ -44,8 +44,8 @@ import { VerifySMSSandboxPhoneNumberCommandInput, VerifySMSSandboxPhoneNumberCom
44
44
  import { SNSClient } from "./SNSClient";
45
45
  /**
46
46
  * <fullname>Amazon Simple Notification Service</fullname>
47
- * <p>Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build
48
- * distributed web-enabled applications. Applications can use Amazon SNS to easily push
47
+ * <p>Amazon Simple Notification Service (Amazon SNS) is a web service that enables you
48
+ * to build distributed web-enabled applications. Applications can use Amazon SNS to easily push
49
49
  * real-time notification messages to interested subscribers over multiple delivery
50
50
  * 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
51
51
  * and their associated API calls, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/">Amazon SNS Developer Guide</a>. </p>
@@ -61,14 +61,19 @@ export declare class SNS extends SNSClient {
61
61
  /**
62
62
  * <p>Adds a statement to a topic's access control policy, granting access for the specified
63
63
  * Amazon Web Services accounts to the specified actions.</p>
64
+ * <note>
65
+ * <p>To remove the ability to change topic permissions, you must deny permissions to
66
+ * the <code>AddPermission</code>, <code>RemovePermission</code>, and
67
+ * <code>SetTopicAttributes</code> actions in your IAM policy.</p>
68
+ * </note>
64
69
  */
65
70
  addPermission(args: AddPermissionCommandInput, options?: __HttpHandlerOptions): Promise<AddPermissionCommandOutput>;
66
71
  addPermission(args: AddPermissionCommandInput, cb: (err: any, data?: AddPermissionCommandOutput) => void): void;
67
72
  addPermission(args: AddPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddPermissionCommandOutput) => void): void;
68
73
  /**
69
74
  * <p>Accepts a phone number and indicates whether the phone holder has opted out of
70
- * receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that
71
- * is opted out.</p>
75
+ * receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number
76
+ * that is opted out.</p>
72
77
  * <p>To resume sending messages, you can opt in the number by using the
73
78
  * <code>OptInPhoneNumber</code> action.</p>
74
79
  */
@@ -104,14 +109,14 @@ export declare class SNS extends SNSClient {
104
109
  * and <code>PlatformCredential</code> is <code>secret key</code>.</p>
105
110
  * </li>
106
111
  * <li>
107
- * <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using certificate credentials,
108
- * <code>PlatformPrincipal</code> is <code>SSL certificate</code> and
112
+ * <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using certificate
113
+ * credentials, <code>PlatformPrincipal</code> is <code>SSL certificate</code> and
109
114
  * <code>PlatformCredential</code> is <code>private key</code>.</p>
110
115
  * </li>
111
116
  * <li>
112
117
  * <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using token credentials,
113
- * <code>PlatformPrincipal</code> is <code>signing key ID</code> and
114
- * <code>PlatformCredential</code> is <code>signing key</code>.</p>
118
+ * <code>PlatformPrincipal</code> is <code>signing key ID</code> and
119
+ * <code>PlatformCredential</code> is <code>signing key</code>.</p>
115
120
  * </li>
116
121
  * <li>
117
122
  * <p>For <code>GCM</code> (Firebase Cloud Messaging), there is no
@@ -148,8 +153,8 @@ export declare class SNS extends SNSClient {
148
153
  * Notifications</a>. </p>
149
154
  * <p>When using <code>CreatePlatformEndpoint</code> with Baidu, two attributes must be
150
155
  * provided: ChannelId and UserId. The token field must also contain the ChannelId. For
151
- * more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html">Creating an Amazon SNS Endpoint
152
- * for Baidu</a>. </p>
156
+ * more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html">Creating an Amazon SNS Endpoint for
157
+ * Baidu</a>. </p>
153
158
  */
154
159
  createPlatformEndpoint(args: CreatePlatformEndpointCommandInput, options?: __HttpHandlerOptions): Promise<CreatePlatformEndpointCommandOutput>;
155
160
  createPlatformEndpoint(args: CreatePlatformEndpointCommandInput, cb: (err: any, data?: CreatePlatformEndpointCommandOutput) => void): void;
@@ -199,7 +204,8 @@ export declare class SNS extends SNSClient {
199
204
  deletePlatformApplication(args: DeletePlatformApplicationCommandInput, cb: (err: any, data?: DeletePlatformApplicationCommandOutput) => void): void;
200
205
  deletePlatformApplication(args: DeletePlatformApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePlatformApplicationCommandOutput) => void): void;
201
206
  /**
202
- * <p>Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.</p>
207
+ * <p>Deletes an Amazon Web Services account's verified or pending phone number from the SMS
208
+ * sandbox.</p>
203
209
  * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
204
210
  * <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
205
211
  * you to try Amazon SNS features without risking your reputation as an SMS sender. While your
@@ -222,7 +228,8 @@ export declare class SNS extends SNSClient {
222
228
  deleteTopic(args: DeleteTopicCommandInput, cb: (err: any, data?: DeleteTopicCommandOutput) => void): void;
223
229
  deleteTopic(args: DeleteTopicCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTopicCommandOutput) => void): void;
224
230
  /**
225
- * <p>Retrieves the specified inline <code>DataProtectionPolicy</code> document that is stored in the specified Amazon SNS topic. </p>
231
+ * <p>Retrieves the specified inline <code>DataProtectionPolicy</code> document that is
232
+ * stored in the specified Amazon SNS topic. </p>
226
233
  */
227
234
  getDataProtectionPolicy(args: GetDataProtectionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetDataProtectionPolicyCommandOutput>;
228
235
  getDataProtectionPolicy(args: GetDataProtectionPolicyCommandInput, cb: (err: any, data?: GetDataProtectionPolicyCommandOutput) => void): void;
@@ -251,7 +258,8 @@ export declare class SNS extends SNSClient {
251
258
  getSMSAttributes(args: GetSMSAttributesCommandInput, cb: (err: any, data?: GetSMSAttributesCommandOutput) => void): void;
252
259
  getSMSAttributes(args: GetSMSAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSMSAttributesCommandOutput) => void): void;
253
260
  /**
254
- * <p>Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.</p>
261
+ * <p>Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target
262
+ * Amazon Web Services Region.</p>
255
263
  * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
256
264
  * <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
257
265
  * you to try Amazon SNS features without risking your reputation as an SMS sender. While your
@@ -293,8 +301,8 @@ export declare class SNS extends SNSClient {
293
301
  listEndpointsByPlatformApplication(args: ListEndpointsByPlatformApplicationCommandInput, cb: (err: any, data?: ListEndpointsByPlatformApplicationCommandOutput) => void): void;
294
302
  listEndpointsByPlatformApplication(args: ListEndpointsByPlatformApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEndpointsByPlatformApplicationCommandOutput) => void): void;
295
303
  /**
296
- * <p>Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For
297
- * 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
304
+ * <p>Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata.
305
+ * 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
298
306
  * Guide</i>.</p>
299
307
  */
300
308
  listOriginationNumbers(args: ListOriginationNumbersCommandInput, options?: __HttpHandlerOptions): Promise<ListOriginationNumbersCommandOutput>;
@@ -329,8 +337,8 @@ export declare class SNS extends SNSClient {
329
337
  listPlatformApplications(args: ListPlatformApplicationsCommandInput, cb: (err: any, data?: ListPlatformApplicationsCommandOutput) => void): void;
330
338
  listPlatformApplications(args: ListPlatformApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPlatformApplicationsCommandOutput) => void): void;
331
339
  /**
332
- * <p>Lists the calling Amazon Web Services account's current verified and pending destination phone numbers
333
- * in the SMS sandbox.</p>
340
+ * <p>Lists the calling Amazon Web Services account's current verified and pending destination phone
341
+ * numbers in the SMS sandbox.</p>
334
342
  * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
335
343
  * <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
336
344
  * you to try Amazon SNS features without risking your reputation as an SMS sender. While your
@@ -395,8 +403,8 @@ export declare class SNS extends SNSClient {
395
403
  * <p>If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is
396
404
  * subscribed to the topic. The format of the message depends on the notification protocol
397
405
  * for each subscribed endpoint.</p>
398
- * <p>When a <code>messageId</code> is returned, the message is saved and Amazon SNS
399
- * immediately delivers it to subscribers.</p>
406
+ * <p>When a <code>messageId</code> is returned, the message is saved and Amazon SNS immediately
407
+ * delivers it to subscribers.</p>
400
408
  * <p>To use the <code>Publish</code> action for publishing a message to a mobile endpoint,
401
409
  * such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for
402
410
  * the TargetArn parameter. The EndpointArn is returned when making a call with the
@@ -404,35 +412,53 @@ export declare class SNS extends SNSClient {
404
412
  * <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
405
413
  * Platform-Specific Payloads in Messages to Mobile Devices</a>. </p>
406
414
  * <important>
407
- * <p>You can publish messages only to topics and endpoints in the same Amazon Web Services Region.</p>
415
+ * <p>You can publish messages only to topics and endpoints in the same
416
+ * Amazon Web Services Region.</p>
408
417
  * </important>
409
418
  */
410
419
  publish(args: PublishCommandInput, options?: __HttpHandlerOptions): Promise<PublishCommandOutput>;
411
420
  publish(args: PublishCommandInput, cb: (err: any, data?: PublishCommandOutput) => void): void;
412
421
  publish(args: PublishCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishCommandOutput) => void): void;
413
422
  /**
414
- * <p>Publishes up to ten messages to the specified topic. This is a batch version of <code>Publish</code>. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.</p>
415
- * <p>The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of <code>200</code>.</p>
416
- * <p>The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes). </p>
417
- * <p>Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </p>
418
- * <p>&AttributeName.1=first</p>
419
- * <p>&AttributeName.2=second</p>
420
- * <p>If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is
421
- * subscribed to the topic. The format of the batch message depends on the notification protocol
422
- * for each subscribed endpoint.</p>
423
- * <p>When a <code>messageId</code> is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers.</p>
423
+ * <p>Publishes up to ten messages to the specified topic. This is a batch version of
424
+ * <code>Publish</code>. For FIFO topics, multiple messages within a single batch are
425
+ * published in the order they are sent, and messages are deduplicated within the batch and
426
+ * across batches for 5 minutes.</p>
427
+ * <p>The result of publishing each message is reported individually in the response.
428
+ * Because the batch request can result in a combination of successful and unsuccessful
429
+ * actions, you should check for batch errors even when the call returns an HTTP status
430
+ * code of <code>200</code>.</p>
431
+ * <p>The maximum allowed individual message size and the maximum total payload size (the
432
+ * sum of the individual lengths of all of the batched messages) are both 256 KB (262,144
433
+ * bytes). </p>
434
+ * <p>Some actions take lists of parameters. These lists are specified using the
435
+ * <code>param.n</code> notation. Values of <code>n</code> are integers starting from
436
+ * 1. For example, a parameter list with two elements looks like this: </p>
437
+ * <p>&AttributeName.1=first</p>
438
+ * <p>&AttributeName.2=second</p>
439
+ * <p>If you send a batch message to a topic, Amazon SNS publishes the batch message to each
440
+ * endpoint that is subscribed to the topic. The format of the batch message depends on the
441
+ * notification protocol for each subscribed endpoint.</p>
442
+ * <p>When a <code>messageId</code> is returned, the batch message is saved and Amazon SNS
443
+ * immediately delivers the message to subscribers.</p>
424
444
  */
425
445
  publishBatch(args: PublishBatchCommandInput, options?: __HttpHandlerOptions): Promise<PublishBatchCommandOutput>;
426
446
  publishBatch(args: PublishBatchCommandInput, cb: (err: any, data?: PublishBatchCommandOutput) => void): void;
427
447
  publishBatch(args: PublishBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishBatchCommandOutput) => void): void;
428
448
  /**
429
- * <p>Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.</p>
449
+ * <p>Adds or updates an inline policy document that is stored in the specified Amazon SNS
450
+ * topic.</p>
430
451
  */
431
452
  putDataProtectionPolicy(args: PutDataProtectionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutDataProtectionPolicyCommandOutput>;
432
453
  putDataProtectionPolicy(args: PutDataProtectionPolicyCommandInput, cb: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void): void;
433
454
  putDataProtectionPolicy(args: PutDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void): void;
434
455
  /**
435
456
  * <p>Removes a statement from a topic's access control policy.</p>
457
+ * <note>
458
+ * <p>To remove the ability to change topic permissions, you must deny permissions to
459
+ * the <code>AddPermission</code>, <code>RemovePermission</code>, and
460
+ * <code>SetTopicAttributes</code> actions in your IAM policy.</p>
461
+ * </note>
436
462
  */
437
463
  removePermission(args: RemovePermissionCommandInput, options?: __HttpHandlerOptions): Promise<RemovePermissionCommandOutput>;
438
464
  removePermission(args: RemovePermissionCommandInput, cb: (err: any, data?: RemovePermissionCommandOutput) => void): void;
@@ -480,6 +506,11 @@ export declare class SNS extends SNSClient {
480
506
  setSubscriptionAttributes(args: SetSubscriptionAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetSubscriptionAttributesCommandOutput) => void): void;
481
507
  /**
482
508
  * <p>Allows a topic owner to set an attribute of the topic to a new value.</p>
509
+ * <note>
510
+ * <p>To remove the ability to change topic permissions, you must deny permissions to
511
+ * the <code>AddPermission</code>, <code>RemovePermission</code>, and
512
+ * <code>SetTopicAttributes</code> actions in your IAM policy.</p>
513
+ * </note>
483
514
  */
484
515
  setTopicAttributes(args: SetTopicAttributesCommandInput, options?: __HttpHandlerOptions): Promise<SetTopicAttributesCommandOutput>;
485
516
  setTopicAttributes(args: SetTopicAttributesCommandInput, cb: (err: any, data?: SetTopicAttributesCommandOutput) => void): void;
@@ -515,8 +546,8 @@ export declare class SNS extends SNSClient {
515
546
  * existing tag.</p>
516
547
  * </li>
517
548
  * <li>
518
- * <p>Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If your
519
- * 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>
549
+ * <p>Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If
550
+ * 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>
520
551
  * </li>
521
552
  * </ul>
522
553
  */
@@ -525,11 +556,16 @@ export declare class SNS extends SNSClient {
525
556
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
526
557
  /**
527
558
  * <p>Deletes a subscription. If the subscription requires authentication for deletion, only
528
- * the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services signature
529
- * is required. If the <code>Unsubscribe</code> call does not require authentication and
530
- * the requester is not the subscription owner, a final cancellation message is delivered
531
- * to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the
532
- * <code>Unsubscribe</code> request was unintended.</p>
559
+ * the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services
560
+ * signature is required. If the <code>Unsubscribe</code> call does not require
561
+ * authentication and the requester is not the subscription owner, a final cancellation
562
+ * message is delivered to the endpoint, so that the endpoint owner can easily resubscribe
563
+ * to the topic if the <code>Unsubscribe</code> request was unintended.</p>
564
+ * <note>
565
+ * <p>Amazon SQS queue subscriptions require authentication for deletion. Only the owner of
566
+ * the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services
567
+ * signature.</p>
568
+ * </note>
533
569
  * <p>This action is throttled at 100 transactions per second (TPS).</p>
534
570
  */
535
571
  unsubscribe(args: UnsubscribeCommandInput, options?: __HttpHandlerOptions): Promise<UnsubscribeCommandOutput>;
@@ -543,7 +579,8 @@ export declare class SNS extends SNSClient {
543
579
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
544
580
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
545
581
  /**
546
- * <p>Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.</p>
582
+ * <p>Verifies a destination phone number with a one-time password (OTP) for the calling
583
+ * Amazon Web Services account.</p>
547
584
  * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
548
585
  * <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
549
586
  * you to try Amazon SNS features without risking your reputation as an SMS sender. While your
@@ -166,8 +166,8 @@ export interface SNSClientResolvedConfig extends SNSClientResolvedConfigType {
166
166
  }
167
167
  /**
168
168
  * <fullname>Amazon Simple Notification Service</fullname>
169
- * <p>Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build
170
- * distributed web-enabled applications. Applications can use Amazon SNS to easily push
169
+ * <p>Amazon Simple Notification Service (Amazon SNS) is a web service that enables you
170
+ * to build distributed web-enabled applications. Applications can use Amazon SNS to easily push
171
171
  * real-time notification messages to interested subscribers over multiple delivery
172
172
  * 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
173
173
  * and their associated API calls, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/">Amazon SNS Developer Guide</a>. </p>
@@ -10,6 +10,11 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {
10
10
  /**
11
11
  * <p>Adds a statement to a topic's access control policy, granting access for the specified
12
12
  * Amazon Web Services accounts to the specified actions.</p>
13
+ * <note>
14
+ * <p>To remove the ability to change topic permissions, you must deny permissions to
15
+ * the <code>AddPermission</code>, <code>RemovePermission</code>, and
16
+ * <code>SetTopicAttributes</code> actions in your IAM policy.</p>
17
+ * </note>
13
18
  * @example
14
19
  * Use a bare-bones client and the command you need to make an API call.
15
20
  * ```javascript
@@ -9,8 +9,8 @@ export interface CheckIfPhoneNumberIsOptedOutCommandOutput extends CheckIfPhoneN
9
9
  }
10
10
  /**
11
11
  * <p>Accepts a phone number and indicates whether the phone holder has opted out of
12
- * receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that
13
- * is opted out.</p>
12
+ * receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number
13
+ * that is opted out.</p>
14
14
  * <p>To resume sending messages, you can opt in the number by using the
15
15
  * <code>OptInPhoneNumber</code> action.</p>
16
16
  * @example
@@ -26,14 +26,14 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp
26
26
  * and <code>PlatformCredential</code> is <code>secret key</code>.</p>
27
27
  * </li>
28
28
  * <li>
29
- * <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using certificate credentials,
30
- * <code>PlatformPrincipal</code> is <code>SSL certificate</code> and
29
+ * <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using certificate
30
+ * credentials, <code>PlatformPrincipal</code> is <code>SSL certificate</code> and
31
31
  * <code>PlatformCredential</code> is <code>private key</code>.</p>
32
32
  * </li>
33
33
  * <li>
34
34
  * <p>For <code>APNS</code> and <code>APNS_SANDBOX</code> using token credentials,
35
- * <code>PlatformPrincipal</code> is <code>signing key ID</code> and
36
- * <code>PlatformCredential</code> is <code>signing key</code>.</p>
35
+ * <code>PlatformPrincipal</code> is <code>signing key ID</code> and
36
+ * <code>PlatformCredential</code> is <code>signing key</code>.</p>
37
37
  * </li>
38
38
  * <li>
39
39
  * <p>For <code>GCM</code> (Firebase Cloud Messaging), there is no
@@ -20,8 +20,8 @@ export interface CreatePlatformEndpointCommandOutput extends CreateEndpointRespo
20
20
  * Notifications</a>. </p>
21
21
  * <p>When using <code>CreatePlatformEndpoint</code> with Baidu, two attributes must be
22
22
  * provided: ChannelId and UserId. The token field must also contain the ChannelId. For
23
- * more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html">Creating an Amazon SNS Endpoint
24
- * for Baidu</a>. </p>
23
+ * more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html">Creating an Amazon SNS Endpoint for
24
+ * Baidu</a>. </p>
25
25
  * @example
26
26
  * Use a bare-bones client and the command you need to make an API call.
27
27
  * ```javascript
@@ -8,7 +8,8 @@ export interface DeleteSMSSandboxPhoneNumberCommandInput extends DeleteSMSSandbo
8
8
  export interface DeleteSMSSandboxPhoneNumberCommandOutput extends DeleteSMSSandboxPhoneNumberResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.</p>
11
+ * <p>Deletes an Amazon Web Services account's verified or pending phone number from the SMS
12
+ * sandbox.</p>
12
13
  * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
13
14
  * <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
14
15
  * you to try Amazon SNS features without risking your reputation as an SMS sender. While your
@@ -8,7 +8,8 @@ export interface GetDataProtectionPolicyCommandInput extends GetDataProtectionPo
8
8
  export interface GetDataProtectionPolicyCommandOutput extends GetDataProtectionPolicyResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Retrieves the specified inline <code>DataProtectionPolicy</code> document that is stored in the specified Amazon SNS topic. </p>
11
+ * <p>Retrieves the specified inline <code>DataProtectionPolicy</code> document that is
12
+ * stored in the specified Amazon SNS topic. </p>
12
13
  * @example
13
14
  * Use a bare-bones client and the command you need to make an API call.
14
15
  * ```javascript
@@ -8,7 +8,8 @@ export interface GetSMSSandboxAccountStatusCommandInput extends GetSMSSandboxAcc
8
8
  export interface GetSMSSandboxAccountStatusCommandOutput extends GetSMSSandboxAccountStatusResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.</p>
11
+ * <p>Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target
12
+ * Amazon Web Services Region.</p>
12
13
  * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
13
14
  * <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
14
15
  * you to try Amazon SNS features without risking your reputation as an SMS sender. While your
@@ -8,8 +8,8 @@ export interface ListOriginationNumbersCommandInput extends ListOriginationNumbe
8
8
  export interface ListOriginationNumbersCommandOutput extends ListOriginationNumbersResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For
12
- * 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
11
+ * <p>Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata.
12
+ * 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
13
13
  * Guide</i>.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
@@ -8,8 +8,8 @@ export interface ListSMSSandboxPhoneNumbersCommandInput extends ListSMSSandboxPh
8
8
  export interface ListSMSSandboxPhoneNumbersCommandOutput extends ListSMSSandboxPhoneNumbersResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Lists the calling Amazon Web Services account's current verified and pending destination phone numbers
12
- * in the SMS sandbox.</p>
11
+ * <p>Lists the calling Amazon Web Services account's current verified and pending destination phone
12
+ * numbers in the SMS sandbox.</p>
13
13
  * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
14
14
  * <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
15
15
  * you to try Amazon SNS features without risking your reputation as an SMS sender. While your
@@ -8,16 +8,27 @@ export interface PublishBatchCommandInput extends PublishBatchInput {
8
8
  export interface PublishBatchCommandOutput extends PublishBatchResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Publishes up to ten messages to the specified topic. This is a batch version of <code>Publish</code>. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.</p>
12
- * <p>The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of <code>200</code>.</p>
13
- * <p>The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes). </p>
14
- * <p>Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </p>
15
- * <p>&AttributeName.1=first</p>
16
- * <p>&AttributeName.2=second</p>
17
- * <p>If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is
18
- * subscribed to the topic. The format of the batch message depends on the notification protocol
19
- * for each subscribed endpoint.</p>
20
- * <p>When a <code>messageId</code> is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers.</p>
11
+ * <p>Publishes up to ten messages to the specified topic. This is a batch version of
12
+ * <code>Publish</code>. For FIFO topics, multiple messages within a single batch are
13
+ * published in the order they are sent, and messages are deduplicated within the batch and
14
+ * across batches for 5 minutes.</p>
15
+ * <p>The result of publishing each message is reported individually in the response.
16
+ * Because the batch request can result in a combination of successful and unsuccessful
17
+ * actions, you should check for batch errors even when the call returns an HTTP status
18
+ * code of <code>200</code>.</p>
19
+ * <p>The maximum allowed individual message size and the maximum total payload size (the
20
+ * sum of the individual lengths of all of the batched messages) are both 256 KB (262,144
21
+ * bytes). </p>
22
+ * <p>Some actions take lists of parameters. These lists are specified using the
23
+ * <code>param.n</code> notation. Values of <code>n</code> are integers starting from
24
+ * 1. For example, a parameter list with two elements looks like this: </p>
25
+ * <p>&AttributeName.1=first</p>
26
+ * <p>&AttributeName.2=second</p>
27
+ * <p>If you send a batch message to a topic, Amazon SNS publishes the batch message to each
28
+ * endpoint that is subscribed to the topic. The format of the batch message depends on the
29
+ * notification protocol for each subscribed endpoint.</p>
30
+ * <p>When a <code>messageId</code> is returned, the batch message is saved and Amazon SNS
31
+ * immediately delivers the message to subscribers.</p>
21
32
  * @example
22
33
  * Use a bare-bones client and the command you need to make an API call.
23
34
  * ```javascript
@@ -14,8 +14,8 @@ export interface PublishCommandOutput extends PublishResponse, __MetadataBearer
14
14
  * <p>If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is
15
15
  * subscribed to the topic. The format of the message depends on the notification protocol
16
16
  * for each subscribed endpoint.</p>
17
- * <p>When a <code>messageId</code> is returned, the message is saved and Amazon SNS
18
- * immediately delivers it to subscribers.</p>
17
+ * <p>When a <code>messageId</code> is returned, the message is saved and Amazon SNS immediately
18
+ * delivers it to subscribers.</p>
19
19
  * <p>To use the <code>Publish</code> action for publishing a message to a mobile endpoint,
20
20
  * such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for
21
21
  * the TargetArn parameter. The EndpointArn is returned when making a call with the
@@ -23,7 +23,8 @@ export interface PublishCommandOutput extends PublishResponse, __MetadataBearer
23
23
  * <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
24
24
  * Platform-Specific Payloads in Messages to Mobile Devices</a>. </p>
25
25
  * <important>
26
- * <p>You can publish messages only to topics and endpoints in the same Amazon Web Services Region.</p>
26
+ * <p>You can publish messages only to topics and endpoints in the same
27
+ * Amazon Web Services Region.</p>
27
28
  * </important>
28
29
  * @example
29
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -8,7 +8,8 @@ export interface PutDataProtectionPolicyCommandInput extends PutDataProtectionPo
8
8
  export interface PutDataProtectionPolicyCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.</p>
11
+ * <p>Adds or updates an inline policy document that is stored in the specified Amazon SNS
12
+ * topic.</p>
12
13
  * @example
13
14
  * Use a bare-bones client and the command you need to make an API call.
14
15
  * ```javascript
@@ -9,6 +9,11 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
11
  * <p>Removes a statement from a topic's access control policy.</p>
12
+ * <note>
13
+ * <p>To remove the ability to change topic permissions, you must deny permissions to
14
+ * the <code>AddPermission</code>, <code>RemovePermission</code>, and
15
+ * <code>SetTopicAttributes</code> actions in your IAM policy.</p>
16
+ * </note>
12
17
  * @example
13
18
  * Use a bare-bones client and the command you need to make an API call.
14
19
  * ```javascript
@@ -9,6 +9,11 @@ export interface SetTopicAttributesCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
11
  * <p>Allows a topic owner to set an attribute of the topic to a new value.</p>
12
+ * <note>
13
+ * <p>To remove the ability to change topic permissions, you must deny permissions to
14
+ * the <code>AddPermission</code>, <code>RemovePermission</code>, and
15
+ * <code>SetTopicAttributes</code> actions in your IAM policy.</p>
16
+ * </note>
12
17
  * @example
13
18
  * Use a bare-bones client and the command you need to make an API call.
14
19
  * ```javascript
@@ -27,8 +27,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
27
27
  * existing tag.</p>
28
28
  * </li>
29
29
  * <li>
30
- * <p>Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If your
31
- * 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>
30
+ * <p>Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If
31
+ * 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>
32
32
  * </li>
33
33
  * </ul>
34
34
  * @example
@@ -9,11 +9,16 @@ export interface UnsubscribeCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
11
  * <p>Deletes a subscription. If the subscription requires authentication for deletion, only
12
- * the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services signature
13
- * is required. If the <code>Unsubscribe</code> call does not require authentication and
14
- * the requester is not the subscription owner, a final cancellation message is delivered
15
- * to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the
16
- * <code>Unsubscribe</code> request was unintended.</p>
12
+ * the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services
13
+ * signature is required. If the <code>Unsubscribe</code> call does not require
14
+ * authentication and the requester is not the subscription owner, a final cancellation
15
+ * message is delivered to the endpoint, so that the endpoint owner can easily resubscribe
16
+ * to the topic if the <code>Unsubscribe</code> request was unintended.</p>
17
+ * <note>
18
+ * <p>Amazon SQS queue subscriptions require authentication for deletion. Only the owner of
19
+ * the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services
20
+ * signature.</p>
21
+ * </note>
17
22
  * <p>This action is throttled at 100 transactions per second (TPS).</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -8,7 +8,8 @@ export interface VerifySMSSandboxPhoneNumberCommandInput extends VerifySMSSandbo
8
8
  export interface VerifySMSSandboxPhoneNumberCommandOutput extends VerifySMSSandboxPhoneNumberResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.</p>
11
+ * <p>Verifies a destination phone number with a one-time password (OTP) for the calling
12
+ * Amazon Web Services account.</p>
12
13
  * <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
13
14
  * <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
14
15
  * you to try Amazon SNS features without risking your reputation as an SMS sender. While your
@@ -11,8 +11,8 @@ export interface AddPermissionInput {
11
11
  Label: string | undefined;
12
12
  /**
13
13
  * <p>The Amazon Web Services account IDs of the users (principals) who will be given access to the
14
- * specified actions. The users must have Amazon Web Services account, but do not need to be signed up for
15
- * this service.</p>
14
+ * specified actions. The users must have Amazon Web Services account, but do not need to be signed up
15
+ * for this service.</p>
16
16
  */
17
17
  AWSAccountId: string[] | undefined;
18
18
  /**
@@ -121,9 +121,9 @@ export interface ConfirmSubscriptionInput {
121
121
  Token: string | undefined;
122
122
  /**
123
123
  * <p>Disallows unauthenticated unsubscribes of the subscription. If the value of this
124
- * parameter is <code>true</code> and the request has an Amazon Web Services signature, then only the topic
125
- * owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action
126
- * requires Amazon Web Services authentication. </p>
124
+ * parameter is <code>true</code> and the request has an Amazon Web Services signature, then only the
125
+ * topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe
126
+ * action requires Amazon Web Services authentication. </p>
127
127
  */
128
128
  AuthenticateOnUnsubscribe?: string;
129
129
  }
@@ -342,6 +342,22 @@ export interface CreateTopicInput {
342
342
  * topic. By default, only the topic owner can publish or subscribe to the
343
343
  * topic.</p>
344
344
  * </li>
345
+ * <li>
346
+ * <p>
347
+ * <code>SignatureVersion</code> – The signature version corresponds to
348
+ * the hashing algorithm used while creating the signature of the notifications,
349
+ * subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.
350
+ * By default, <code>SignatureVersion</code> is set to 1.</p>
351
+ * </li>
352
+ * <li>
353
+ * <p>
354
+ * <code>TracingConfig</code> – Tracing mode of an Amazon SNS topic. By default
355
+ * <code>TracingConfig</code> is set to <code>PassThrough</code>, and the topic
356
+ * passes through the tracing header it receives from an Amazon SNS publisher to its
357
+ * subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic
358
+ * owner account if the sampled flag in the tracing header is true. This is only
359
+ * supported on standard topics.</p>
360
+ * </li>
345
361
  * </ul>
346
362
  *
347
363
  * <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side
@@ -351,8 +367,7 @@ export interface CreateTopicInput {
351
367
  * <p>
352
368
  * <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
353
369
  * key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key
354
- * Terms</a>. For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API
355
- * Reference</i>. </p>
370
+ * Terms</a>. For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API Reference</i>. </p>
356
371
  * </li>
357
372
  * </ul>
358
373
  *
@@ -520,8 +535,8 @@ export interface DeleteTopicInput {
520
535
  export interface GetDataProtectionPolicyInput {
521
536
  /**
522
537
  * <p>The ARN of the topic whose <code>DataProtectionPolicy</code> you want to get.</p>
523
- * <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>
524
- * in the Amazon Web Services General Reference.</p>
538
+ * <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names
539
+ * (ARNs)</a> in the Amazon Web Services General Reference.</p>
525
540
  */
526
541
  ResourceArn: string | undefined;
527
542
  }
@@ -592,15 +607,18 @@ export interface GetPlatformApplicationAttributesResponse {
592
607
  * <ul>
593
608
  * <li>
594
609
  * <p>
595
- * <code>AppleCertificateExpiryDate</code> – The expiry date of the SSL certificate used to configure certificate-based authentication.</p>
610
+ * <code>AppleCertificateExpiryDate</code> – The expiry date of the SSL
611
+ * certificate used to configure certificate-based authentication.</p>
596
612
  * </li>
597
613
  * <li>
598
614
  * <p>
599
- * <code>ApplePlatformTeamID</code> – The Apple developer account ID used to configure token-based authentication.</p>
615
+ * <code>ApplePlatformTeamID</code> – The Apple developer account ID used to
616
+ * configure token-based authentication.</p>
600
617
  * </li>
601
618
  * <li>
602
619
  * <p>
603
- * <code>ApplePlatformBundleID</code> – The app identifier used to configure token-based authentication.</p>
620
+ * <code>ApplePlatformBundleID</code> – The app identifier used to configure
621
+ * token-based authentication.</p>
604
622
  * </li>
605
623
  * <li>
606
624
  * <p>
@@ -697,6 +715,20 @@ export interface GetSubscriptionAttributesResponse {
697
715
  * </li>
698
716
  * <li>
699
717
  * <p>
718
+ * <code>FilterPolicyScope</code> – This attribute lets you choose the filtering scope by using one of the following string value types:</p>
719
+ * <ul>
720
+ * <li>
721
+ * <p>
722
+ * <code>MessageAttributes</code> (default) – The filter is applied on the message attributes.</p>
723
+ * </li>
724
+ * <li>
725
+ * <p>
726
+ * <code>MessageBody</code> – The filter is applied on the message body.</p>
727
+ * </li>
728
+ * </ul>
729
+ * </li>
730
+ * <li>
731
+ * <p>
700
732
  * <code>Owner</code> – The Amazon Web Services account ID of the subscription's
701
733
  * owner.</p>
702
734
  * </li>
@@ -780,6 +812,11 @@ export interface GetTopicAttributesResponse {
780
812
  * </li>
781
813
  * <li>
782
814
  * <p>
815
+ * <code>EffectiveDeliveryPolicy</code> – The JSON serialization of the
816
+ * effective delivery policy, taking system defaults into account.</p>
817
+ * </li>
818
+ * <li>
819
+ * <p>
783
820
  * <code>Owner</code> – The Amazon Web Services account ID of the topic's owner.</p>
784
821
  * </li>
785
822
  * <li>
@@ -789,6 +826,25 @@ export interface GetTopicAttributesResponse {
789
826
  * </li>
790
827
  * <li>
791
828
  * <p>
829
+ * <code>SignatureVersion</code> – The version of the Amazon SNS signature used
830
+ * for the topic.</p>
831
+ * <ul>
832
+ * <li>
833
+ * <p>By default, <code>SignatureVersion</code> is set to <b>1</b>. The signature is a Base64-encoded
834
+ * <b>SHA1withRSA</b> signature.</p>
835
+ * </li>
836
+ * <li>
837
+ * <p>When you set <code>SignatureVersion</code> to <b>2</b>. Amazon SNS uses a Base64-encoded <b>SHA256withRSA</b> signature. </p>
838
+ * <note>
839
+ * <p>If the API response does not include the
840
+ * <code>SignatureVersion</code> attribute, it means that the
841
+ * <code>SignatureVersion</code> for the topic has value <b>1</b>.</p>
842
+ * </note>
843
+ * </li>
844
+ * </ul>
845
+ * </li>
846
+ * <li>
847
+ * <p>
792
848
  * <code>SubscriptionsConfirmed</code> – The number of confirmed
793
849
  * subscriptions for the topic.</p>
794
850
  * </li>
@@ -808,8 +864,12 @@ export interface GetTopicAttributesResponse {
808
864
  * </li>
809
865
  * <li>
810
866
  * <p>
811
- * <code>EffectiveDeliveryPolicy</code> – The JSON serialization of the
812
- * effective delivery policy, taking system defaults into account.</p>
867
+ * <code>TracingConfig</code> – Tracing mode of an Amazon SNS topic. By default
868
+ * <code>TracingConfig</code> is set to <code>PassThrough</code>, and the topic
869
+ * passes through the tracing header it receives from an Amazon SNS publisher to its
870
+ * subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic
871
+ * owner account if the sampled flag in the tracing header is true. This is only
872
+ * supported on standard topics.</p>
813
873
  * </li>
814
874
  * </ul>
815
875
  *
@@ -819,8 +879,7 @@ export interface GetTopicAttributesResponse {
819
879
  * <p>
820
880
  * <code>KmsMasterKeyId</code> - The ID of an Amazon Web Services managed customer master key
821
881
  * (CMK) for Amazon SNS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key
822
- * Terms</a>. For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API
823
- * Reference</i>.</p>
882
+ * Terms</a>. For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API Reference</i>.</p>
824
883
  * </li>
825
884
  * </ul>
826
885
  *
@@ -1079,7 +1138,7 @@ export interface ListSMSSandboxPhoneNumbersResult {
1079
1138
  PhoneNumbers: SMSSandboxPhoneNumber[] | undefined;
1080
1139
  /**
1081
1140
  * <p>A <code>NextToken</code> string is returned when you call the
1082
- * <code>ListSMSSandboxPhoneNumbersInput</code> operation if additional pages of
1141
+ * <code>ListSMSSandboxPhoneNumbersInput</code> operation if additional pages of
1083
1142
  * records are available.</p>
1084
1143
  */
1085
1144
  NextToken?: string;
@@ -1477,8 +1536,8 @@ export interface PublishInput {
1477
1536
  /**
1478
1537
  * <p>This parameter applies only to FIFO (first-in-first-out) topics. The
1479
1538
  * <code>MessageDeduplicationId</code> can contain up to 128 alphanumeric characters
1480
- * <code>(a-z, A-Z, 0-9)</code> and punctuation
1481
- * <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</code>.</p>
1539
+ * <code>(a-z, A-Z, 0-9)</code> and punctuation
1540
+ * <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</code>.</p>
1482
1541
  * <p>Every message must have a unique <code>MessageDeduplicationId</code>, which is a token
1483
1542
  * used for deduplication of sent messages. If a message with a particular
1484
1543
  * <code>MessageDeduplicationId</code> is sent successfully, any message sent with the
@@ -1491,9 +1550,9 @@ export interface PublishInput {
1491
1550
  MessageDeduplicationId?: string;
1492
1551
  /**
1493
1552
  * <p>This parameter applies only to FIFO (first-in-first-out) topics. The
1494
- * <code>MessageGroupId</code> can contain up to 128 alphanumeric characters
1495
- * <code>(a-z, A-Z, 0-9)</code> and punctuation
1496
- * <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</code>.</p>
1553
+ * <code>MessageGroupId</code> can contain up to 128 alphanumeric characters
1554
+ * <code>(a-z, A-Z, 0-9)</code> and punctuation
1555
+ * <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</code>.</p>
1497
1556
  * <p>The <code>MessageGroupId</code> is a tag that specifies that a message belongs to a
1498
1557
  * specific message group. Messages that belong to the same message group are processed in
1499
1558
  * a FIFO manner (however, messages in different message groups might be processed out of
@@ -1665,7 +1724,8 @@ export interface PublishBatchInput {
1665
1724
  */
1666
1725
  TopicArn: string | undefined;
1667
1726
  /**
1668
- * <p>A list of <code>PublishBatch</code> request entries to be sent to the SNS topic.</p>
1727
+ * <p>A list of <code>PublishBatch</code> request entries to be sent to the SNS
1728
+ * topic.</p>
1669
1729
  */
1670
1730
  PublishBatchRequestEntries: PublishBatchRequestEntry[] | undefined;
1671
1731
  }
@@ -1732,9 +1792,10 @@ export declare class TooManyEntriesInBatchRequestException extends __BaseExcepti
1732
1792
  }
1733
1793
  export interface PutDataProtectionPolicyInput {
1734
1794
  /**
1735
- * <p>The ARN of the topic whose <code>DataProtectionPolicy</code> you want to add or update.</p>
1736
- * <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>
1737
- * in the Amazon Web Services General Reference.</p>
1795
+ * <p>The ARN of the topic whose <code>DataProtectionPolicy</code> you want to add or
1796
+ * update.</p>
1797
+ * <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names
1798
+ * (ARNs)</a> in the Amazon Web Services General Reference.</p>
1738
1799
  */
1739
1800
  ResourceArn: string | undefined;
1740
1801
  /**
@@ -1806,46 +1867,54 @@ export interface SetPlatformApplicationAttributesInput {
1806
1867
  * <ul>
1807
1868
  * <li>
1808
1869
  * <p>
1809
- * <code>PlatformCredential</code> – The credential received from the notification service.</p>
1870
+ * <code>PlatformCredential</code> – The credential received from the
1871
+ * notification service.</p>
1810
1872
  * <ul>
1811
1873
  * <li>
1812
- * <p>For ADM, <code>PlatformCredential</code>is client secret.</p>
1813
- * </li>
1874
+ * <p>For ADM, <code>PlatformCredential</code>is client secret.</p>
1875
+ * </li>
1814
1876
  * <li>
1815
- * <p>For Apple Services using certificate credentials, <code>PlatformCredential</code> is private key.</p>
1816
- * </li>
1877
+ * <p>For Apple Services using certificate credentials,
1878
+ * <code>PlatformCredential</code> is private key.</p>
1879
+ * </li>
1817
1880
  * <li>
1818
- * <p>For Apple Services using token credentials, <code>PlatformCredential</code> is signing key.</p>
1819
- * </li>
1881
+ * <p>For Apple Services using token credentials,
1882
+ * <code>PlatformCredential</code> is signing key.</p>
1883
+ * </li>
1820
1884
  * <li>
1821
- * <p>For GCM (Firebase Cloud Messaging), <code>PlatformCredential</code> is API key. </p>
1822
- * </li>
1885
+ * <p>For GCM (Firebase Cloud Messaging), <code>PlatformCredential</code> is
1886
+ * API key. </p>
1887
+ * </li>
1823
1888
  * </ul>
1824
1889
  * </li>
1825
1890
  * </ul>
1826
1891
  * <ul>
1827
1892
  * <li>
1828
- * <p>
1829
- * <code>PlatformPrincipal</code> – The principal received from the notification service.</p>
1830
- * <ul>
1893
+ * <p>
1894
+ * <code>PlatformPrincipal</code> – The principal received from the
1895
+ * notification service.</p>
1896
+ * <ul>
1831
1897
  * <li>
1832
- * <p>For ADM, <code>PlatformPrincipal</code>is client id.</p>
1833
- * </li>
1898
+ * <p>For ADM, <code>PlatformPrincipal</code>is client id.</p>
1899
+ * </li>
1834
1900
  * <li>
1835
- * <p>For Apple Services using certificate credentials, <code>PlatformPrincipal</code> is SSL certificate.</p>
1836
- * </li>
1901
+ * <p>For Apple Services using certificate credentials,
1902
+ * <code>PlatformPrincipal</code> is SSL certificate.</p>
1903
+ * </li>
1837
1904
  * <li>
1838
- * <p>For Apple Services using token credentials, <code>PlatformPrincipal</code> is signing key ID.</p>
1839
- * </li>
1905
+ * <p>For Apple Services using token credentials,
1906
+ * <code>PlatformPrincipal</code> is signing key ID.</p>
1907
+ * </li>
1840
1908
  * <li>
1841
- * <p>For GCM (Firebase Cloud Messaging), there is no <code>PlatformPrincipal</code>. </p>
1842
- * </li>
1909
+ * <p>For GCM (Firebase Cloud Messaging), there is no
1910
+ * <code>PlatformPrincipal</code>. </p>
1911
+ * </li>
1843
1912
  * </ul>
1844
1913
  * </li>
1845
1914
  * </ul>
1846
1915
  * <ul>
1847
1916
  * <li>
1848
- * <p>
1917
+ * <p>
1849
1918
  * <code>EventEndpointCreated</code> – Topic ARN to which
1850
1919
  * <code>EndpointCreated</code> event notifications are sent.</p>
1851
1920
  * </li>
@@ -1882,15 +1951,18 @@ export interface SetPlatformApplicationAttributesInput {
1882
1951
  * of successfully delivered messages.</p>
1883
1952
  * </li>
1884
1953
  * </ul>
1885
- * <p>The following attributes only apply to <code>APNs</code> token-based authentication:</p>
1954
+ * <p>The following attributes only apply to <code>APNs</code> token-based
1955
+ * authentication:</p>
1886
1956
  * <ul>
1887
1957
  * <li>
1888
- * <p>
1889
- * <code>ApplePlatformTeamID</code> – The identifier that's assigned to your Apple developer account team.</p>
1958
+ * <p>
1959
+ * <code>ApplePlatformTeamID</code> – The identifier that's assigned to your
1960
+ * Apple developer account team.</p>
1890
1961
  * </li>
1891
1962
  * <li>
1892
- * <p>
1893
- * <code>ApplePlatformBundleID</code> – The bundle identifier that's assigned to your iOS app.</p>
1963
+ * <p>
1964
+ * <code>ApplePlatformBundleID</code> – The bundle identifier that's assigned to
1965
+ * your iOS app.</p>
1894
1966
  * </li>
1895
1967
  * </ul>
1896
1968
  */
@@ -1901,8 +1973,8 @@ export interface SetPlatformApplicationAttributesInput {
1901
1973
  */
1902
1974
  export interface SetSMSAttributesInput {
1903
1975
  /**
1904
- * <p>The default settings for sending SMS messages from your Amazon Web Services account. You can set values
1905
- * for the following attribute names:</p>
1976
+ * <p>The default settings for sending SMS messages from your Amazon Web Services account. You can set
1977
+ * values for the following attribute names:</p>
1906
1978
  * <p>
1907
1979
  * <code>MonthlySpendLimit</code> – The maximum amount in USD that you are willing to spend
1908
1980
  * each month to send SMS messages. When Amazon SNS determines that sending an SMS message would
@@ -1946,7 +2018,8 @@ export interface SetSMSAttributesInput {
1946
2018
  * <li>
1947
2019
  * <p>
1948
2020
  * <code>Transactional</code> – Critical messages that support customer
1949
- * transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.</p>
2021
+ * transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS
2022
+ * optimizes the message delivery to achieve the highest reliability.</p>
1950
2023
  * </li>
1951
2024
  * </ul>
1952
2025
  * <p>
@@ -2020,6 +2093,20 @@ export interface SetSubscriptionAttributesInput {
2020
2093
  * </li>
2021
2094
  * <li>
2022
2095
  * <p>
2096
+ * <code>FilterPolicyScope</code> – This attribute lets you choose the filtering scope by using one of the following string value types:</p>
2097
+ * <ul>
2098
+ * <li>
2099
+ * <p>
2100
+ * <code>MessageAttributes</code> (default) – The filter is applied on the message attributes.</p>
2101
+ * </li>
2102
+ * <li>
2103
+ * <p>
2104
+ * <code>MessageBody</code> – The filter is applied on the message body.</p>
2105
+ * </li>
2106
+ * </ul>
2107
+ * </li>
2108
+ * <li>
2109
+ * <p>
2023
2110
  * <code>RawMessageDelivery</code> – When set to <code>true</code>,
2024
2111
  * enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the
2025
2112
  * need for the endpoints to process JSON formatting, which is otherwise created
@@ -2089,6 +2176,15 @@ export interface SetTopicAttributesInput {
2089
2176
  * topic. By default, only the topic owner can publish or subscribe to the
2090
2177
  * topic.</p>
2091
2178
  * </li>
2179
+ * <li>
2180
+ * <p>
2181
+ * <code>TracingConfig</code> – Tracing mode of an Amazon SNS topic. By default
2182
+ * <code>TracingConfig</code> is set to <code>PassThrough</code>, and the topic
2183
+ * passes through the tracing header it receives from an Amazon SNS publisher to its
2184
+ * subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic
2185
+ * owner account if the sampled flag in the tracing header is true. This is only
2186
+ * supported on standard topics.</p>
2187
+ * </li>
2092
2188
  * </ul>
2093
2189
  *
2094
2190
  * <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side-encryption</a>:</p>
@@ -2097,8 +2193,14 @@ export interface SetTopicAttributesInput {
2097
2193
  * <p>
2098
2194
  * <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
2099
2195
  * key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms">Key
2100
- * Terms</a>. For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API
2101
- * Reference</i>. </p>
2196
+ * Terms</a>. For more examples, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>Key Management Service API Reference</i>. </p>
2197
+ * </li>
2198
+ * <li>
2199
+ * <p>
2200
+ * <code>SignatureVersion</code> – The signature version corresponds to the
2201
+ * hashing algorithm used while creating the signature of the notifications,
2202
+ * subscription confirmations, or unsubscribe confirmation messages sent by
2203
+ * Amazon SNS.</p>
2102
2204
  * </li>
2103
2205
  * </ul>
2104
2206
  *
@@ -2252,6 +2354,20 @@ export interface SubscribeInput {
2252
2354
  * </li>
2253
2355
  * <li>
2254
2356
  * <p>
2357
+ * <code>FilterPolicyScope</code> – This attribute lets you choose the filtering scope by using one of the following string value types:</p>
2358
+ * <ul>
2359
+ * <li>
2360
+ * <p>
2361
+ * <code>MessageAttributes</code> (default) – The filter is applied on the message attributes.</p>
2362
+ * </li>
2363
+ * <li>
2364
+ * <p>
2365
+ * <code>MessageBody</code> – The filter is applied on the message body.</p>
2366
+ * </li>
2367
+ * </ul>
2368
+ * </li>
2369
+ * <li>
2370
+ * <p>
2255
2371
  * <code>RawMessageDelivery</code> – When set to <code>true</code>,
2256
2372
  * enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the
2257
2373
  * need for the endpoints to process JSON formatting, which is otherwise created
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-sns",
3
3
  "description": "AWS SDK for JavaScript Sns Client for Node.js, Browser and React Native",
4
- "version": "3.218.0",
4
+ "version": "3.223.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -19,36 +19,36 @@
19
19
  "dependencies": {
20
20
  "@aws-crypto/sha256-browser": "2.0.0",
21
21
  "@aws-crypto/sha256-js": "2.0.0",
22
- "@aws-sdk/client-sts": "3.218.0",
23
- "@aws-sdk/config-resolver": "3.215.0",
24
- "@aws-sdk/credential-provider-node": "3.218.0",
25
- "@aws-sdk/fetch-http-handler": "3.215.0",
26
- "@aws-sdk/hash-node": "3.215.0",
27
- "@aws-sdk/invalid-dependency": "3.215.0",
28
- "@aws-sdk/middleware-content-length": "3.215.0",
29
- "@aws-sdk/middleware-endpoint": "3.215.0",
30
- "@aws-sdk/middleware-host-header": "3.215.0",
31
- "@aws-sdk/middleware-logger": "3.215.0",
32
- "@aws-sdk/middleware-recursion-detection": "3.215.0",
33
- "@aws-sdk/middleware-retry": "3.215.0",
34
- "@aws-sdk/middleware-serde": "3.215.0",
35
- "@aws-sdk/middleware-signing": "3.215.0",
36
- "@aws-sdk/middleware-stack": "3.215.0",
37
- "@aws-sdk/middleware-user-agent": "3.215.0",
38
- "@aws-sdk/node-config-provider": "3.215.0",
39
- "@aws-sdk/node-http-handler": "3.215.0",
40
- "@aws-sdk/protocol-http": "3.215.0",
41
- "@aws-sdk/smithy-client": "3.215.0",
42
- "@aws-sdk/types": "3.215.0",
43
- "@aws-sdk/url-parser": "3.215.0",
22
+ "@aws-sdk/client-sts": "3.223.0",
23
+ "@aws-sdk/config-resolver": "3.222.0",
24
+ "@aws-sdk/credential-provider-node": "3.223.0",
25
+ "@aws-sdk/fetch-http-handler": "3.222.0",
26
+ "@aws-sdk/hash-node": "3.222.0",
27
+ "@aws-sdk/invalid-dependency": "3.222.0",
28
+ "@aws-sdk/middleware-content-length": "3.222.0",
29
+ "@aws-sdk/middleware-endpoint": "3.222.0",
30
+ "@aws-sdk/middleware-host-header": "3.222.0",
31
+ "@aws-sdk/middleware-logger": "3.222.0",
32
+ "@aws-sdk/middleware-recursion-detection": "3.222.0",
33
+ "@aws-sdk/middleware-retry": "3.222.0",
34
+ "@aws-sdk/middleware-serde": "3.222.0",
35
+ "@aws-sdk/middleware-signing": "3.222.0",
36
+ "@aws-sdk/middleware-stack": "3.222.0",
37
+ "@aws-sdk/middleware-user-agent": "3.222.0",
38
+ "@aws-sdk/node-config-provider": "3.222.0",
39
+ "@aws-sdk/node-http-handler": "3.222.0",
40
+ "@aws-sdk/protocol-http": "3.222.0",
41
+ "@aws-sdk/smithy-client": "3.222.0",
42
+ "@aws-sdk/types": "3.222.0",
43
+ "@aws-sdk/url-parser": "3.222.0",
44
44
  "@aws-sdk/util-base64": "3.208.0",
45
45
  "@aws-sdk/util-body-length-browser": "3.188.0",
46
46
  "@aws-sdk/util-body-length-node": "3.208.0",
47
- "@aws-sdk/util-defaults-mode-browser": "3.215.0",
48
- "@aws-sdk/util-defaults-mode-node": "3.215.0",
49
- "@aws-sdk/util-endpoints": "3.216.0",
50
- "@aws-sdk/util-user-agent-browser": "3.215.0",
51
- "@aws-sdk/util-user-agent-node": "3.215.0",
47
+ "@aws-sdk/util-defaults-mode-browser": "3.222.0",
48
+ "@aws-sdk/util-defaults-mode-node": "3.222.0",
49
+ "@aws-sdk/util-endpoints": "3.222.0",
50
+ "@aws-sdk/util-user-agent-browser": "3.222.0",
51
+ "@aws-sdk/util-user-agent-node": "3.222.0",
52
52
  "@aws-sdk/util-utf8-browser": "3.188.0",
53
53
  "@aws-sdk/util-utf8-node": "3.208.0",
54
54
  "fast-xml-parser": "4.0.11",