Skip to content

Commit

Permalink
docs(client-sns): ArchivePolicy attribute added to Archive and Replay…
Browse files Browse the repository at this point in the history 
… feature
  • Loading branch information
awstools committed Nov 22, 2024
1 parent 13fd8a4 commit 54e4623
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 59 deletions.
17 changes: 8 additions & 9 deletions clients/client-sns/src/commands/CreatePlatformApplicationCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp
* the notification service.</p>
* <ul>
* <li>
* <p>For ADM, <code>PlatformPrincipal</code> is <code>client id</code>
* and <code>PlatformCredential</code> is <code>client secret</code>.</p>
* <p>For ADM, <code>PlatformPrincipal</code> is <code>client id</code> and
* <code>PlatformCredential</code> is <code>client secret</code>.</p>
* </li>
* <li>
* <p>For APNS and <code>APNS_SANDBOX</code> using certificate
* credentials, <code>PlatformPrincipal</code> is <code>SSL certificate</code> and
* <p>For APNS and <code>APNS_SANDBOX</code> using certificate credentials,
* <code>PlatformPrincipal</code> is <code>SSL certificate</code> and
* <code>PlatformCredential</code> is <code>private key</code>.</p>
* </li>
* <li>
Expand All @@ -52,8 +52,8 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp
* <code>PlatformCredential</code> is <code>signing key</code>.</p>
* </li>
* <li>
* <p>For Baidu, <code>PlatformPrincipal</code> is <code>API key</code>
* and <code>PlatformCredential</code> is <code>secret key</code>.</p>
* <p>For Baidu, <code>PlatformPrincipal</code> is <code>API key</code> and
* <code>PlatformCredential</code> is <code>secret key</code>.</p>
* </li>
* <li>
* <p>For GCM (Firebase Cloud Messaging) using key credentials, there is no
Expand All @@ -69,9 +69,8 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp
* @json <<< cat service.json`</code>.</p>
* </li>
* <li>
* <p>For MPNS, <code>PlatformPrincipal</code> is <code>TLS
* certificate</code> and <code>PlatformCredential</code> is <code>private
* key</code>.</p>
* <p>For MPNS, <code>PlatformPrincipal</code> is <code>TLS certificate</code> and
* <code>PlatformCredential</code> is <code>private key</code>.</p>
* </li>
* <li>
* <p>For WNS, <code>PlatformPrincipal</code> is <code>Package Security
Expand Down
110 changes: 64 additions & 46 deletions clients/client-sns/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -515,8 +515,8 @@ export interface CreateTopicInput {

/**
* <p>A map of attributes with their corresponding values.</p>
* <p>The following lists names, descriptions, and values of the special request
* parameters that the <code>CreateTopic</code> action uses:</p>
* <p>The following lists names, descriptions, and values of the special request parameters
* that the <code>CreateTopic</code> action uses:</p>
* <ul>
* <li>
* <p>
Expand Down Expand Up @@ -569,34 +569,30 @@ export interface CreateTopicInput {
* <ul>
* <li>
* <p>
* <code>ArchivePolicy</code> – Adds or updates an inline policy document
* to archive messages stored in the specified Amazon SNS topic.</p>
* <code>ArchivePolicy</code> – The policy that sets the retention period
* for messages stored in the message archive of an Amazon SNS FIFO
* topic.</p>
* </li>
* <li>
* <p>
* <code>BeginningArchiveTime</code> – The earliest starting point at
* which a message in the topic’s archive can be replayed from. This point in time
* is based on the configured message retention period set by the topic’s message
* archiving policy.</p>
* </li>
* <li>
* <p>
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication for
* FIFO topics.</p>
* <code>ContentBasedDeduplication</code> – Enables content-based
* deduplication for FIFO topics.</p>
* <ul>
* <li>
* <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>.
* If you create a FIFO topic and this attribute is <code>false</code>, you must
* specify a value for the <code>MessageDeduplicationId</code> parameter for the
* <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p>
* <p>By default, <code>ContentBasedDeduplication</code> is set to
* <code>false</code>. If you create a FIFO topic and this attribute is
* <code>false</code>, you must specify a value for the
* <code>MessageDeduplicationId</code> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a>
* action. </p>
* </li>
* <li>
* <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>,
* Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using
* the body of the message (but not the attributes of the message).</p>
* <p>(Optional) To override the generated value, you can specify a value
* for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code>
* action.</p>
* Amazon SNS uses a SHA-256 hash to generate the
* <code>MessageDeduplicationId</code> using the body of the message (but not
* the attributes of the message).</p>
* <p>(Optional) To override the generated value, you can specify a value for the
* <code>MessageDeduplicationId</code> parameter for the <code>Publish</code>
* action.</p>
* </li>
* </ul>
* </li>
Expand Down Expand Up @@ -1255,30 +1251,44 @@ export interface GetTopicAttributesResponse {
* <ul>
* <li>
* <p>
* <code>FifoTopic</code> – When this is set to <code>true</code>, a FIFO
* topic is created.</p>
* <code>ArchivePolicy</code> – The policy that sets the retention period
* for messages stored in the message archive of an Amazon SNS FIFO
* topic.</p>
* </li>
* <li>
* <p>
* <code>BeginningArchiveTime</code> – The earliest starting point at
* which a message in the topic’s archive can be replayed from. This point in time
* is based on the configured message retention period set by the topic’s message
* archiving policy.</p>
* </li>
* <li>
* <p>
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication for
* FIFO topics.</p>
* <code>ContentBasedDeduplication</code> – Enables content-based
* deduplication for FIFO topics.</p>
* <ul>
* <li>
* <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>.
* If you create a FIFO topic and this attribute is <code>false</code>, you must
* specify a value for the <code>MessageDeduplicationId</code> parameter for the
* <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p>
* <p>By default, <code>ContentBasedDeduplication</code> is set to
* <code>false</code>. If you create a FIFO topic and this attribute is
* <code>false</code>, you must specify a value for the
* <code>MessageDeduplicationId</code> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p>
* </li>
* <li>
* <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>,
* Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using
* the body of the message (but not the attributes of the message).</p>
* <p>When you set <code>ContentBasedDeduplication</code> to
* <code>true</code>, Amazon SNS uses a SHA-256 hash to
* generate the <code>MessageDeduplicationId</code> using the body of the
* message (but not the attributes of the message).</p>
* <p>(Optional) To override the generated value, you can specify a value
* for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code>
* action.</p>
* for the <code>MessageDeduplicationId</code> parameter for the
* <code>Publish</code> action.</p>
* </li>
* </ul>
* </li>
* <li>
* <p>
* <code>FifoTopic</code> – When this is set to <code>true</code>, a FIFO
* topic is created.</p>
* </li>
* </ul>
* @public
*/
Expand Down Expand Up @@ -3188,22 +3198,30 @@ export interface SetTopicAttributesInput {
* <ul>
* <li>
* <p>
* <code>ContentBasedDeduplication</code> – Enables content-based deduplication for
* FIFO topics.</p>
* <code>ArchivePolicy</code> – The policy that sets the retention period
* for messages stored in the message archive of an Amazon SNS FIFO
* topic.</p>
* </li>
* <li>
* <p>
* <code>ContentBasedDeduplication</code> – Enables content-based
* deduplication for FIFO topics.</p>
* <ul>
* <li>
* <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>.
* If you create a FIFO topic and this attribute is <code>false</code>, you must
* specify a value for the <code>MessageDeduplicationId</code> parameter for the
* <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p>
* <p>By default, <code>ContentBasedDeduplication</code> is set to
* <code>false</code>. If you create a FIFO topic and this attribute is
* <code>false</code>, you must specify a value for the
* <code>MessageDeduplicationId</code> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a>
* action. </p>
* </li>
* <li>
* <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>,
* Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using
* the body of the message (but not the attributes of the message).</p>
* <p>(Optional) To override the generated value, you can specify a value
* for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code>
* action.</p>
* Amazon SNS uses a SHA-256 hash to generate the
* <code>MessageDeduplicationId</code> using the body of the message (but not
* the attributes of the message).</p>
* <p>(Optional) To override the generated value, you can specify a value for the
* <code>MessageDeduplicationId</code> parameter for the <code>Publish</code>
* action.</p>
* </li>
* </ul>
* </li>
Expand Down
Loading

0 comments on commit 54e4623

Please sign in to comment.