@aws-sdk/client-sns 3.262.0 → 3.263.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/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/SNS.d.ts +63 -63
- package/dist-types/SNSClient.d.ts +3 -3
- package/dist-types/commands/AddPermissionCommand.d.ts +2 -2
- package/dist-types/commands/CheckIfPhoneNumberIsOptedOutCommand.d.ts +1 -1
- package/dist-types/commands/CreatePlatformApplicationCommand.d.ts +10 -10
- package/dist-types/commands/CreatePlatformEndpointCommand.d.ts +1 -1
- package/dist-types/commands/CreateSMSSandboxPhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEndpointCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSMSSandboxPhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/GetSMSAttributesCommand.d.ts +1 -1
- package/dist-types/commands/GetSMSSandboxAccountStatusCommand.d.ts +1 -1
- package/dist-types/commands/ListEndpointsByPlatformApplicationCommand.d.ts +1 -1
- package/dist-types/commands/ListPhoneNumbersOptedOutCommand.d.ts +1 -1
- package/dist-types/commands/ListPlatformApplicationsCommand.d.ts +1 -1
- package/dist-types/commands/ListSMSSandboxPhoneNumbersCommand.d.ts +1 -1
- package/dist-types/commands/ListSubscriptionsByTopicCommand.d.ts +1 -1
- package/dist-types/commands/ListSubscriptionsCommand.d.ts +1 -1
- package/dist-types/commands/ListTopicsCommand.d.ts +1 -1
- package/dist-types/commands/OptInPhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/PublishBatchCommand.d.ts +7 -7
- package/dist-types/commands/PublishCommand.d.ts +6 -6
- package/dist-types/commands/RemovePermissionCommand.d.ts +2 -2
- package/dist-types/commands/SetSMSAttributesCommand.d.ts +3 -3
- package/dist-types/commands/SetTopicAttributesCommand.d.ts +2 -2
- package/dist-types/commands/SubscribeCommand.d.ts +2 -2
- package/dist-types/commands/TagResourceCommand.d.ts +7 -7
- package/dist-types/commands/UnsubscribeCommand.d.ts +3 -3
- package/dist-types/commands/VerifySMSSandboxPhoneNumberCommand.d.ts +1 -1
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +480 -379
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/package.json +1 -1
|
@@ -17,7 +17,7 @@ export interface AddPermissionInput {
|
|
|
17
17
|
AWSAccountId: string[] | undefined;
|
|
18
18
|
/**
|
|
19
19
|
* <p>The action you want to allow for the specified principal(s).</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>Valid values: Any Amazon SNS action name, for example <code>Publish</code>.</p>
|
|
21
21
|
*/
|
|
22
22
|
ActionName: string[] | undefined;
|
|
23
23
|
}
|
|
@@ -81,15 +81,15 @@ export interface CheckIfPhoneNumberIsOptedOutInput {
|
|
|
81
81
|
export interface CheckIfPhoneNumberIsOptedOutResponse {
|
|
82
82
|
/**
|
|
83
83
|
* <p>Indicates whether the phone number is opted out:</p>
|
|
84
|
-
*
|
|
84
|
+
* <ul>
|
|
85
85
|
* <li>
|
|
86
|
-
*
|
|
87
|
-
*
|
|
86
|
+
* <p>
|
|
87
|
+
* <code>true</code> – The phone number is opted out, meaning you cannot publish
|
|
88
88
|
* SMS messages to it.</p>
|
|
89
89
|
* </li>
|
|
90
90
|
* <li>
|
|
91
|
-
*
|
|
92
|
-
*
|
|
91
|
+
* <p>
|
|
92
|
+
* <code>false</code> – The phone number is opted in, meaning you can publish SMS
|
|
93
93
|
* messages to it.</p>
|
|
94
94
|
* </li>
|
|
95
95
|
* </ul>
|
|
@@ -310,70 +310,58 @@ export interface Tag {
|
|
|
310
310
|
export interface CreateTopicInput {
|
|
311
311
|
/**
|
|
312
312
|
* <p>The name of the topic you want to create.</p>
|
|
313
|
-
*
|
|
313
|
+
* <p>Constraints: Topic names must be made up of only uppercase and lowercase ASCII
|
|
314
314
|
* letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters
|
|
315
315
|
* long.</p>
|
|
316
|
-
*
|
|
316
|
+
* <p>For a FIFO (first-in-first-out) topic, the name must end with the <code>.fifo</code>
|
|
317
317
|
* suffix. </p>
|
|
318
318
|
*/
|
|
319
319
|
Name: string | undefined;
|
|
320
320
|
/**
|
|
321
321
|
* <p>A map of attributes with their corresponding values.</p>
|
|
322
|
-
*
|
|
322
|
+
* <p>The following lists the names, descriptions, and values of the special request
|
|
323
323
|
* parameters that the <code>CreateTopic</code> action uses:</p>
|
|
324
|
-
*
|
|
324
|
+
* <ul>
|
|
325
325
|
* <li>
|
|
326
|
-
*
|
|
326
|
+
* <p>
|
|
327
327
|
* <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries
|
|
328
328
|
* failed deliveries to HTTP/S endpoints.</p>
|
|
329
329
|
* </li>
|
|
330
330
|
* <li>
|
|
331
|
-
*
|
|
331
|
+
* <p>
|
|
332
332
|
* <code>DisplayName</code> – The display name to use for a topic with SMS
|
|
333
333
|
* subscriptions.</p>
|
|
334
334
|
* </li>
|
|
335
335
|
* <li>
|
|
336
|
-
*
|
|
336
|
+
* <p>
|
|
337
337
|
* <code>FifoTopic</code> – Set to true to create a FIFO topic.</p>
|
|
338
338
|
* </li>
|
|
339
339
|
* <li>
|
|
340
|
-
*
|
|
340
|
+
* <p>
|
|
341
341
|
* <code>Policy</code> – The policy that defines who can access your
|
|
342
342
|
* topic. By default, only the topic owner can publish or subscribe to the
|
|
343
343
|
* topic.</p>
|
|
344
344
|
* </li>
|
|
345
345
|
* <li>
|
|
346
|
-
*
|
|
346
|
+
* <p>
|
|
347
347
|
* <code>SignatureVersion</code> – The signature version corresponds to
|
|
348
348
|
* the hashing algorithm used while creating the signature of the notifications,
|
|
349
349
|
* subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.
|
|
350
350
|
* By default, <code>SignatureVersion</code> is set to 1.</p>
|
|
351
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>
|
|
361
352
|
* </ul>
|
|
362
|
-
*
|
|
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
|
|
353
|
+
* <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html">server-side
|
|
364
354
|
* encryption</a>:</p>
|
|
365
|
-
*
|
|
355
|
+
* <ul>
|
|
366
356
|
* <li>
|
|
367
|
-
*
|
|
368
|
-
*
|
|
357
|
+
* <p>
|
|
358
|
+
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
|
|
369
359
|
* 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
|
|
370
360
|
* 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>
|
|
371
361
|
* </li>
|
|
372
362
|
* </ul>
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
-
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</p>
|
|
376
|
-
* <ul>
|
|
363
|
+
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</p>
|
|
364
|
+
* <ul>
|
|
377
365
|
* <li>
|
|
378
366
|
* <p>
|
|
379
367
|
* <code>FifoTopic</code> – When this is set to <code>true</code>, a FIFO
|
|
@@ -381,24 +369,23 @@ export interface CreateTopicInput {
|
|
|
381
369
|
* </li>
|
|
382
370
|
* <li>
|
|
383
371
|
* <p>
|
|
384
|
-
*
|
|
372
|
+
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication for
|
|
385
373
|
* FIFO topics.</p>
|
|
386
|
-
*
|
|
387
|
-
* <ul>
|
|
374
|
+
* <ul>
|
|
388
375
|
* <li>
|
|
389
|
-
*
|
|
376
|
+
* <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>.
|
|
390
377
|
* If you create a FIFO topic and this attribute is <code>false</code>, you must
|
|
391
378
|
* specify a value for the <code>MessageDeduplicationId</code> parameter for the
|
|
392
379
|
* <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p>
|
|
393
|
-
*
|
|
380
|
+
* </li>
|
|
394
381
|
* <li>
|
|
395
|
-
*
|
|
382
|
+
* <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>,
|
|
396
383
|
* Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using
|
|
397
384
|
* the body of the message (but not the attributes of the message).</p>
|
|
398
|
-
*
|
|
385
|
+
* <p>(Optional) To override the generated value, you can specify a value
|
|
399
386
|
* for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code>
|
|
400
387
|
* action.</p>
|
|
401
|
-
*
|
|
388
|
+
* </li>
|
|
402
389
|
* </ul>
|
|
403
390
|
* </li>
|
|
404
391
|
* </ul>
|
|
@@ -406,18 +393,18 @@ export interface CreateTopicInput {
|
|
|
406
393
|
Attributes?: Record<string, string>;
|
|
407
394
|
/**
|
|
408
395
|
* <p>The list of tags to add to a new topic.</p>
|
|
409
|
-
*
|
|
396
|
+
* <note>
|
|
410
397
|
* <p>To be able to tag a topic on creation, you must have the
|
|
411
398
|
* <code>sns:CreateTopic</code> and <code>sns:TagResource</code>
|
|
412
399
|
* permissions.</p>
|
|
413
|
-
*
|
|
400
|
+
* </note>
|
|
414
401
|
*/
|
|
415
402
|
Tags?: Tag[];
|
|
416
403
|
/**
|
|
417
404
|
* <p>The body of the policy document you want to use for this topic.</p>
|
|
418
|
-
*
|
|
419
|
-
*
|
|
420
|
-
*
|
|
405
|
+
* <p>You can only add one policy per topic.</p>
|
|
406
|
+
* <p>The policy must be in JSON string format.</p>
|
|
407
|
+
* <p>Length Constraints: Maximum length of 30,720.</p>
|
|
421
408
|
*/
|
|
422
409
|
DataProtectionPolicy?: string;
|
|
423
410
|
}
|
|
@@ -535,7 +522,7 @@ export interface DeleteTopicInput {
|
|
|
535
522
|
export interface GetDataProtectionPolicyInput {
|
|
536
523
|
/**
|
|
537
524
|
* <p>The ARN of the topic whose <code>DataProtectionPolicy</code> you want to get.</p>
|
|
538
|
-
*
|
|
525
|
+
* <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
526
|
* (ARNs)</a> in the Amazon Web Services General Reference.</p>
|
|
540
527
|
*/
|
|
541
528
|
ResourceArn: string | undefined;
|
|
@@ -561,29 +548,29 @@ export interface GetEndpointAttributesInput {
|
|
|
561
548
|
export interface GetEndpointAttributesResponse {
|
|
562
549
|
/**
|
|
563
550
|
* <p>Attributes include the following:</p>
|
|
564
|
-
*
|
|
551
|
+
* <ul>
|
|
565
552
|
* <li>
|
|
566
|
-
*
|
|
567
|
-
*
|
|
553
|
+
* <p>
|
|
554
|
+
* <code>CustomUserData</code> – arbitrary user data to associate with the
|
|
568
555
|
* endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and
|
|
569
556
|
* less than 2KB.</p>
|
|
570
557
|
* </li>
|
|
571
558
|
* <li>
|
|
572
|
-
*
|
|
573
|
-
*
|
|
559
|
+
* <p>
|
|
560
|
+
* <code>Enabled</code> – flag that enables/disables delivery to the
|
|
574
561
|
* endpoint. Amazon SNS will set this to false when a notification service indicates to
|
|
575
562
|
* Amazon SNS that the endpoint is invalid. Users can set it back to true, typically
|
|
576
563
|
* after updating Token.</p>
|
|
577
564
|
* </li>
|
|
578
565
|
* <li>
|
|
579
|
-
*
|
|
580
|
-
*
|
|
566
|
+
* <p>
|
|
567
|
+
* <code>Token</code> – device token, also referred to as a registration id,
|
|
581
568
|
* for an app and mobile device. This is returned from the notification service
|
|
582
569
|
* when an app and mobile device are registered with the notification
|
|
583
570
|
* service.</p>
|
|
584
|
-
*
|
|
585
|
-
*
|
|
586
|
-
*
|
|
571
|
+
* <note>
|
|
572
|
+
* <p>The device token for the iOS platform is returned in lowercase.</p>
|
|
573
|
+
* </note>
|
|
587
574
|
* </li>
|
|
588
575
|
* </ul>
|
|
589
576
|
*/
|
|
@@ -604,40 +591,40 @@ export interface GetPlatformApplicationAttributesInput {
|
|
|
604
591
|
export interface GetPlatformApplicationAttributesResponse {
|
|
605
592
|
/**
|
|
606
593
|
* <p>Attributes include the following:</p>
|
|
607
|
-
*
|
|
594
|
+
* <ul>
|
|
608
595
|
* <li>
|
|
609
|
-
*
|
|
610
|
-
*
|
|
596
|
+
* <p>
|
|
597
|
+
* <code>AppleCertificateExpiryDate</code> – The expiry date of the SSL
|
|
611
598
|
* certificate used to configure certificate-based authentication.</p>
|
|
612
599
|
* </li>
|
|
613
600
|
* <li>
|
|
614
|
-
*
|
|
615
|
-
*
|
|
601
|
+
* <p>
|
|
602
|
+
* <code>ApplePlatformTeamID</code> – The Apple developer account ID used to
|
|
616
603
|
* configure token-based authentication.</p>
|
|
617
604
|
* </li>
|
|
618
605
|
* <li>
|
|
619
|
-
*
|
|
620
|
-
*
|
|
606
|
+
* <p>
|
|
607
|
+
* <code>ApplePlatformBundleID</code> – The app identifier used to configure
|
|
621
608
|
* token-based authentication.</p>
|
|
622
609
|
* </li>
|
|
623
610
|
* <li>
|
|
624
|
-
*
|
|
625
|
-
*
|
|
611
|
+
* <p>
|
|
612
|
+
* <code>EventEndpointCreated</code> – Topic ARN to which EndpointCreated
|
|
626
613
|
* event notifications should be sent.</p>
|
|
627
614
|
* </li>
|
|
628
615
|
* <li>
|
|
629
|
-
*
|
|
630
|
-
*
|
|
616
|
+
* <p>
|
|
617
|
+
* <code>EventEndpointDeleted</code> – Topic ARN to which EndpointDeleted
|
|
631
618
|
* event notifications should be sent.</p>
|
|
632
619
|
* </li>
|
|
633
620
|
* <li>
|
|
634
|
-
*
|
|
635
|
-
*
|
|
621
|
+
* <p>
|
|
622
|
+
* <code>EventEndpointUpdated</code> – Topic ARN to which EndpointUpdate
|
|
636
623
|
* event notifications should be sent.</p>
|
|
637
624
|
* </li>
|
|
638
625
|
* <li>
|
|
639
|
-
*
|
|
640
|
-
*
|
|
626
|
+
* <p>
|
|
627
|
+
* <code>EventDeliveryFailure</code> – Topic ARN to which DeliveryFailure
|
|
641
628
|
* event notifications should be sent upon Direct Publish delivery failure
|
|
642
629
|
* (permanent) to one of the application's endpoints.</p>
|
|
643
630
|
* </li>
|
|
@@ -652,8 +639,8 @@ export interface GetSMSAttributesInput {
|
|
|
652
639
|
/**
|
|
653
640
|
* <p>A list of the individual attribute names, such as <code>MonthlySpendLimit</code>, for
|
|
654
641
|
* which you want values.</p>
|
|
655
|
-
*
|
|
656
|
-
*
|
|
642
|
+
* <p>For all attribute names, see <a href="https://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html">SetSMSAttributes</a>.</p>
|
|
643
|
+
* <p>If you don't use this parameter, Amazon SNS returns all SMS attributes.</p>
|
|
657
644
|
*/
|
|
658
645
|
attributes?: string[];
|
|
659
646
|
}
|
|
@@ -690,95 +677,97 @@ export interface GetSubscriptionAttributesResponse {
|
|
|
690
677
|
/**
|
|
691
678
|
* <p>A map of the subscription's attributes. Attributes in this map include the
|
|
692
679
|
* following:</p>
|
|
693
|
-
*
|
|
680
|
+
* <ul>
|
|
694
681
|
* <li>
|
|
695
|
-
*
|
|
696
|
-
*
|
|
682
|
+
* <p>
|
|
683
|
+
* <code>ConfirmationWasAuthenticated</code> – <code>true</code> if the
|
|
697
684
|
* subscription confirmation request was authenticated.</p>
|
|
698
685
|
* </li>
|
|
699
686
|
* <li>
|
|
700
|
-
*
|
|
701
|
-
*
|
|
687
|
+
* <p>
|
|
688
|
+
* <code>DeliveryPolicy</code> – The JSON serialization of the
|
|
702
689
|
* subscription's delivery policy.</p>
|
|
703
690
|
* </li>
|
|
704
691
|
* <li>
|
|
705
|
-
*
|
|
706
|
-
*
|
|
692
|
+
* <p>
|
|
693
|
+
* <code>EffectiveDeliveryPolicy</code> – The JSON serialization of the
|
|
707
694
|
* effective delivery policy that takes into account the topic delivery policy and
|
|
708
695
|
* account system defaults.</p>
|
|
709
696
|
* </li>
|
|
710
697
|
* <li>
|
|
711
|
-
*
|
|
712
|
-
*
|
|
698
|
+
* <p>
|
|
699
|
+
* <code>FilterPolicy</code> – The filter policy JSON that is assigned to
|
|
713
700
|
* the subscription. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html">Amazon SNS Message
|
|
714
701
|
* Filtering</a> in the <i>Amazon SNS Developer Guide</i>.</p>
|
|
715
702
|
* </li>
|
|
716
703
|
* <li>
|
|
717
|
-
*
|
|
718
|
-
* <code>FilterPolicyScope</code> – This attribute lets you choose the
|
|
719
|
-
*
|
|
704
|
+
* <p>
|
|
705
|
+
* <code>FilterPolicyScope</code> – This attribute lets you choose the
|
|
706
|
+
* filtering scope by using one of the following string value types:</p>
|
|
707
|
+
* <ul>
|
|
720
708
|
* <li>
|
|
721
709
|
* <p>
|
|
722
|
-
* <code>MessageAttributes</code> (default) – The filter is
|
|
710
|
+
* <code>MessageAttributes</code> (default) – The filter is
|
|
711
|
+
* applied on the message attributes.</p>
|
|
723
712
|
* </li>
|
|
724
713
|
* <li>
|
|
725
714
|
* <p>
|
|
726
|
-
* <code>MessageBody</code> – The filter is applied on the message
|
|
715
|
+
* <code>MessageBody</code> – The filter is applied on the message
|
|
716
|
+
* body.</p>
|
|
727
717
|
* </li>
|
|
728
718
|
* </ul>
|
|
729
719
|
* </li>
|
|
730
720
|
* <li>
|
|
731
|
-
*
|
|
732
|
-
*
|
|
721
|
+
* <p>
|
|
722
|
+
* <code>Owner</code> – The Amazon Web Services account ID of the subscription's
|
|
733
723
|
* owner.</p>
|
|
734
724
|
* </li>
|
|
735
725
|
* <li>
|
|
736
|
-
*
|
|
737
|
-
*
|
|
726
|
+
* <p>
|
|
727
|
+
* <code>PendingConfirmation</code> – <code>true</code> if the subscription
|
|
738
728
|
* hasn't been confirmed. To confirm a pending subscription, call the
|
|
739
729
|
* <code>ConfirmSubscription</code> action with a confirmation token.</p>
|
|
740
730
|
* </li>
|
|
741
731
|
* <li>
|
|
742
|
-
*
|
|
743
|
-
*
|
|
732
|
+
* <p>
|
|
733
|
+
* <code>RawMessageDelivery</code> – <code>true</code> if raw message
|
|
744
734
|
* delivery is enabled for the subscription. Raw messages are free of JSON
|
|
745
735
|
* formatting and can be sent to HTTP/S and Amazon SQS endpoints.</p>
|
|
746
736
|
* </li>
|
|
747
737
|
* <li>
|
|
748
|
-
*
|
|
738
|
+
* <p>
|
|
749
739
|
* <code>RedrivePolicy</code> – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.
|
|
750
740
|
* Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)
|
|
751
741
|
* or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held
|
|
752
742
|
* in the dead-letter queue for further analysis or reprocessing.</p>
|
|
753
743
|
* </li>
|
|
754
744
|
* <li>
|
|
755
|
-
*
|
|
756
|
-
*
|
|
745
|
+
* <p>
|
|
746
|
+
* <code>SubscriptionArn</code> – The subscription's ARN.</p>
|
|
757
747
|
* </li>
|
|
758
748
|
* <li>
|
|
759
|
-
*
|
|
760
|
-
*
|
|
749
|
+
* <p>
|
|
750
|
+
* <code>TopicArn</code> – The topic ARN that the subscription is associated
|
|
761
751
|
* with.</p>
|
|
762
752
|
* </li>
|
|
763
753
|
* </ul>
|
|
764
|
-
*
|
|
765
|
-
* <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
|
|
754
|
+
* <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
|
|
766
755
|
* <ul>
|
|
767
756
|
* <li>
|
|
768
757
|
* <p>
|
|
769
758
|
* <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
|
|
770
|
-
*
|
|
759
|
+
* <ul>
|
|
771
760
|
* <li>
|
|
772
|
-
*
|
|
773
|
-
*
|
|
761
|
+
* <p>Permission to write to the Kinesis Data Firehose delivery stream</p>
|
|
762
|
+
* </li>
|
|
774
763
|
* <li>
|
|
775
|
-
*
|
|
776
|
-
*
|
|
764
|
+
* <p>Amazon SNS listed as a trusted entity</p>
|
|
765
|
+
* </li>
|
|
777
766
|
* </ul>
|
|
778
|
-
*
|
|
767
|
+
* <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions.
|
|
779
768
|
* For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout
|
|
780
769
|
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
|
|
781
|
-
*
|
|
770
|
+
* </li>
|
|
782
771
|
* </ul>
|
|
783
772
|
*/
|
|
784
773
|
Attributes?: Record<string, string>;
|
|
@@ -798,94 +787,82 @@ export interface GetTopicAttributesInput {
|
|
|
798
787
|
export interface GetTopicAttributesResponse {
|
|
799
788
|
/**
|
|
800
789
|
* <p>A map of the topic's attributes. Attributes in this map include the following:</p>
|
|
801
|
-
*
|
|
790
|
+
* <ul>
|
|
802
791
|
* <li>
|
|
803
|
-
*
|
|
792
|
+
* <p>
|
|
804
793
|
* <code>DeliveryPolicy</code> – The JSON serialization of the topic's
|
|
805
794
|
* delivery policy.</p>
|
|
806
795
|
* </li>
|
|
807
796
|
* <li>
|
|
808
|
-
*
|
|
797
|
+
* <p>
|
|
809
798
|
* <code>DisplayName</code> – The human-readable name used in the
|
|
810
799
|
* <code>From</code> field for notifications to <code>email</code> and
|
|
811
800
|
* <code>email-json</code> endpoints.</p>
|
|
812
801
|
* </li>
|
|
813
802
|
* <li>
|
|
814
|
-
*
|
|
803
|
+
* <p>
|
|
815
804
|
* <code>EffectiveDeliveryPolicy</code> – The JSON serialization of the
|
|
816
805
|
* effective delivery policy, taking system defaults into account.</p>
|
|
817
806
|
* </li>
|
|
818
807
|
* <li>
|
|
819
|
-
*
|
|
808
|
+
* <p>
|
|
820
809
|
* <code>Owner</code> – The Amazon Web Services account ID of the topic's owner.</p>
|
|
821
810
|
* </li>
|
|
822
811
|
* <li>
|
|
823
|
-
*
|
|
812
|
+
* <p>
|
|
824
813
|
* <code>Policy</code> – The JSON serialization of the topic's access
|
|
825
814
|
* control policy.</p>
|
|
826
815
|
* </li>
|
|
827
816
|
* <li>
|
|
828
|
-
*
|
|
817
|
+
* <p>
|
|
829
818
|
* <code>SignatureVersion</code> – The version of the Amazon SNS signature used
|
|
830
819
|
* for the topic.</p>
|
|
831
|
-
*
|
|
820
|
+
* <ul>
|
|
832
821
|
* <li>
|
|
833
|
-
*
|
|
822
|
+
* <p>By default, <code>SignatureVersion</code> is set to <b>1</b>. The signature is a Base64-encoded
|
|
834
823
|
* <b>SHA1withRSA</b> signature.</p>
|
|
835
|
-
*
|
|
824
|
+
* </li>
|
|
836
825
|
* <li>
|
|
837
|
-
*
|
|
838
|
-
*
|
|
839
|
-
*
|
|
826
|
+
* <p>When you set <code>SignatureVersion</code> to <b>2</b>. Amazon SNS uses a Base64-encoded <b>SHA256withRSA</b> signature. </p>
|
|
827
|
+
* <note>
|
|
828
|
+
* <p>If the API response does not include the
|
|
840
829
|
* <code>SignatureVersion</code> attribute, it means that the
|
|
841
830
|
* <code>SignatureVersion</code> for the topic has value <b>1</b>.</p>
|
|
842
|
-
*
|
|
843
|
-
*
|
|
831
|
+
* </note>
|
|
832
|
+
* </li>
|
|
844
833
|
* </ul>
|
|
845
834
|
* </li>
|
|
846
835
|
* <li>
|
|
847
|
-
*
|
|
836
|
+
* <p>
|
|
848
837
|
* <code>SubscriptionsConfirmed</code> – The number of confirmed
|
|
849
838
|
* subscriptions for the topic.</p>
|
|
850
839
|
* </li>
|
|
851
840
|
* <li>
|
|
852
|
-
*
|
|
841
|
+
* <p>
|
|
853
842
|
* <code>SubscriptionsDeleted</code> – The number of deleted subscriptions
|
|
854
843
|
* for the topic.</p>
|
|
855
844
|
* </li>
|
|
856
845
|
* <li>
|
|
857
|
-
*
|
|
846
|
+
* <p>
|
|
858
847
|
* <code>SubscriptionsPending</code> – The number of subscriptions pending
|
|
859
848
|
* confirmation for the topic.</p>
|
|
860
849
|
* </li>
|
|
861
850
|
* <li>
|
|
862
|
-
*
|
|
851
|
+
* <p>
|
|
863
852
|
* <code>TopicArn</code> – The topic's ARN.</p>
|
|
864
853
|
* </li>
|
|
865
|
-
* <li>
|
|
866
|
-
* <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>
|
|
873
|
-
* </li>
|
|
874
854
|
* </ul>
|
|
875
|
-
*
|
|
876
|
-
*
|
|
877
|
-
* <ul>
|
|
855
|
+
* <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>
|
|
856
|
+
* <ul>
|
|
878
857
|
* <li>
|
|
879
|
-
*
|
|
858
|
+
* <p>
|
|
880
859
|
* <code>KmsMasterKeyId</code> - The ID of an Amazon Web Services managed customer master key
|
|
881
860
|
* (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
|
|
882
861
|
* 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>
|
|
883
862
|
* </li>
|
|
884
863
|
* </ul>
|
|
885
|
-
*
|
|
886
|
-
*
|
|
887
|
-
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</p>
|
|
888
|
-
* <ul>
|
|
864
|
+
* <p>The following attributes apply only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</p>
|
|
865
|
+
* <ul>
|
|
889
866
|
* <li>
|
|
890
867
|
* <p>
|
|
891
868
|
* <code>FifoTopic</code> – When this is set to <code>true</code>, a FIFO
|
|
@@ -893,24 +870,23 @@ export interface GetTopicAttributesResponse {
|
|
|
893
870
|
* </li>
|
|
894
871
|
* <li>
|
|
895
872
|
* <p>
|
|
896
|
-
*
|
|
873
|
+
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication for
|
|
897
874
|
* FIFO topics.</p>
|
|
898
|
-
*
|
|
899
|
-
* <ul>
|
|
875
|
+
* <ul>
|
|
900
876
|
* <li>
|
|
901
|
-
*
|
|
877
|
+
* <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>.
|
|
902
878
|
* If you create a FIFO topic and this attribute is <code>false</code>, you must
|
|
903
879
|
* specify a value for the <code>MessageDeduplicationId</code> parameter for the
|
|
904
880
|
* <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p>
|
|
905
|
-
*
|
|
881
|
+
* </li>
|
|
906
882
|
* <li>
|
|
907
|
-
*
|
|
883
|
+
* <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>,
|
|
908
884
|
* Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using
|
|
909
885
|
* the body of the message (but not the attributes of the message).</p>
|
|
910
|
-
*
|
|
886
|
+
* <p>(Optional) To override the generated value, you can specify a value
|
|
911
887
|
* for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code>
|
|
912
888
|
* action.</p>
|
|
913
|
-
*
|
|
889
|
+
* </li>
|
|
914
890
|
* </ul>
|
|
915
891
|
* </li>
|
|
916
892
|
* </ul>
|
|
@@ -1112,7 +1088,7 @@ export declare enum SMSSandboxPhoneNumberVerificationStatus {
|
|
|
1112
1088
|
}
|
|
1113
1089
|
/**
|
|
1114
1090
|
* <p>A verified or pending destination phone number in the SMS sandbox.</p>
|
|
1115
|
-
*
|
|
1091
|
+
* <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the
|
|
1116
1092
|
* <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for
|
|
1117
1093
|
* you to try Amazon SNS features without risking your reputation as an SMS sender. While your
|
|
1118
1094
|
* Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send
|
|
@@ -1386,7 +1362,7 @@ export declare class PlatformApplicationDisabledException extends __BaseExceptio
|
|
|
1386
1362
|
* <p>The user-specified message attribute value. For string data types, the value attribute
|
|
1387
1363
|
* has the same restrictions on the content as the message body. For more information, see
|
|
1388
1364
|
* <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a>.</p>
|
|
1389
|
-
*
|
|
1365
|
+
* <p>Name, type, and value must not be empty or null. In addition, the message body should
|
|
1390
1366
|
* not be empty or null. All parts of the message attribute, including name, type, and
|
|
1391
1367
|
* value, are included in the message size restriction, which is currently 256 KB (262,144
|
|
1392
1368
|
* bytes). For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html">Amazon SNS message attributes</a> and
|
|
@@ -1418,7 +1394,7 @@ export interface MessageAttributeValue {
|
|
|
1418
1394
|
export interface PublishInput {
|
|
1419
1395
|
/**
|
|
1420
1396
|
* <p>The topic you want to publish to.</p>
|
|
1421
|
-
*
|
|
1397
|
+
* <p>If you don't specify a value for the <code>TopicArn</code> parameter, you must specify
|
|
1422
1398
|
* a value for the <code>PhoneNumber</code> or <code>TargetArn</code> parameters.</p>
|
|
1423
1399
|
*/
|
|
1424
1400
|
TopicArn?: string;
|
|
@@ -1430,70 +1406,70 @@ export interface PublishInput {
|
|
|
1430
1406
|
TargetArn?: string;
|
|
1431
1407
|
/**
|
|
1432
1408
|
* <p>The phone number to which you want to deliver an SMS message. Use E.164 format.</p>
|
|
1433
|
-
*
|
|
1409
|
+
* <p>If you don't specify a value for the <code>PhoneNumber</code> parameter, you must
|
|
1434
1410
|
* specify a value for the <code>TargetArn</code> or <code>TopicArn</code>
|
|
1435
1411
|
* parameters.</p>
|
|
1436
1412
|
*/
|
|
1437
1413
|
PhoneNumber?: string;
|
|
1438
1414
|
/**
|
|
1439
1415
|
* <p>The message you want to send.</p>
|
|
1440
|
-
*
|
|
1416
|
+
* <p>If you are publishing to a topic and you want to send the same message to all
|
|
1441
1417
|
* transport protocols, include the text of the message as a String value. If you want to
|
|
1442
1418
|
* send different messages for each transport protocol, set the value of the
|
|
1443
1419
|
* <code>MessageStructure</code> parameter to <code>json</code> and use a JSON object
|
|
1444
1420
|
* for the <code>Message</code> parameter.
|
|
1445
1421
|
* </p>
|
|
1446
|
-
*
|
|
1447
|
-
*
|
|
1448
|
-
*
|
|
1422
|
+
* <p></p>
|
|
1423
|
+
* <p>Constraints:</p>
|
|
1424
|
+
* <ul>
|
|
1449
1425
|
* <li>
|
|
1450
|
-
*
|
|
1426
|
+
* <p>With the exception of SMS, messages must be UTF-8 encoded strings and at most
|
|
1451
1427
|
* 256 KB in size (262,144 bytes, not 262,144 characters).</p>
|
|
1452
1428
|
* </li>
|
|
1453
1429
|
* <li>
|
|
1454
|
-
*
|
|
1430
|
+
* <p>For SMS, each message can contain up to 140 characters. This character limit
|
|
1455
1431
|
* depends on the encoding schema. For example, an SMS message can contain 160 GSM
|
|
1456
1432
|
* characters, 140 ASCII characters, or 70 UCS-2 characters.</p>
|
|
1457
|
-
*
|
|
1433
|
+
* <p>If you publish a message that exceeds this size limit, Amazon SNS sends the message
|
|
1458
1434
|
* as multiple messages, each fitting within the size limit. Messages aren't
|
|
1459
1435
|
* truncated mid-word but are cut off at whole-word boundaries.</p>
|
|
1460
|
-
*
|
|
1436
|
+
* <p>The total size limit for a single SMS <code>Publish</code> action is 1,600
|
|
1461
1437
|
* characters.</p>
|
|
1462
1438
|
* </li>
|
|
1463
1439
|
* </ul>
|
|
1464
|
-
*
|
|
1465
|
-
*
|
|
1440
|
+
* <p>JSON-specific constraints:</p>
|
|
1441
|
+
* <ul>
|
|
1466
1442
|
* <li>
|
|
1467
|
-
*
|
|
1443
|
+
* <p>Keys in the JSON object that correspond to supported transport protocols must
|
|
1468
1444
|
* have simple JSON string values.</p>
|
|
1469
1445
|
* </li>
|
|
1470
1446
|
* <li>
|
|
1471
|
-
*
|
|
1447
|
+
* <p>The values will be parsed (unescaped) before they are used in outgoing
|
|
1472
1448
|
* messages.</p>
|
|
1473
1449
|
* </li>
|
|
1474
1450
|
* <li>
|
|
1475
|
-
*
|
|
1451
|
+
* <p>Outbound notifications are JSON encoded (meaning that the characters will be
|
|
1476
1452
|
* reescaped for sending).</p>
|
|
1477
1453
|
* </li>
|
|
1478
1454
|
* <li>
|
|
1479
|
-
*
|
|
1455
|
+
* <p>Values have a minimum length of 0 (the empty string, "", is allowed).</p>
|
|
1480
1456
|
* </li>
|
|
1481
1457
|
* <li>
|
|
1482
|
-
*
|
|
1458
|
+
* <p>Values have a maximum length bounded by the overall message size (so,
|
|
1483
1459
|
* including multiple protocols may limit message sizes).</p>
|
|
1484
1460
|
* </li>
|
|
1485
1461
|
* <li>
|
|
1486
|
-
*
|
|
1462
|
+
* <p>Non-string values will cause the key to be ignored.</p>
|
|
1487
1463
|
* </li>
|
|
1488
1464
|
* <li>
|
|
1489
|
-
*
|
|
1465
|
+
* <p>Keys that do not correspond to supported transport protocols are
|
|
1490
1466
|
* ignored.</p>
|
|
1491
1467
|
* </li>
|
|
1492
1468
|
* <li>
|
|
1493
|
-
*
|
|
1469
|
+
* <p>Duplicate keys are not allowed.</p>
|
|
1494
1470
|
* </li>
|
|
1495
1471
|
* <li>
|
|
1496
|
-
*
|
|
1472
|
+
* <p>Failure to parse or validate any key or value in the message will cause the
|
|
1497
1473
|
* <code>Publish</code> call to return an error (no partial delivery).</p>
|
|
1498
1474
|
* </li>
|
|
1499
1475
|
* </ul>
|
|
@@ -1503,7 +1479,7 @@ export interface PublishInput {
|
|
|
1503
1479
|
* <p>Optional parameter to be used as the "Subject" line when the message is delivered to
|
|
1504
1480
|
* email endpoints. This field will also be included, if present, in the standard JSON
|
|
1505
1481
|
* messages delivered to other endpoints.</p>
|
|
1506
|
-
*
|
|
1482
|
+
* <p>Constraints: Subjects must be ASCII text that begins with a letter, number, or
|
|
1507
1483
|
* punctuation mark; must not include line breaks or control characters; and must be less
|
|
1508
1484
|
* than 100 characters long.</p>
|
|
1509
1485
|
*/
|
|
@@ -1514,19 +1490,19 @@ export interface PublishInput {
|
|
|
1514
1490
|
* message to your SMS subscribers and a longer message to your email subscribers. If you
|
|
1515
1491
|
* set <code>MessageStructure</code> to <code>json</code>, the value of the
|
|
1516
1492
|
* <code>Message</code> parameter must: </p>
|
|
1517
|
-
*
|
|
1493
|
+
* <ul>
|
|
1518
1494
|
* <li>
|
|
1519
|
-
*
|
|
1495
|
+
* <p>be a syntactically valid JSON object; and</p>
|
|
1520
1496
|
* </li>
|
|
1521
1497
|
* <li>
|
|
1522
|
-
*
|
|
1498
|
+
* <p>contain at least a top-level JSON key of "default" with a value that is a
|
|
1523
1499
|
* string.</p>
|
|
1524
1500
|
* </li>
|
|
1525
1501
|
* </ul>
|
|
1526
|
-
*
|
|
1502
|
+
* <p>You can define other top-level keys that define the message you want to send to a
|
|
1527
1503
|
* specific transport protocol (e.g., "http").</p>
|
|
1528
|
-
*
|
|
1529
|
-
*
|
|
1504
|
+
* <p>Valid value: <code>json</code>
|
|
1505
|
+
* </p>
|
|
1530
1506
|
*/
|
|
1531
1507
|
MessageStructure?: string;
|
|
1532
1508
|
/**
|
|
@@ -1538,12 +1514,12 @@ export interface PublishInput {
|
|
|
1538
1514
|
* <code>MessageDeduplicationId</code> can contain up to 128 alphanumeric characters
|
|
1539
1515
|
* <code>(a-z, A-Z, 0-9)</code> and punctuation
|
|
1540
1516
|
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</code>.</p>
|
|
1541
|
-
*
|
|
1517
|
+
* <p>Every message must have a unique <code>MessageDeduplicationId</code>, which is a token
|
|
1542
1518
|
* used for deduplication of sent messages. If a message with a particular
|
|
1543
1519
|
* <code>MessageDeduplicationId</code> is sent successfully, any message sent with the
|
|
1544
1520
|
* same <code>MessageDeduplicationId</code> during the 5-minute deduplication interval is
|
|
1545
1521
|
* treated as a duplicate. </p>
|
|
1546
|
-
*
|
|
1522
|
+
* <p>If the topic has <code>ContentBasedDeduplication</code> set, the system generates a
|
|
1547
1523
|
* <code>MessageDeduplicationId</code> based on the contents of the message. Your
|
|
1548
1524
|
* <code>MessageDeduplicationId</code> overrides the generated one.</p>
|
|
1549
1525
|
*/
|
|
@@ -1553,7 +1529,7 @@ export interface PublishInput {
|
|
|
1553
1529
|
* <code>MessageGroupId</code> can contain up to 128 alphanumeric characters
|
|
1554
1530
|
* <code>(a-z, A-Z, 0-9)</code> and punctuation
|
|
1555
1531
|
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</code>.</p>
|
|
1556
|
-
*
|
|
1532
|
+
* <p>The <code>MessageGroupId</code> is a tag that specifies that a message belongs to a
|
|
1557
1533
|
* specific message group. Messages that belong to the same message group are processed in
|
|
1558
1534
|
* a FIFO manner (however, messages in different message groups might be processed out of
|
|
1559
1535
|
* order). Every message must include a <code>MessageGroupId</code>.</p>
|
|
@@ -1566,12 +1542,12 @@ export interface PublishInput {
|
|
|
1566
1542
|
export interface PublishResponse {
|
|
1567
1543
|
/**
|
|
1568
1544
|
* <p>Unique identifier assigned to the published message.</p>
|
|
1569
|
-
*
|
|
1545
|
+
* <p>Length Constraint: Maximum 100 characters</p>
|
|
1570
1546
|
*/
|
|
1571
1547
|
MessageId?: string;
|
|
1572
1548
|
/**
|
|
1573
1549
|
* <p>This response element applies only to FIFO (first-in-first-out) topics. </p>
|
|
1574
|
-
*
|
|
1550
|
+
* <p>The sequence number is a large, non-consecutive number that Amazon SNS assigns to each
|
|
1575
1551
|
* message. The length of <code>SequenceNumber</code> is 128 bits.
|
|
1576
1552
|
* <code>SequenceNumber</code> continues to increase for each
|
|
1577
1553
|
* <code>MessageGroupId</code>.</p>
|
|
@@ -1628,10 +1604,10 @@ export declare class InvalidBatchEntryIdException extends __BaseException {
|
|
|
1628
1604
|
export interface PublishBatchRequestEntry {
|
|
1629
1605
|
/**
|
|
1630
1606
|
* <p>An identifier for the message in this batch.</p>
|
|
1631
|
-
*
|
|
1607
|
+
* <note>
|
|
1632
1608
|
* <p>The <code>Ids</code> of a batch request must be unique within a request. </p>
|
|
1633
1609
|
* <p>This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_). </p>
|
|
1634
|
-
*
|
|
1610
|
+
* </note>
|
|
1635
1611
|
*/
|
|
1636
1612
|
Id: string | undefined;
|
|
1637
1613
|
/**
|
|
@@ -1644,7 +1620,7 @@ export interface PublishBatchRequestEntry {
|
|
|
1644
1620
|
Subject?: string;
|
|
1645
1621
|
/**
|
|
1646
1622
|
* <p>Set <code>MessageStructure</code> to <code>json</code> if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set <code>MessageStructure</code> to <code>json</code>, the value of the <code>Message</code> parameter must: </p>
|
|
1647
|
-
*
|
|
1623
|
+
* <ul>
|
|
1648
1624
|
* <li>
|
|
1649
1625
|
* <p>be a syntactically valid JSON object; and</p>
|
|
1650
1626
|
* </li>
|
|
@@ -1652,7 +1628,7 @@ export interface PublishBatchRequestEntry {
|
|
|
1652
1628
|
* <p>contain at least a top-level JSON key of "default" with a value that is a string.</p>
|
|
1653
1629
|
* </li>
|
|
1654
1630
|
* </ul>
|
|
1655
|
-
*
|
|
1631
|
+
* <p>You can define other top-level keys that define the message you want to send to a
|
|
1656
1632
|
* specific transport protocol (e.g. http). </p>
|
|
1657
1633
|
*/
|
|
1658
1634
|
MessageStructure?: string;
|
|
@@ -1662,11 +1638,11 @@ export interface PublishBatchRequestEntry {
|
|
|
1662
1638
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
1663
1639
|
/**
|
|
1664
1640
|
* <p>This parameter applies only to FIFO (first-in-first-out) topics.</p>
|
|
1665
|
-
*
|
|
1666
|
-
*
|
|
1641
|
+
* <p>The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular <code>MessageDeduplicationId</code> is sent successfully, subsequent messages with the same <code>MessageDeduplicationId</code> are accepted successfully but aren't delivered.</p>
|
|
1642
|
+
* <ul>
|
|
1667
1643
|
* <li>
|
|
1668
1644
|
* <p>Every message must have a unique <code>MessageDeduplicationId</code>.</p>
|
|
1669
|
-
*
|
|
1645
|
+
* <ul>
|
|
1670
1646
|
* <li>
|
|
1671
1647
|
* <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p>
|
|
1672
1648
|
* </li>
|
|
@@ -1692,26 +1668,24 @@ export interface PublishBatchRequestEntry {
|
|
|
1692
1668
|
* are treated as duplicates and only one copy of the message is delivered. </p>
|
|
1693
1669
|
* </li>
|
|
1694
1670
|
* </ul>
|
|
1695
|
-
*
|
|
1671
|
+
* <note>
|
|
1696
1672
|
* <p>The <code>MessageDeduplicationId</code> is available to the consumer of the message (this can be useful for troubleshooting delivery issues).</p>
|
|
1697
1673
|
* <p>If a message is sent successfully but the acknowledgement is lost and the message is resent with the same <code>MessageDeduplicationId</code> after the deduplication interval, Amazon SNS can't detect duplicate messages. </p>
|
|
1698
1674
|
* <p>Amazon SNS continues to keep track of the message deduplication ID even after the message is received and deleted. </p>
|
|
1699
|
-
*
|
|
1700
|
-
*
|
|
1701
|
-
*
|
|
1675
|
+
* </note>
|
|
1676
|
+
* <p>The length of <code>MessageDeduplicationId</code> is 128 characters.</p>
|
|
1677
|
+
* <p>
|
|
1702
1678
|
* <code>MessageDeduplicationId</code> can contain alphanumeric characters <code>(a-z, A-Z, 0-9)</code> and punctuation <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</code>.</p>
|
|
1703
1679
|
*/
|
|
1704
1680
|
MessageDeduplicationId?: string;
|
|
1705
1681
|
/**
|
|
1706
1682
|
* <p>This parameter applies only to FIFO (first-in-first-out) topics.</p>
|
|
1707
|
-
*
|
|
1708
|
-
*
|
|
1709
|
-
*
|
|
1710
|
-
*
|
|
1683
|
+
* <p>The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single topic, use <code>MessageGroupId</code> values (for example, session data for multiple users). In this scenario, multiple consumers can process the topic, but the session data of each user is processed in a FIFO fashion. </p>
|
|
1684
|
+
* <p>You must associate a non-empty <code>MessageGroupId</code> with a message. If you don't provide a <code>MessageGroupId</code>, the action fails. </p>
|
|
1685
|
+
* <p>The length of <code>MessageGroupId</code> is 128 characters.</p>
|
|
1686
|
+
* <p>
|
|
1711
1687
|
* <code>MessageGroupId</code> can contain alphanumeric characters <code>(a-z, A-Z, 0-9)</code> and punctuation <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)</code>.</p>
|
|
1712
|
-
*
|
|
1713
|
-
*
|
|
1714
|
-
* <important>
|
|
1688
|
+
* <important>
|
|
1715
1689
|
* <p>
|
|
1716
1690
|
* <code>MessageGroupId</code> is required for FIFO topics. You can't use it for standard topics. </p>
|
|
1717
1691
|
* </important>
|
|
@@ -1764,8 +1738,8 @@ export interface PublishBatchResultEntry {
|
|
|
1764
1738
|
MessageId?: string;
|
|
1765
1739
|
/**
|
|
1766
1740
|
* <p>This parameter applies only to FIFO (first-in-first-out) topics.</p>
|
|
1767
|
-
*
|
|
1768
|
-
*
|
|
1741
|
+
* <p>The large, non-consecutive number that Amazon SNS assigns to each message.</p>
|
|
1742
|
+
* <p>The length of <code>SequenceNumber</code> is 128 bits. <code>SequenceNumber</code> continues to increase for a particular <code>MessageGroupId</code>.</p>
|
|
1769
1743
|
*/
|
|
1770
1744
|
SequenceNumber?: string;
|
|
1771
1745
|
}
|
|
@@ -1794,14 +1768,14 @@ export interface PutDataProtectionPolicyInput {
|
|
|
1794
1768
|
/**
|
|
1795
1769
|
* <p>The ARN of the topic whose <code>DataProtectionPolicy</code> you want to add or
|
|
1796
1770
|
* update.</p>
|
|
1797
|
-
*
|
|
1771
|
+
* <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
1772
|
* (ARNs)</a> in the Amazon Web Services General Reference.</p>
|
|
1799
1773
|
*/
|
|
1800
1774
|
ResourceArn: string | undefined;
|
|
1801
1775
|
/**
|
|
1802
1776
|
* <p>The JSON serialization of the topic's <code>DataProtectionPolicy</code>.</p>
|
|
1803
|
-
*
|
|
1804
|
-
*
|
|
1777
|
+
* <p>The <code>DataProtectionPolicy</code> must be in JSON string format.</p>
|
|
1778
|
+
* <p>Length Constraints: Maximum length of 30,720.</p>
|
|
1805
1779
|
*/
|
|
1806
1780
|
DataProtectionPolicy: string | undefined;
|
|
1807
1781
|
}
|
|
@@ -1828,23 +1802,23 @@ export interface SetEndpointAttributesInput {
|
|
|
1828
1802
|
EndpointArn: string | undefined;
|
|
1829
1803
|
/**
|
|
1830
1804
|
* <p>A map of the endpoint attributes. Attributes in this map include the following:</p>
|
|
1831
|
-
*
|
|
1805
|
+
* <ul>
|
|
1832
1806
|
* <li>
|
|
1833
|
-
*
|
|
1834
|
-
*
|
|
1807
|
+
* <p>
|
|
1808
|
+
* <code>CustomUserData</code> – arbitrary user data to associate with the
|
|
1835
1809
|
* endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and
|
|
1836
1810
|
* less than 2KB.</p>
|
|
1837
1811
|
* </li>
|
|
1838
1812
|
* <li>
|
|
1839
|
-
*
|
|
1840
|
-
*
|
|
1813
|
+
* <p>
|
|
1814
|
+
* <code>Enabled</code> – flag that enables/disables delivery to the
|
|
1841
1815
|
* endpoint. Amazon SNS will set this to false when a notification service indicates to
|
|
1842
1816
|
* Amazon SNS that the endpoint is invalid. Users can set it back to true, typically
|
|
1843
1817
|
* after updating Token.</p>
|
|
1844
1818
|
* </li>
|
|
1845
1819
|
* <li>
|
|
1846
|
-
*
|
|
1847
|
-
*
|
|
1820
|
+
* <p>
|
|
1821
|
+
* <code>Token</code> – device token, also referred to as a registration id,
|
|
1848
1822
|
* for an app and mobile device. This is returned from the notification service
|
|
1849
1823
|
* when an app and mobile device are registered with the notification
|
|
1850
1824
|
* service.</p>
|
|
@@ -1864,103 +1838,103 @@ export interface SetPlatformApplicationAttributesInput {
|
|
|
1864
1838
|
/**
|
|
1865
1839
|
* <p>A map of the platform application attributes. Attributes in this map include the
|
|
1866
1840
|
* following:</p>
|
|
1867
|
-
*
|
|
1841
|
+
* <ul>
|
|
1868
1842
|
* <li>
|
|
1869
|
-
*
|
|
1843
|
+
* <p>
|
|
1870
1844
|
* <code>PlatformCredential</code> – The credential received from the
|
|
1871
1845
|
* notification service.</p>
|
|
1872
|
-
*
|
|
1846
|
+
* <ul>
|
|
1873
1847
|
* <li>
|
|
1874
|
-
*
|
|
1875
|
-
*
|
|
1848
|
+
* <p>For ADM, <code>PlatformCredential</code>is client secret.</p>
|
|
1849
|
+
* </li>
|
|
1876
1850
|
* <li>
|
|
1877
|
-
*
|
|
1851
|
+
* <p>For Apple Services using certificate credentials,
|
|
1878
1852
|
* <code>PlatformCredential</code> is private key.</p>
|
|
1879
|
-
*
|
|
1853
|
+
* </li>
|
|
1880
1854
|
* <li>
|
|
1881
|
-
*
|
|
1855
|
+
* <p>For Apple Services using token credentials,
|
|
1882
1856
|
* <code>PlatformCredential</code> is signing key.</p>
|
|
1883
|
-
*
|
|
1857
|
+
* </li>
|
|
1884
1858
|
* <li>
|
|
1885
|
-
*
|
|
1859
|
+
* <p>For GCM (Firebase Cloud Messaging), <code>PlatformCredential</code> is
|
|
1886
1860
|
* API key. </p>
|
|
1887
|
-
*
|
|
1861
|
+
* </li>
|
|
1888
1862
|
* </ul>
|
|
1889
1863
|
* </li>
|
|
1890
1864
|
* </ul>
|
|
1891
|
-
*
|
|
1865
|
+
* <ul>
|
|
1892
1866
|
* <li>
|
|
1893
|
-
*
|
|
1867
|
+
* <p>
|
|
1894
1868
|
* <code>PlatformPrincipal</code> – The principal received from the
|
|
1895
1869
|
* notification service.</p>
|
|
1896
|
-
*
|
|
1870
|
+
* <ul>
|
|
1897
1871
|
* <li>
|
|
1898
|
-
*
|
|
1899
|
-
*
|
|
1872
|
+
* <p>For ADM, <code>PlatformPrincipal</code>is client id.</p>
|
|
1873
|
+
* </li>
|
|
1900
1874
|
* <li>
|
|
1901
|
-
*
|
|
1875
|
+
* <p>For Apple Services using certificate credentials,
|
|
1902
1876
|
* <code>PlatformPrincipal</code> is SSL certificate.</p>
|
|
1903
|
-
*
|
|
1877
|
+
* </li>
|
|
1904
1878
|
* <li>
|
|
1905
|
-
*
|
|
1879
|
+
* <p>For Apple Services using token credentials,
|
|
1906
1880
|
* <code>PlatformPrincipal</code> is signing key ID.</p>
|
|
1907
|
-
*
|
|
1881
|
+
* </li>
|
|
1908
1882
|
* <li>
|
|
1909
|
-
*
|
|
1883
|
+
* <p>For GCM (Firebase Cloud Messaging), there is no
|
|
1910
1884
|
* <code>PlatformPrincipal</code>. </p>
|
|
1911
|
-
*
|
|
1885
|
+
* </li>
|
|
1912
1886
|
* </ul>
|
|
1913
1887
|
* </li>
|
|
1914
1888
|
* </ul>
|
|
1915
|
-
*
|
|
1889
|
+
* <ul>
|
|
1916
1890
|
* <li>
|
|
1917
|
-
*
|
|
1918
|
-
*
|
|
1891
|
+
* <p>
|
|
1892
|
+
* <code>EventEndpointCreated</code> – Topic ARN to which
|
|
1919
1893
|
* <code>EndpointCreated</code> event notifications are sent.</p>
|
|
1920
1894
|
* </li>
|
|
1921
1895
|
* <li>
|
|
1922
|
-
*
|
|
1923
|
-
*
|
|
1896
|
+
* <p>
|
|
1897
|
+
* <code>EventEndpointDeleted</code> – Topic ARN to which
|
|
1924
1898
|
* <code>EndpointDeleted</code> event notifications are sent.</p>
|
|
1925
1899
|
* </li>
|
|
1926
1900
|
* <li>
|
|
1927
|
-
*
|
|
1928
|
-
*
|
|
1901
|
+
* <p>
|
|
1902
|
+
* <code>EventEndpointUpdated</code> – Topic ARN to which
|
|
1929
1903
|
* <code>EndpointUpdate</code> event notifications are sent.</p>
|
|
1930
1904
|
* </li>
|
|
1931
1905
|
* <li>
|
|
1932
|
-
*
|
|
1933
|
-
*
|
|
1906
|
+
* <p>
|
|
1907
|
+
* <code>EventDeliveryFailure</code> – Topic ARN to which
|
|
1934
1908
|
* <code>DeliveryFailure</code> event notifications are sent upon Direct
|
|
1935
1909
|
* Publish delivery failure (permanent) to one of the application's
|
|
1936
1910
|
* endpoints.</p>
|
|
1937
1911
|
* </li>
|
|
1938
1912
|
* <li>
|
|
1939
|
-
*
|
|
1940
|
-
*
|
|
1913
|
+
* <p>
|
|
1914
|
+
* <code>SuccessFeedbackRoleArn</code> – IAM role ARN used to give Amazon SNS
|
|
1941
1915
|
* write access to use CloudWatch Logs on your behalf.</p>
|
|
1942
1916
|
* </li>
|
|
1943
1917
|
* <li>
|
|
1944
|
-
*
|
|
1945
|
-
*
|
|
1918
|
+
* <p>
|
|
1919
|
+
* <code>FailureFeedbackRoleArn</code> – IAM role ARN used to give Amazon SNS
|
|
1946
1920
|
* write access to use CloudWatch Logs on your behalf.</p>
|
|
1947
1921
|
* </li>
|
|
1948
1922
|
* <li>
|
|
1949
|
-
*
|
|
1950
|
-
*
|
|
1923
|
+
* <p>
|
|
1924
|
+
* <code>SuccessFeedbackSampleRate</code> – Sample rate percentage (0-100)
|
|
1951
1925
|
* of successfully delivered messages.</p>
|
|
1952
1926
|
* </li>
|
|
1953
1927
|
* </ul>
|
|
1954
|
-
*
|
|
1928
|
+
* <p>The following attributes only apply to <code>APNs</code> token-based
|
|
1955
1929
|
* authentication:</p>
|
|
1956
|
-
*
|
|
1930
|
+
* <ul>
|
|
1957
1931
|
* <li>
|
|
1958
|
-
*
|
|
1932
|
+
* <p>
|
|
1959
1933
|
* <code>ApplePlatformTeamID</code> – The identifier that's assigned to your
|
|
1960
1934
|
* Apple developer account team.</p>
|
|
1961
1935
|
* </li>
|
|
1962
1936
|
* <li>
|
|
1963
|
-
*
|
|
1937
|
+
* <p>
|
|
1964
1938
|
* <code>ApplePlatformBundleID</code> – The bundle identifier that's assigned to
|
|
1965
1939
|
* your iOS app.</p>
|
|
1966
1940
|
* </li>
|
|
@@ -1975,89 +1949,89 @@ export interface SetSMSAttributesInput {
|
|
|
1975
1949
|
/**
|
|
1976
1950
|
* <p>The default settings for sending SMS messages from your Amazon Web Services account. You can set
|
|
1977
1951
|
* values for the following attribute names:</p>
|
|
1978
|
-
*
|
|
1952
|
+
* <p>
|
|
1979
1953
|
* <code>MonthlySpendLimit</code> – The maximum amount in USD that you are willing to spend
|
|
1980
1954
|
* each month to send SMS messages. When Amazon SNS determines that sending an SMS message would
|
|
1981
1955
|
* incur a cost that exceeds this limit, it stops sending SMS messages within
|
|
1982
1956
|
* minutes.</p>
|
|
1983
|
-
*
|
|
1957
|
+
* <important>
|
|
1984
1958
|
* <p>Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During
|
|
1985
1959
|
* that interval, if you continue to send SMS messages, you will incur costs that
|
|
1986
1960
|
* exceed your limit.</p>
|
|
1987
|
-
*
|
|
1988
|
-
*
|
|
1961
|
+
* </important>
|
|
1962
|
+
* <p>By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to
|
|
1989
1963
|
* raise the limit, submit an <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sns">SNS Limit Increase case</a>. For <b>New limit
|
|
1990
1964
|
* value</b>, enter your desired monthly spend limit. In the <b>Use Case Description</b> field, explain that you are requesting
|
|
1991
1965
|
* an SMS monthly spend limit increase.</p>
|
|
1992
|
-
*
|
|
1966
|
+
* <p>
|
|
1993
1967
|
* <code>DeliveryStatusIAMRole</code> – The ARN of the IAM role that allows Amazon SNS to write
|
|
1994
1968
|
* logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS
|
|
1995
1969
|
* writes a log that includes the message price, the success or failure status, the reason
|
|
1996
1970
|
* for failure (if the message failed), the message dwell time, and other
|
|
1997
1971
|
* information.</p>
|
|
1998
|
-
*
|
|
1972
|
+
* <p>
|
|
1999
1973
|
* <code>DeliveryStatusSuccessSamplingRate</code> – The percentage of successful SMS
|
|
2000
1974
|
* deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an
|
|
2001
1975
|
* integer from 0 - 100. For example, to write logs only for failed deliveries, set this
|
|
2002
1976
|
* value to <code>0</code>. To write logs for 10% of your successful deliveries, set it to
|
|
2003
1977
|
* <code>10</code>.</p>
|
|
2004
|
-
*
|
|
1978
|
+
* <p>
|
|
2005
1979
|
* <code>DefaultSenderID</code> – A string, such as your business brand, that is displayed
|
|
2006
1980
|
* as the sender on the receiving device. Support for sender IDs varies by country. The
|
|
2007
1981
|
* sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one
|
|
2008
1982
|
* letter.</p>
|
|
2009
|
-
*
|
|
1983
|
+
* <p>
|
|
2010
1984
|
* <code>DefaultSMSType</code> – The type of SMS message that you will send by default. You
|
|
2011
1985
|
* can assign the following values:</p>
|
|
2012
|
-
*
|
|
1986
|
+
* <ul>
|
|
2013
1987
|
* <li>
|
|
2014
|
-
*
|
|
2015
|
-
*
|
|
1988
|
+
* <p>
|
|
1989
|
+
* <code>Promotional</code> – (Default) Noncritical messages, such as marketing
|
|
2016
1990
|
* messages. Amazon SNS optimizes the message delivery to incur the lowest cost.</p>
|
|
2017
1991
|
* </li>
|
|
2018
1992
|
* <li>
|
|
2019
|
-
*
|
|
2020
|
-
*
|
|
1993
|
+
* <p>
|
|
1994
|
+
* <code>Transactional</code> – Critical messages that support customer
|
|
2021
1995
|
* transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS
|
|
2022
1996
|
* optimizes the message delivery to achieve the highest reliability.</p>
|
|
2023
1997
|
* </li>
|
|
2024
1998
|
* </ul>
|
|
2025
|
-
*
|
|
1999
|
+
* <p>
|
|
2026
2000
|
* <code>UsageReportS3Bucket</code> – The name of the Amazon S3 bucket to receive daily SMS
|
|
2027
2001
|
* usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to
|
|
2028
2002
|
* the bucket. The report includes the following information for each SMS message that was
|
|
2029
2003
|
* successfully delivered by your Amazon Web Services account:</p>
|
|
2030
|
-
*
|
|
2004
|
+
* <ul>
|
|
2031
2005
|
* <li>
|
|
2032
|
-
*
|
|
2006
|
+
* <p>Time that the message was published (in UTC)</p>
|
|
2033
2007
|
* </li>
|
|
2034
2008
|
* <li>
|
|
2035
|
-
*
|
|
2009
|
+
* <p>Message ID</p>
|
|
2036
2010
|
* </li>
|
|
2037
2011
|
* <li>
|
|
2038
|
-
*
|
|
2012
|
+
* <p>Destination phone number</p>
|
|
2039
2013
|
* </li>
|
|
2040
2014
|
* <li>
|
|
2041
|
-
*
|
|
2015
|
+
* <p>Message type</p>
|
|
2042
2016
|
* </li>
|
|
2043
2017
|
* <li>
|
|
2044
|
-
*
|
|
2018
|
+
* <p>Delivery status</p>
|
|
2045
2019
|
* </li>
|
|
2046
2020
|
* <li>
|
|
2047
|
-
*
|
|
2021
|
+
* <p>Message price (in USD)</p>
|
|
2048
2022
|
* </li>
|
|
2049
2023
|
* <li>
|
|
2050
|
-
*
|
|
2024
|
+
* <p>Part number (a message is split into multiple parts if it is too long for a
|
|
2051
2025
|
* single message)</p>
|
|
2052
2026
|
* </li>
|
|
2053
2027
|
* <li>
|
|
2054
|
-
*
|
|
2028
|
+
* <p>Total number of parts</p>
|
|
2055
2029
|
* </li>
|
|
2056
2030
|
* </ul>
|
|
2057
|
-
*
|
|
2031
|
+
* <p>To receive the report, the bucket must have a policy that allows the Amazon SNS service
|
|
2058
2032
|
* principal to perform the <code>s3:PutObject</code> and <code>s3:GetBucketLocation</code>
|
|
2059
2033
|
* actions.</p>
|
|
2060
|
-
*
|
|
2034
|
+
* <p>For an example bucket policy and usage report, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sms_stats.html">Monitoring SMS Activity</a> in the
|
|
2061
2035
|
* <i>Amazon SNS Developer Guide</i>.</p>
|
|
2062
2036
|
*/
|
|
2063
2037
|
attributes: Record<string, string> | undefined;
|
|
@@ -2077,68 +2051,69 @@ export interface SetSubscriptionAttributesInput {
|
|
|
2077
2051
|
SubscriptionArn: string | undefined;
|
|
2078
2052
|
/**
|
|
2079
2053
|
* <p>A map of attributes with their corresponding values.</p>
|
|
2080
|
-
*
|
|
2054
|
+
* <p>The following lists the names, descriptions, and values of the special request
|
|
2081
2055
|
* parameters that this action uses:</p>
|
|
2082
|
-
*
|
|
2056
|
+
* <ul>
|
|
2083
2057
|
* <li>
|
|
2084
|
-
*
|
|
2058
|
+
* <p>
|
|
2085
2059
|
* <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries
|
|
2086
2060
|
* failed deliveries to HTTP/S endpoints.</p>
|
|
2087
2061
|
* </li>
|
|
2088
2062
|
* <li>
|
|
2089
|
-
*
|
|
2063
|
+
* <p>
|
|
2090
2064
|
* <code>FilterPolicy</code> – The simple JSON object that lets your
|
|
2091
2065
|
* subscriber receive only a subset of messages, rather than receiving every
|
|
2092
2066
|
* message published to the topic.</p>
|
|
2093
2067
|
* </li>
|
|
2094
2068
|
* <li>
|
|
2095
|
-
*
|
|
2096
|
-
* <code>FilterPolicyScope</code> – This attribute lets you choose the
|
|
2097
|
-
*
|
|
2069
|
+
* <p>
|
|
2070
|
+
* <code>FilterPolicyScope</code> – This attribute lets you choose the
|
|
2071
|
+
* filtering scope by using one of the following string value types:</p>
|
|
2072
|
+
* <ul>
|
|
2098
2073
|
* <li>
|
|
2099
2074
|
* <p>
|
|
2100
|
-
* <code>MessageAttributes</code> (default) – The filter is
|
|
2075
|
+
* <code>MessageAttributes</code> (default) – The filter is
|
|
2076
|
+
* applied on the message attributes.</p>
|
|
2101
2077
|
* </li>
|
|
2102
2078
|
* <li>
|
|
2103
2079
|
* <p>
|
|
2104
|
-
* <code>MessageBody</code> – The filter is applied on the message
|
|
2080
|
+
* <code>MessageBody</code> – The filter is applied on the message
|
|
2081
|
+
* body.</p>
|
|
2105
2082
|
* </li>
|
|
2106
2083
|
* </ul>
|
|
2107
2084
|
* </li>
|
|
2108
2085
|
* <li>
|
|
2109
|
-
*
|
|
2086
|
+
* <p>
|
|
2110
2087
|
* <code>RawMessageDelivery</code> – When set to <code>true</code>,
|
|
2111
2088
|
* enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the
|
|
2112
2089
|
* need for the endpoints to process JSON formatting, which is otherwise created
|
|
2113
2090
|
* for Amazon SNS metadata.</p>
|
|
2114
2091
|
* </li>
|
|
2115
2092
|
* <li>
|
|
2116
|
-
*
|
|
2093
|
+
* <p>
|
|
2117
2094
|
* <code>RedrivePolicy</code> – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.
|
|
2118
2095
|
* Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)
|
|
2119
2096
|
* or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held
|
|
2120
2097
|
* in the dead-letter queue for further analysis or reprocessing.</p>
|
|
2121
2098
|
* </li>
|
|
2122
2099
|
* </ul>
|
|
2123
|
-
*
|
|
2124
|
-
*
|
|
2125
|
-
* <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
|
|
2100
|
+
* <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
|
|
2126
2101
|
* <ul>
|
|
2127
2102
|
* <li>
|
|
2128
2103
|
* <p>
|
|
2129
2104
|
* <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
|
|
2130
|
-
*
|
|
2105
|
+
* <ul>
|
|
2131
2106
|
* <li>
|
|
2132
|
-
*
|
|
2133
|
-
*
|
|
2107
|
+
* <p>Permission to write to the Kinesis Data Firehose delivery stream</p>
|
|
2108
|
+
* </li>
|
|
2134
2109
|
* <li>
|
|
2135
|
-
*
|
|
2136
|
-
*
|
|
2110
|
+
* <p>Amazon SNS listed as a trusted entity</p>
|
|
2111
|
+
* </li>
|
|
2137
2112
|
* </ul>
|
|
2138
|
-
*
|
|
2113
|
+
* <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions.
|
|
2139
2114
|
* For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout
|
|
2140
2115
|
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
|
|
2141
|
-
*
|
|
2116
|
+
* </li>
|
|
2142
2117
|
* </ul>
|
|
2143
2118
|
*/
|
|
2144
2119
|
AttributeName: string | undefined;
|
|
@@ -2157,76 +2132,201 @@ export interface SetTopicAttributesInput {
|
|
|
2157
2132
|
TopicArn: string | undefined;
|
|
2158
2133
|
/**
|
|
2159
2134
|
* <p>A map of attributes with their corresponding values.</p>
|
|
2160
|
-
*
|
|
2135
|
+
* <p>The following lists the names, descriptions, and values of the special request
|
|
2161
2136
|
* parameters that the <code>SetTopicAttributes</code> action uses:</p>
|
|
2162
|
-
*
|
|
2137
|
+
* <ul>
|
|
2163
2138
|
* <li>
|
|
2164
|
-
*
|
|
2139
|
+
* <p>
|
|
2140
|
+
* <code>ApplicationSuccessFeedbackRoleArn</code> – Indicates failed
|
|
2141
|
+
* message delivery status for an Amazon SNS topic that is subscribed to a platform
|
|
2142
|
+
* application endpoint.</p>
|
|
2143
|
+
* </li>
|
|
2144
|
+
* <li>
|
|
2145
|
+
* <p>
|
|
2165
2146
|
* <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries
|
|
2166
2147
|
* failed deliveries to HTTP/S endpoints.</p>
|
|
2167
2148
|
* </li>
|
|
2168
2149
|
* <li>
|
|
2169
|
-
*
|
|
2150
|
+
* <p>
|
|
2170
2151
|
* <code>DisplayName</code> – The display name to use for a topic with SMS
|
|
2171
2152
|
* subscriptions.</p>
|
|
2172
2153
|
* </li>
|
|
2173
2154
|
* <li>
|
|
2174
|
-
*
|
|
2155
|
+
* <p>
|
|
2175
2156
|
* <code>Policy</code> – The policy that defines who can access your
|
|
2176
2157
|
* topic. By default, only the topic owner can publish or subscribe to the
|
|
2177
2158
|
* topic.</p>
|
|
2178
2159
|
* </li>
|
|
2179
2160
|
* <li>
|
|
2180
|
-
*
|
|
2181
|
-
*
|
|
2182
|
-
*
|
|
2183
|
-
*
|
|
2184
|
-
*
|
|
2185
|
-
*
|
|
2186
|
-
*
|
|
2161
|
+
* <p>HTTP</p>
|
|
2162
|
+
* <ul>
|
|
2163
|
+
* <li>
|
|
2164
|
+
* <p>
|
|
2165
|
+
* <code>HTTPSuccessFeedbackRoleArn</code> – Indicates successful
|
|
2166
|
+
* message delivery status for an Amazon SNS topic that is subscribed to an HTTP
|
|
2167
|
+
* endpoint. </p>
|
|
2168
|
+
* </li>
|
|
2169
|
+
* <li>
|
|
2170
|
+
* <p>
|
|
2171
|
+
* <code>HTTPSuccessFeedbackSampleRate</code> – Indicates
|
|
2172
|
+
* percentage of successful messages to sample for an Amazon SNS topic that is
|
|
2173
|
+
* subscribed to an HTTP endpoint.</p>
|
|
2174
|
+
* </li>
|
|
2175
|
+
* <li>
|
|
2176
|
+
* <p>
|
|
2177
|
+
* <code>HTTPFailureFeedbackRoleArn</code> – Indicates failed
|
|
2178
|
+
* message delivery status for an Amazon SNS topic that is subscribed to an HTTP
|
|
2179
|
+
* endpoint.</p>
|
|
2180
|
+
* </li>
|
|
2181
|
+
* </ul>
|
|
2182
|
+
* </li>
|
|
2183
|
+
* <li>
|
|
2184
|
+
* <p>Amazon Kinesis Data Firehose</p>
|
|
2185
|
+
* <ul>
|
|
2186
|
+
* <li>
|
|
2187
|
+
* <p>
|
|
2188
|
+
* <code>FirehoseSuccessFeedbackRoleArn</code> – Indicates
|
|
2189
|
+
* successful message delivery status for an Amazon SNS topic that is subscribed
|
|
2190
|
+
* to an Amazon Kinesis Data Firehose endpoint.</p>
|
|
2191
|
+
* </li>
|
|
2192
|
+
* <li>
|
|
2193
|
+
* <p>
|
|
2194
|
+
* <code>FirehoseSuccessFeedbackSampleRate</code> – Indicates
|
|
2195
|
+
* percentage of successful messages to sample for an Amazon SNS topic that is
|
|
2196
|
+
* subscribed to an Amazon Kinesis Data Firehose endpoint.</p>
|
|
2197
|
+
* </li>
|
|
2198
|
+
* <li>
|
|
2199
|
+
* <p>
|
|
2200
|
+
* <code>FirehoseFailureFeedbackRoleArn</code> – Indicates failed
|
|
2201
|
+
* message delivery status for an Amazon SNS topic that is subscribed to an
|
|
2202
|
+
* Amazon Kinesis Data Firehose endpoint. </p>
|
|
2203
|
+
* </li>
|
|
2204
|
+
* </ul>
|
|
2205
|
+
* </li>
|
|
2206
|
+
* <li>
|
|
2207
|
+
* <p>Lambda</p>
|
|
2208
|
+
* <ul>
|
|
2209
|
+
* <li>
|
|
2210
|
+
* <p>
|
|
2211
|
+
* <code>LambdaSuccessFeedbackRoleArn</code> – Indicates
|
|
2212
|
+
* successful message delivery status for an Amazon SNS topic that is subscribed
|
|
2213
|
+
* to an Lambda endpoint.</p>
|
|
2214
|
+
* </li>
|
|
2215
|
+
* <li>
|
|
2216
|
+
* <p>
|
|
2217
|
+
* <code>LambdaSuccessFeedbackSampleRate</code> – Indicates
|
|
2218
|
+
* percentage of successful messages to sample for an Amazon SNS topic that is
|
|
2219
|
+
* subscribed to an Lambda endpoint.</p>
|
|
2220
|
+
* </li>
|
|
2221
|
+
* <li>
|
|
2222
|
+
* <p>
|
|
2223
|
+
* <code>LambdaFailureFeedbackRoleArn</code> – Indicates failed
|
|
2224
|
+
* message delivery status for an Amazon SNS topic that is subscribed to an
|
|
2225
|
+
* Lambda endpoint. </p>
|
|
2226
|
+
* </li>
|
|
2227
|
+
* </ul>
|
|
2228
|
+
* </li>
|
|
2229
|
+
* <li>
|
|
2230
|
+
* <p>Platform application endpoint</p>
|
|
2231
|
+
* <ul>
|
|
2232
|
+
* <li>
|
|
2233
|
+
* <p>
|
|
2234
|
+
* <code>ApplicationSuccessFeedbackRoleArn</code> – Indicates
|
|
2235
|
+
* successful message delivery status for an Amazon SNS topic that is subscribed
|
|
2236
|
+
* to an Amazon Web Services application endpoint.</p>
|
|
2237
|
+
* </li>
|
|
2238
|
+
* <li>
|
|
2239
|
+
* <p>
|
|
2240
|
+
* <code>ApplicationSuccessFeedbackSampleRate</code> – Indicates
|
|
2241
|
+
* percentage of successful messages to sample for an Amazon SNS topic that is
|
|
2242
|
+
* subscribed to an Amazon Web Services application endpoint.</p>
|
|
2243
|
+
* </li>
|
|
2244
|
+
* <li>
|
|
2245
|
+
* <p>
|
|
2246
|
+
* <code>ApplicationFailureFeedbackRoleArn</code> – Indicates failed
|
|
2247
|
+
* message delivery status for an Amazon SNS topic that is subscribed to an
|
|
2248
|
+
* Amazon Web Services application endpoint.</p>
|
|
2249
|
+
* </li>
|
|
2250
|
+
* </ul>
|
|
2251
|
+
* <note>
|
|
2252
|
+
* <p>In addition to being able to configure topic attributes for message
|
|
2253
|
+
* delivery status of notification messages sent to Amazon SNS application
|
|
2254
|
+
* endpoints, you can also configure application attributes for the
|
|
2255
|
+
* delivery status of push notification messages sent to push notification
|
|
2256
|
+
* services.</p>
|
|
2257
|
+
* <p>For example, For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html">Using Amazon SNS Application
|
|
2258
|
+
* Attributes for Message Delivery Status</a>. </p>
|
|
2259
|
+
* </note>
|
|
2260
|
+
* </li>
|
|
2261
|
+
* <li>
|
|
2262
|
+
* <p>Amazon SQS</p>
|
|
2263
|
+
* <ul>
|
|
2264
|
+
* <li>
|
|
2265
|
+
* <p>
|
|
2266
|
+
* <code>SQSSuccessFeedbackRoleArn</code> – Indicates successful
|
|
2267
|
+
* message delivery status for an Amazon SNS topic that is subscribed to an
|
|
2268
|
+
* Amazon SQS endpoint. </p>
|
|
2269
|
+
* </li>
|
|
2270
|
+
* <li>
|
|
2271
|
+
* <p>
|
|
2272
|
+
* <code>SQSSuccessFeedbackSampleRate</code> – Indicates
|
|
2273
|
+
* percentage of successful messages to sample for an Amazon SNS topic that is
|
|
2274
|
+
* subscribed to an Amazon SQS endpoint. </p>
|
|
2275
|
+
* </li>
|
|
2276
|
+
* <li>
|
|
2277
|
+
* <p>
|
|
2278
|
+
* <code>SQSFailureFeedbackRoleArn</code> – Indicates failed
|
|
2279
|
+
* message delivery status for an Amazon SNS topic that is subscribed to an
|
|
2280
|
+
* Amazon SQS endpoint. </p>
|
|
2281
|
+
* </li>
|
|
2282
|
+
* </ul>
|
|
2187
2283
|
* </li>
|
|
2188
2284
|
* </ul>
|
|
2189
|
-
*
|
|
2190
|
-
*
|
|
2191
|
-
*
|
|
2285
|
+
* <note>
|
|
2286
|
+
* <p>The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn
|
|
2287
|
+
* attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
|
|
2288
|
+
* The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate
|
|
2289
|
+
* percentage (0-100) of successfully delivered messages. After you configure the
|
|
2290
|
+
* <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries
|
|
2291
|
+
* generate CloudWatch Logs. </p>
|
|
2292
|
+
* </note>
|
|
2293
|
+
* <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>
|
|
2294
|
+
* <ul>
|
|
2192
2295
|
* <li>
|
|
2193
|
-
*
|
|
2194
|
-
*
|
|
2296
|
+
* <p>
|
|
2297
|
+
* <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master
|
|
2195
2298
|
* 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
|
|
2196
2299
|
* 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
2300
|
* </li>
|
|
2198
2301
|
* <li>
|
|
2199
|
-
*
|
|
2200
|
-
*
|
|
2302
|
+
* <p>
|
|
2303
|
+
* <code>SignatureVersion</code> – The signature version corresponds to the
|
|
2201
2304
|
* hashing algorithm used while creating the signature of the notifications,
|
|
2202
2305
|
* subscription confirmations, or unsubscribe confirmation messages sent by
|
|
2203
2306
|
* Amazon SNS.</p>
|
|
2204
2307
|
* </li>
|
|
2205
2308
|
* </ul>
|
|
2206
|
-
*
|
|
2207
|
-
*
|
|
2208
|
-
* <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</p>
|
|
2209
|
-
* <ul>
|
|
2309
|
+
* <p>The following attribute applies only to <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">FIFO topics</a>:</p>
|
|
2310
|
+
* <ul>
|
|
2210
2311
|
* <li>
|
|
2211
2312
|
* <p>
|
|
2212
|
-
*
|
|
2313
|
+
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication for
|
|
2213
2314
|
* FIFO topics.</p>
|
|
2214
|
-
*
|
|
2215
|
-
* <ul>
|
|
2315
|
+
* <ul>
|
|
2216
2316
|
* <li>
|
|
2217
|
-
*
|
|
2317
|
+
* <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>.
|
|
2218
2318
|
* If you create a FIFO topic and this attribute is <code>false</code>, you must
|
|
2219
2319
|
* specify a value for the <code>MessageDeduplicationId</code> parameter for the
|
|
2220
2320
|
* <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p>
|
|
2221
|
-
*
|
|
2321
|
+
* </li>
|
|
2222
2322
|
* <li>
|
|
2223
|
-
*
|
|
2323
|
+
* <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>,
|
|
2224
2324
|
* Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using
|
|
2225
2325
|
* the body of the message (but not the attributes of the message).</p>
|
|
2226
|
-
*
|
|
2326
|
+
* <p>(Optional) To override the generated value, you can specify a value
|
|
2227
2327
|
* for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code>
|
|
2228
2328
|
* action.</p>
|
|
2229
|
-
*
|
|
2329
|
+
* </li>
|
|
2230
2330
|
* </ul>
|
|
2231
2331
|
* </li>
|
|
2232
2332
|
* </ul>
|
|
@@ -2247,47 +2347,47 @@ export interface SubscribeInput {
|
|
|
2247
2347
|
TopicArn: string | undefined;
|
|
2248
2348
|
/**
|
|
2249
2349
|
* <p>The protocol that you want to use. Supported protocols include:</p>
|
|
2250
|
-
*
|
|
2350
|
+
* <ul>
|
|
2251
2351
|
* <li>
|
|
2252
|
-
*
|
|
2352
|
+
* <p>
|
|
2253
2353
|
* <code>http</code> – delivery of JSON-encoded message via HTTP
|
|
2254
2354
|
* POST</p>
|
|
2255
2355
|
* </li>
|
|
2256
2356
|
* <li>
|
|
2257
|
-
*
|
|
2357
|
+
* <p>
|
|
2258
2358
|
* <code>https</code> – delivery of JSON-encoded message via HTTPS
|
|
2259
2359
|
* POST</p>
|
|
2260
2360
|
* </li>
|
|
2261
2361
|
* <li>
|
|
2262
|
-
*
|
|
2362
|
+
* <p>
|
|
2263
2363
|
* <code>email</code> – delivery of message via SMTP</p>
|
|
2264
2364
|
* </li>
|
|
2265
2365
|
* <li>
|
|
2266
|
-
*
|
|
2366
|
+
* <p>
|
|
2267
2367
|
* <code>email-json</code> – delivery of JSON-encoded message via
|
|
2268
2368
|
* SMTP</p>
|
|
2269
2369
|
* </li>
|
|
2270
2370
|
* <li>
|
|
2271
|
-
*
|
|
2371
|
+
* <p>
|
|
2272
2372
|
* <code>sms</code> – delivery of message via SMS</p>
|
|
2273
2373
|
* </li>
|
|
2274
2374
|
* <li>
|
|
2275
|
-
*
|
|
2375
|
+
* <p>
|
|
2276
2376
|
* <code>sqs</code> – delivery of JSON-encoded message to an Amazon SQS
|
|
2277
2377
|
* queue</p>
|
|
2278
2378
|
* </li>
|
|
2279
2379
|
* <li>
|
|
2280
|
-
*
|
|
2380
|
+
* <p>
|
|
2281
2381
|
* <code>application</code> – delivery of JSON-encoded message to an
|
|
2282
2382
|
* EndpointArn for a mobile app and device</p>
|
|
2283
2383
|
* </li>
|
|
2284
2384
|
* <li>
|
|
2285
|
-
*
|
|
2385
|
+
* <p>
|
|
2286
2386
|
* <code>lambda</code> – delivery of JSON-encoded message to an Lambda
|
|
2287
2387
|
* function</p>
|
|
2288
2388
|
* </li>
|
|
2289
2389
|
* <li>
|
|
2290
|
-
*
|
|
2390
|
+
* <p>
|
|
2291
2391
|
* <code>firehose</code> – delivery of JSON-encoded message to an Amazon
|
|
2292
2392
|
* Kinesis Data Firehose delivery stream.</p>
|
|
2293
2393
|
* </li>
|
|
@@ -2297,40 +2397,40 @@ export interface SubscribeInput {
|
|
|
2297
2397
|
/**
|
|
2298
2398
|
* <p>The endpoint that you want to receive notifications. Endpoints vary by
|
|
2299
2399
|
* protocol:</p>
|
|
2300
|
-
*
|
|
2400
|
+
* <ul>
|
|
2301
2401
|
* <li>
|
|
2302
|
-
*
|
|
2402
|
+
* <p>For the <code>http</code> protocol, the (public) endpoint is a URL beginning
|
|
2303
2403
|
* with <code>http://</code>.</p>
|
|
2304
2404
|
* </li>
|
|
2305
2405
|
* <li>
|
|
2306
|
-
*
|
|
2406
|
+
* <p>For the <code>https</code> protocol, the (public) endpoint is a URL beginning
|
|
2307
2407
|
* with <code>https://</code>.</p>
|
|
2308
2408
|
* </li>
|
|
2309
2409
|
* <li>
|
|
2310
|
-
*
|
|
2410
|
+
* <p>For the <code>email</code> protocol, the endpoint is an email address.</p>
|
|
2311
2411
|
* </li>
|
|
2312
2412
|
* <li>
|
|
2313
|
-
*
|
|
2413
|
+
* <p>For the <code>email-json</code> protocol, the endpoint is an email
|
|
2314
2414
|
* address.</p>
|
|
2315
2415
|
* </li>
|
|
2316
2416
|
* <li>
|
|
2317
|
-
*
|
|
2417
|
+
* <p>For the <code>sms</code> protocol, the endpoint is a phone number of an
|
|
2318
2418
|
* SMS-enabled device.</p>
|
|
2319
2419
|
* </li>
|
|
2320
2420
|
* <li>
|
|
2321
|
-
*
|
|
2421
|
+
* <p>For the <code>sqs</code> protocol, the endpoint is the ARN of an Amazon SQS
|
|
2322
2422
|
* queue.</p>
|
|
2323
2423
|
* </li>
|
|
2324
2424
|
* <li>
|
|
2325
|
-
*
|
|
2425
|
+
* <p>For the <code>application</code> protocol, the endpoint is the EndpointArn of
|
|
2326
2426
|
* a mobile app and device.</p>
|
|
2327
2427
|
* </li>
|
|
2328
2428
|
* <li>
|
|
2329
|
-
*
|
|
2429
|
+
* <p>For the <code>lambda</code> protocol, the endpoint is the ARN of an Lambda
|
|
2330
2430
|
* function.</p>
|
|
2331
2431
|
* </li>
|
|
2332
2432
|
* <li>
|
|
2333
|
-
*
|
|
2433
|
+
* <p>For the <code>firehose</code> protocol, the endpoint is the ARN of an Amazon
|
|
2334
2434
|
* Kinesis Data Firehose delivery stream.</p>
|
|
2335
2435
|
* </li>
|
|
2336
2436
|
* </ul>
|
|
@@ -2338,82 +2438,83 @@ export interface SubscribeInput {
|
|
|
2338
2438
|
Endpoint?: string;
|
|
2339
2439
|
/**
|
|
2340
2440
|
* <p>A map of attributes with their corresponding values.</p>
|
|
2341
|
-
*
|
|
2441
|
+
* <p>The following lists the names, descriptions, and values of the special request
|
|
2342
2442
|
* parameters that the <code>Subscribe</code> action uses:</p>
|
|
2343
|
-
*
|
|
2443
|
+
* <ul>
|
|
2344
2444
|
* <li>
|
|
2345
|
-
*
|
|
2445
|
+
* <p>
|
|
2346
2446
|
* <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries
|
|
2347
2447
|
* failed deliveries to HTTP/S endpoints.</p>
|
|
2348
2448
|
* </li>
|
|
2349
2449
|
* <li>
|
|
2350
|
-
*
|
|
2450
|
+
* <p>
|
|
2351
2451
|
* <code>FilterPolicy</code> – The simple JSON object that lets your
|
|
2352
2452
|
* subscriber receive only a subset of messages, rather than receiving every
|
|
2353
2453
|
* message published to the topic.</p>
|
|
2354
2454
|
* </li>
|
|
2355
2455
|
* <li>
|
|
2356
|
-
*
|
|
2357
|
-
* <code>FilterPolicyScope</code> – This attribute lets you choose the
|
|
2358
|
-
*
|
|
2456
|
+
* <p>
|
|
2457
|
+
* <code>FilterPolicyScope</code> – This attribute lets you choose the
|
|
2458
|
+
* filtering scope by using one of the following string value types:</p>
|
|
2459
|
+
* <ul>
|
|
2359
2460
|
* <li>
|
|
2360
2461
|
* <p>
|
|
2361
|
-
* <code>MessageAttributes</code> (default) – The filter is
|
|
2462
|
+
* <code>MessageAttributes</code> (default) – The filter is
|
|
2463
|
+
* applied on the message attributes.</p>
|
|
2362
2464
|
* </li>
|
|
2363
2465
|
* <li>
|
|
2364
2466
|
* <p>
|
|
2365
|
-
* <code>MessageBody</code> – The filter is applied on the message
|
|
2467
|
+
* <code>MessageBody</code> – The filter is applied on the message
|
|
2468
|
+
* body.</p>
|
|
2366
2469
|
* </li>
|
|
2367
2470
|
* </ul>
|
|
2368
2471
|
* </li>
|
|
2369
2472
|
* <li>
|
|
2370
|
-
*
|
|
2473
|
+
* <p>
|
|
2371
2474
|
* <code>RawMessageDelivery</code> – When set to <code>true</code>,
|
|
2372
2475
|
* enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the
|
|
2373
2476
|
* need for the endpoints to process JSON formatting, which is otherwise created
|
|
2374
2477
|
* for Amazon SNS metadata.</p>
|
|
2375
2478
|
* </li>
|
|
2376
2479
|
* <li>
|
|
2377
|
-
*
|
|
2480
|
+
* <p>
|
|
2378
2481
|
* <code>RedrivePolicy</code> – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.
|
|
2379
2482
|
* Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)
|
|
2380
2483
|
* or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held
|
|
2381
2484
|
* in the dead-letter queue for further analysis or reprocessing.</p>
|
|
2382
2485
|
* </li>
|
|
2383
2486
|
* </ul>
|
|
2384
|
-
*
|
|
2385
|
-
*
|
|
2386
|
-
* <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
|
|
2487
|
+
* <p>The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:</p>
|
|
2387
2488
|
* <ul>
|
|
2388
2489
|
* <li>
|
|
2389
2490
|
* <p>
|
|
2390
2491
|
* <code>SubscriptionRoleArn</code> – The ARN of the IAM role that has the following:</p>
|
|
2391
|
-
*
|
|
2492
|
+
* <ul>
|
|
2392
2493
|
* <li>
|
|
2393
|
-
*
|
|
2394
|
-
*
|
|
2494
|
+
* <p>Permission to write to the Kinesis Data Firehose delivery stream</p>
|
|
2495
|
+
* </li>
|
|
2395
2496
|
* <li>
|
|
2396
|
-
*
|
|
2397
|
-
*
|
|
2497
|
+
* <p>Amazon SNS listed as a trusted entity</p>
|
|
2498
|
+
* </li>
|
|
2398
2499
|
* </ul>
|
|
2399
|
-
*
|
|
2500
|
+
* <p>Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions.
|
|
2400
2501
|
* For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html">Fanout
|
|
2401
2502
|
* to Kinesis Data Firehose delivery streams</a> in the <i>Amazon SNS Developer Guide</i>.</p>
|
|
2402
|
-
*
|
|
2503
|
+
* </li>
|
|
2403
2504
|
* </ul>
|
|
2404
2505
|
*/
|
|
2405
2506
|
Attributes?: Record<string, string>;
|
|
2406
2507
|
/**
|
|
2407
2508
|
* <p>Sets whether the response from the <code>Subscribe</code> request includes the
|
|
2408
2509
|
* subscription ARN, even if the subscription is not yet confirmed.</p>
|
|
2409
|
-
*
|
|
2510
|
+
* <p>If you set this parameter to <code>true</code>, the response includes the ARN in all
|
|
2410
2511
|
* cases, even if the subscription is not yet confirmed. In addition to the ARN for
|
|
2411
2512
|
* confirmed subscriptions, the response also includes the <code>pending
|
|
2412
2513
|
* subscription</code> ARN value for subscriptions that aren't yet confirmed. A
|
|
2413
2514
|
* subscription becomes confirmed when the subscriber calls the
|
|
2414
2515
|
* <code>ConfirmSubscription</code> action with a confirmation token.</p>
|
|
2415
|
-
*
|
|
2416
|
-
*
|
|
2516
|
+
* <p></p>
|
|
2517
|
+
* <p>The default value is <code>false</code>.</p>
|
|
2417
2518
|
*/
|
|
2418
2519
|
ReturnSubscriptionArn?: boolean;
|
|
2419
2520
|
}
|