@aws-sdk/client-sns 3.1133.0 → 3.1135.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/index.js +1 -1
- package/dist-types/commands/GetDataProtectionPolicyCommand.d.ts +6 -1
- package/dist-types/commands/PublishBatchCommand.d.ts +10 -3
- package/dist-types/commands/PutDataProtectionPolicyCommand.d.ts +6 -1
- package/dist-types/models/models_0.d.ts +67 -10
- package/package.json +1 -1
package/dist-cjs/index.js
CHANGED
|
@@ -24,7 +24,12 @@ declare const GetDataProtectionPolicyCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <
|
|
27
|
+
* <important>
|
|
28
|
+
* <p>Amazon SNS message data protection is no longer available to new customers.
|
|
29
|
+
* For more information and guidance on alternatives, see
|
|
30
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-message-data-protection-availability-change.html">Amazon SNS message data protection availability change</a>.</p>
|
|
31
|
+
* </important>
|
|
32
|
+
* <p>Retrieves the specified inline <code>DataProtectionPolicy</code> document that is
|
|
28
33
|
* stored in the specified Amazon SNS topic. </p>
|
|
29
34
|
* @example
|
|
30
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -35,9 +35,16 @@ declare const PublishBatchCommand_base: {
|
|
|
35
35
|
* Because the batch request can result in a combination of successful and unsuccessful
|
|
36
36
|
* actions, you should check for batch errors even when the call returns an HTTP status
|
|
37
37
|
* code of 200.</p>
|
|
38
|
-
* <p>
|
|
39
|
-
* of the individual lengths of all of the batched messages) are both 256
|
|
40
|
-
* bytes)
|
|
38
|
+
* <p>By default, the maximum allowed individual message size and the maximum total payload
|
|
39
|
+
* size (the sum of the individual lengths of all of the batched messages) are both 256 KiB
|
|
40
|
+
* (262,144 bytes). To publish larger batches, set the topic's
|
|
41
|
+
* <code>MaximumMessageSize</code> attribute, which supports values up to 1 MiB
|
|
42
|
+
* (1,048,576 bytes). The combined size of all messages in the batch, including each
|
|
43
|
+
* message's body and attributes, must not exceed the topic's
|
|
44
|
+
* <code>MaximumMessageSize</code>.</p>
|
|
45
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/large-message-payloads.html">Large message payloads</a> in
|
|
46
|
+
* the <i>Amazon SNS Developer Guide.</i>
|
|
47
|
+
* </p>
|
|
41
48
|
* <important>
|
|
42
49
|
* <p>The <code>PublishBatch</code> API can send up to 10 messages at a time. If you
|
|
43
50
|
* attempt to send more than 10 messages in one request, you will encounter a
|
|
@@ -24,7 +24,12 @@ declare const PutDataProtectionPolicyCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <
|
|
27
|
+
* <important>
|
|
28
|
+
* <p>Amazon SNS message data protection is no longer available to new customers.
|
|
29
|
+
* For more information and guidance on alternatives, see
|
|
30
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-message-data-protection-availability-change.html">Amazon SNS message data protection availability change</a>.</p>
|
|
31
|
+
* </important>
|
|
32
|
+
* <p>Adds or updates an inline policy document that is stored in the specified Amazon SNS
|
|
28
33
|
* topic.</p>
|
|
29
34
|
* @example
|
|
30
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -245,8 +245,21 @@ export interface CreateTopicInput {
|
|
|
245
245
|
* </li>
|
|
246
246
|
* <li>
|
|
247
247
|
* <p>
|
|
248
|
-
* <code>DisplayName</code> – The display name to use for a topic with SMS
|
|
249
|
-
* subscriptions
|
|
248
|
+
* <code>DisplayName</code> – The display name to use for a topic with SMS,
|
|
249
|
+
* <code>email</code>, and <code>email-json</code> subscriptions. For <code>email</code> and <code>email-json</code> subscriptions,
|
|
250
|
+
* the display name is used as the sender name for regular notification messages.
|
|
251
|
+
* Subscription confirmation and unsubscribe confirmation emails always use
|
|
252
|
+
* "Amazon Web Services Notifications" as the sender name.</p>
|
|
253
|
+
* </li>
|
|
254
|
+
* <li>
|
|
255
|
+
* <p>
|
|
256
|
+
* <code>MaximumMessageSize</code> – The maximum
|
|
257
|
+
* size, in bytes, of a message that can be published to the topic. Valid values are
|
|
258
|
+
* <code>1024</code> to <code>1048576</code> (1 MiB). The default is
|
|
259
|
+
* <code>262144</code> (256 KiB).</p>
|
|
260
|
+
* <p>A topic with a <code>MaximumMessageSize</code> above 256 KiB must have 100 or
|
|
261
|
+
* fewer subscriptions, and each subscription must be an Amazon SQS, Amazon Data Firehose, or Lambda
|
|
262
|
+
* subscription.</p>
|
|
250
263
|
* </li>
|
|
251
264
|
* <li>
|
|
252
265
|
* <p>
|
|
@@ -467,7 +480,12 @@ export interface CreateTopicInput {
|
|
|
467
480
|
*/
|
|
468
481
|
Tags?: Tag[] | undefined;
|
|
469
482
|
/**
|
|
470
|
-
* <
|
|
483
|
+
* <important>
|
|
484
|
+
* <p>Amazon SNS message data protection is no longer available to new customers.
|
|
485
|
+
* For more information and guidance on alternatives, see
|
|
486
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-message-data-protection-availability-change.html">Amazon SNS message data protection availability change</a>.</p>
|
|
487
|
+
* </important>
|
|
488
|
+
* <p>The body of the policy document you want to use for this topic.</p>
|
|
471
489
|
* <p>You can only add one policy per topic.</p>
|
|
472
490
|
* <p>The policy must be in JSON string format.</p>
|
|
473
491
|
* <p>Length Constraints: Maximum length of 30,720.</p>
|
|
@@ -864,7 +882,9 @@ export interface GetTopicAttributesResponse {
|
|
|
864
882
|
* <p>
|
|
865
883
|
* <code>DisplayName</code> – The human-readable name used in the
|
|
866
884
|
* <code>From</code> field for notifications to <code>email</code> and
|
|
867
|
-
* <code>email-json</code> endpoints
|
|
885
|
+
* <code>email-json</code> endpoints. For subscription confirmation and
|
|
886
|
+
* unsubscribe confirmation emails, the sender name is always
|
|
887
|
+
* "Amazon Web Services Notifications" regardless of this attribute.</p>
|
|
868
888
|
* </li>
|
|
869
889
|
* <li>
|
|
870
890
|
* <p>
|
|
@@ -873,6 +893,13 @@ export interface GetTopicAttributesResponse {
|
|
|
873
893
|
* </li>
|
|
874
894
|
* <li>
|
|
875
895
|
* <p>
|
|
896
|
+
* <code>MaximumMessageSize</code> – The maximum size, in bytes, of a
|
|
897
|
+
* message that can be published to the topic. Amazon SNS returns this attribute only if
|
|
898
|
+
* you explicitly set it. If Amazon SNS doesn't return it, the topic uses the default of
|
|
899
|
+
* <code>262144</code> (256 KiB).</p>
|
|
900
|
+
* </li>
|
|
901
|
+
* <li>
|
|
902
|
+
* <p>
|
|
876
903
|
* <code>Owner</code> – The Amazon Web Services account ID of the topic's owner.</p>
|
|
877
904
|
* </li>
|
|
878
905
|
* <li>
|
|
@@ -1423,8 +1450,10 @@ export interface OptInPhoneNumberResponse {
|
|
|
1423
1450
|
* <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a>.</p>
|
|
1424
1451
|
* <p>Name, type, and value must not be empty or null. In addition, the message body should
|
|
1425
1452
|
* not be empty or null. All parts of the message attribute, including name, type, and
|
|
1426
|
-
* value, are included in the message size restriction, which is
|
|
1427
|
-
*
|
|
1453
|
+
* value, are included in the message size restriction, which is 256 KiB (262,144 bytes) by
|
|
1454
|
+
* default and is determined by the topic's <code>MaximumMessageSize</code> attribute. For
|
|
1455
|
+
* more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/large-message-payloads.html">Large message payloads</a>,
|
|
1456
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html">Amazon SNS message attributes</a> and
|
|
1428
1457
|
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html">Publishing
|
|
1429
1458
|
* to a mobile phone</a> in the <i>Amazon SNS Developer Guide.</i>
|
|
1430
1459
|
* </p>
|
|
@@ -1490,8 +1519,17 @@ export interface PublishInput {
|
|
|
1490
1519
|
* <p>Constraints:</p>
|
|
1491
1520
|
* <ul>
|
|
1492
1521
|
* <li>
|
|
1493
|
-
* <p>With the exception of SMS, messages must be UTF-8 encoded strings
|
|
1494
|
-
* 256
|
|
1522
|
+
* <p>With the exception of SMS, messages must be UTF-8 encoded strings. By default,
|
|
1523
|
+
* a message can be at most 256 KiB in size (262,144 bytes, not 262,144
|
|
1524
|
+
* characters).</p>
|
|
1525
|
+
* <p>When you publish to a topic, the maximum size is determined by the topic's
|
|
1526
|
+
* <code>MaximumMessageSize</code> attribute, which supports values up to 1 MiB
|
|
1527
|
+
* (1,048,576 bytes). Amazon SNS validates the combined size of the message body and
|
|
1528
|
+
* message attributes against this value and returns an
|
|
1529
|
+
* <code>InvalidParameter</code> error if the limit is exceeded.</p>
|
|
1530
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/large-message-payloads.html">Large message
|
|
1531
|
+
* payloads</a> in the <i>Amazon SNS Developer Guide.</i>
|
|
1532
|
+
* </p>
|
|
1495
1533
|
* </li>
|
|
1496
1534
|
* <li>
|
|
1497
1535
|
* <p>For SMS, each message can contain up to 140 characters. This character limit
|
|
@@ -2334,8 +2372,27 @@ export interface SetTopicAttributesInput {
|
|
|
2334
2372
|
* </li>
|
|
2335
2373
|
* <li>
|
|
2336
2374
|
* <p>
|
|
2337
|
-
* <code>DisplayName</code> – The display name to use for a topic with SMS
|
|
2338
|
-
* subscriptions
|
|
2375
|
+
* <code>DisplayName</code> – The display name to use for a topic with SMS,
|
|
2376
|
+
* <code>email</code>, and <code>email-json</code> subscriptions. For <code>email</code> and <code>email-json</code> subscriptions,
|
|
2377
|
+
* the display name is used as the sender name for regular notification messages.
|
|
2378
|
+
* Subscription confirmation and unsubscribe confirmation emails always use
|
|
2379
|
+
* "Amazon Web Services Notifications" as the sender name.</p>
|
|
2380
|
+
* </li>
|
|
2381
|
+
* <li>
|
|
2382
|
+
* <p>
|
|
2383
|
+
* <code>MaximumMessageSize</code> – The maximum
|
|
2384
|
+
* size, in bytes, of a message that can be published to the topic. Valid values are
|
|
2385
|
+
* <code>1024</code> to <code>1048576</code> (1 MiB). The default is
|
|
2386
|
+
* <code>262144</code> (256 KiB).</p>
|
|
2387
|
+
* <p>A topic with a <code>MaximumMessageSize</code> above 256 KiB must have 100 or
|
|
2388
|
+
* fewer subscriptions, and each subscription must be an Amazon SQS, Amazon Data Firehose, or Lambda
|
|
2389
|
+
* subscription.</p>
|
|
2390
|
+
* <p>You can increase or decrease this value at any time. If the topic doesn't meet
|
|
2391
|
+
* these requirements when you set a value above 256 KiB, Amazon SNS returns an
|
|
2392
|
+
* <code>InvalidParameter</code> error. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/large-message-payloads.html">Large
|
|
2393
|
+
* message payloads</a> in the <i>Amazon SNS Developer
|
|
2394
|
+
* Guide.</i>
|
|
2395
|
+
* </p>
|
|
2339
2396
|
* </li>
|
|
2340
2397
|
* <li>
|
|
2341
2398
|
* <p>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-sns",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.1135.0",
|
|
4
4
|
"description": "AWS SDK for JavaScript Sns Client for Node.js, Browser and React Native",
|
|
5
5
|
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-sns",
|
|
6
6
|
"license": "Apache-2.0",
|