Skip to content

Commit 54e4623

Browse files
author
awstools
committed
docs(client-sns): ArchivePolicy attribute added to Archive and Replay feature
1 parent 13fd8a4 commit 54e4623

File tree

3 files changed

+76
-59
lines changed

3 files changed

+76
-59
lines changed

‎clients/client-sns/src/commands/CreatePlatformApplicationCommand.ts‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp
3838
* the notification service.</p>
3939
* <ul>
4040
* <li>
41-
* <p>For ADM, <code>PlatformPrincipal</code> is <code>client id</code>
42-
* and <code>PlatformCredential</code> is <code>client secret</code>.</p>
41+
* <p>For ADM, <code>PlatformPrincipal</code> is <code>client id</code> and
42+
* <code>PlatformCredential</code> is <code>client secret</code>.</p>
4343
* </li>
4444
* <li>
45-
* <p>For APNS and <code>APNS_SANDBOX</code> using certificate
46-
* credentials, <code>PlatformPrincipal</code> is <code>SSL certificate</code> and
45+
* <p>For APNS and <code>APNS_SANDBOX</code> using certificate credentials,
46+
* <code>PlatformPrincipal</code> is <code>SSL certificate</code> and
4747
* <code>PlatformCredential</code> is <code>private key</code>.</p>
4848
* </li>
4949
* <li>
@@ -52,8 +52,8 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp
5252
* <code>PlatformCredential</code> is <code>signing key</code>.</p>
5353
* </li>
5454
* <li>
55-
* <p>For Baidu, <code>PlatformPrincipal</code> is <code>API key</code>
56-
* and <code>PlatformCredential</code> is <code>secret key</code>.</p>
55+
* <p>For Baidu, <code>PlatformPrincipal</code> is <code>API key</code> and
56+
* <code>PlatformCredential</code> is <code>secret key</code>.</p>
5757
* </li>
5858
* <li>
5959
* <p>For GCM (Firebase Cloud Messaging) using key credentials, there is no
@@ -69,9 +69,8 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp
6969
* @json <<< cat service.json`</code>.</p>
7070
* </li>
7171
* <li>
72-
* <p>For MPNS, <code>PlatformPrincipal</code> is <code>TLS
73-
* certificate</code> and <code>PlatformCredential</code> is <code>private
74-
* key</code>.</p>
72+
* <p>For MPNS, <code>PlatformPrincipal</code> is <code>TLS certificate</code> and
73+
* <code>PlatformCredential</code> is <code>private key</code>.</p>
7574
* </li>
7675
* <li>
7776
* <p>For WNS, <code>PlatformPrincipal</code> is <code>Package Security

‎clients/client-sns/src/models/models_0.ts‎

Lines changed: 64 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -515,8 +515,8 @@ export interface CreateTopicInput {
515515

516516
/**
517517
* <p>A map of attributes with their corresponding values.</p>
518-
* <p>The following lists names, descriptions, and values of the special request
519-
* parameters that the <code>CreateTopic</code> action uses:</p>
518+
* <p>The following lists names, descriptions, and values of the special request parameters
519+
* that the <code>CreateTopic</code> action uses:</p>
520520
* <ul>
521521
* <li>
522522
* <p>
@@ -569,34 +569,30 @@ export interface CreateTopicInput {
569569
* <ul>
570570
* <li>
571571
* <p>
572-
* <code>ArchivePolicy</code> – Adds or updates an inline policy document
573-
* to archive messages stored in the specified Amazon SNS topic.</p>
572+
* <code>ArchivePolicy</code> – The policy that sets the retention period
573+
* for messages stored in the message archive of an Amazon SNS FIFO
574+
* topic.</p>
574575
* </li>
575576
* <li>
576577
* <p>
577-
* <code>BeginningArchiveTime</code> – The earliest starting point at
578-
* which a message in the topic’s archive can be replayed from. This point in time
579-
* is based on the configured message retention period set by the topic’s message
580-
* archiving policy.</p>
581-
* </li>
582-
* <li>
583-
* <p>
584-
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication for
585-
* FIFO topics.</p>
578+
* <code>ContentBasedDeduplication</code> – Enables content-based
579+
* deduplication for FIFO topics.</p>
586580
* <ul>
587581
* <li>
588-
* <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>.
589-
* If you create a FIFO topic and this attribute is <code>false</code>, you must
590-
* specify a value for the <code>MessageDeduplicationId</code> parameter for the
591-
* <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p>
582+
* <p>By default, <code>ContentBasedDeduplication</code> is set to
583+
* <code>false</code>. If you create a FIFO topic and this attribute is
584+
* <code>false</code>, you must specify a value for the
585+
* <code>MessageDeduplicationId</code> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a>
586+
* action. </p>
592587
* </li>
593588
* <li>
594589
* <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>,
595-
* Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using
596-
* the body of the message (but not the attributes of the message).</p>
597-
* <p>(Optional) To override the generated value, you can specify a value
598-
* for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code>
599-
* action.</p>
590+
* Amazon SNS uses a SHA-256 hash to generate the
591+
* <code>MessageDeduplicationId</code> using the body of the message (but not
592+
* the attributes of the message).</p>
593+
* <p>(Optional) To override the generated value, you can specify a value for the
594+
* <code>MessageDeduplicationId</code> parameter for the <code>Publish</code>
595+
* action.</p>
600596
* </li>
601597
* </ul>
602598
* </li>
@@ -1255,30 +1251,44 @@ export interface GetTopicAttributesResponse {
12551251
* <ul>
12561252
* <li>
12571253
* <p>
1258-
* <code>FifoTopic</code> – When this is set to <code>true</code>, a FIFO
1259-
* topic is created.</p>
1254+
* <code>ArchivePolicy</code> – The policy that sets the retention period
1255+
* for messages stored in the message archive of an Amazon SNS FIFO
1256+
* topic.</p>
1257+
* </li>
1258+
* <li>
1259+
* <p>
1260+
* <code>BeginningArchiveTime</code> – The earliest starting point at
1261+
* which a message in the topic’s archive can be replayed from. This point in time
1262+
* is based on the configured message retention period set by the topic’s message
1263+
* archiving policy.</p>
12601264
* </li>
12611265
* <li>
12621266
* <p>
1263-
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication for
1264-
* FIFO topics.</p>
1267+
* <code>ContentBasedDeduplication</code> – Enables content-based
1268+
* deduplication for FIFO topics.</p>
12651269
* <ul>
12661270
* <li>
1267-
* <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>.
1268-
* If you create a FIFO topic and this attribute is <code>false</code>, you must
1269-
* specify a value for the <code>MessageDeduplicationId</code> parameter for the
1270-
* <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p>
1271+
* <p>By default, <code>ContentBasedDeduplication</code> is set to
1272+
* <code>false</code>. If you create a FIFO topic and this attribute is
1273+
* <code>false</code>, you must specify a value for the
1274+
* <code>MessageDeduplicationId</code> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p>
12711275
* </li>
12721276
* <li>
1273-
* <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>,
1274-
* Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using
1275-
* the body of the message (but not the attributes of the message).</p>
1277+
* <p>When you set <code>ContentBasedDeduplication</code> to
1278+
* <code>true</code>, Amazon SNS uses a SHA-256 hash to
1279+
* generate the <code>MessageDeduplicationId</code> using the body of the
1280+
* message (but not the attributes of the message).</p>
12761281
* <p>(Optional) To override the generated value, you can specify a value
1277-
* for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code>
1278-
* action.</p>
1282+
* for the <code>MessageDeduplicationId</code> parameter for the
1283+
* <code>Publish</code> action.</p>
12791284
* </li>
12801285
* </ul>
12811286
* </li>
1287+
* <li>
1288+
* <p>
1289+
* <code>FifoTopic</code> – When this is set to <code>true</code>, a FIFO
1290+
* topic is created.</p>
1291+
* </li>
12821292
* </ul>
12831293
* @public
12841294
*/
@@ -3188,22 +3198,30 @@ export interface SetTopicAttributesInput {
31883198
* <ul>
31893199
* <li>
31903200
* <p>
3191-
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication for
3192-
* FIFO topics.</p>
3201+
* <code>ArchivePolicy</code> – The policy that sets the retention period
3202+
* for messages stored in the message archive of an Amazon SNS FIFO
3203+
* topic.</p>
3204+
* </li>
3205+
* <li>
3206+
* <p>
3207+
* <code>ContentBasedDeduplication</code> – Enables content-based
3208+
* deduplication for FIFO topics.</p>
31933209
* <ul>
31943210
* <li>
3195-
* <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>.
3196-
* If you create a FIFO topic and this attribute is <code>false</code>, you must
3197-
* specify a value for the <code>MessageDeduplicationId</code> parameter for the
3198-
* <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p>
3211+
* <p>By default, <code>ContentBasedDeduplication</code> is set to
3212+
* <code>false</code>. If you create a FIFO topic and this attribute is
3213+
* <code>false</code>, you must specify a value for the
3214+
* <code>MessageDeduplicationId</code> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a>
3215+
* action. </p>
31993216
* </li>
32003217
* <li>
32013218
* <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>,
3202-
* Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using
3203-
* the body of the message (but not the attributes of the message).</p>
3204-
* <p>(Optional) To override the generated value, you can specify a value
3205-
* for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code>
3206-
* action.</p>
3219+
* Amazon SNS uses a SHA-256 hash to generate the
3220+
* <code>MessageDeduplicationId</code> using the body of the message (but not
3221+
* the attributes of the message).</p>
3222+
* <p>(Optional) To override the generated value, you can specify a value for the
3223+
* <code>MessageDeduplicationId</code> parameter for the <code>Publish</code>
3224+
* action.</p>
32073225
* </li>
32083226
* </ul>
32093227
* </li>

0 commit comments

Comments
 (0)