Skip to content

Commit 7bf529c

Browse files
author
awstools
committed
docs(client-sns): This release adds support for the topic attribute FifoThroughputScope for SNS FIFO topics. For details, see the documentation history in the Amazon Simple Notification Service Developer Guide.
1 parent a009440 commit 7bf529c

File tree

2 files changed

+150
-55
lines changed

2 files changed

+150
-55
lines changed

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

Lines changed: 146 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -570,8 +570,8 @@ export interface CreateTopicInput {
570570
* <li>
571571
* <p>
572572
* <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>
573+
* for messages stored in the message archive of an Amazon SNS FIFO
574+
* topic.</p>
575575
* </li>
576576
* <li>
577577
* <p>
@@ -580,19 +580,34 @@ export interface CreateTopicInput {
580580
* <ul>
581581
* <li>
582582
* <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>
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> action. </p>
587586
* </li>
588587
* <li>
589-
* <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>,
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>
588+
* <p>When you set <code>ContentBasedDeduplication</code> to
589+
* <code>true</code>, Amazon SNS uses a SHA-256 hash to
590+
* generate the <code>MessageDeduplicationId</code> using the body of the
591+
* message (but not the attributes of the message).</p>
592+
* <p>(Optional) To override the generated value, you can specify a value
593+
* for the <code>MessageDeduplicationId</code> parameter for the
594+
* <code>Publish</code> action.</p>
595+
* </li>
596+
* </ul>
597+
* </li>
598+
* </ul>
599+
* <ul>
600+
* <li>
601+
* <p>
602+
* <code>FifoThroughputScope</code> – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:</p>
603+
* <ul>
604+
* <li>
605+
* <p>
606+
* <code>Topic</code> – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.</p>
607+
* </li>
608+
* <li>
609+
* <p>
610+
* <code>MessageGroup</code> – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon SNS service quotas</a> in the Amazon Web Services General Reference.</p>
596611
* </li>
597612
* </ul>
598613
* </li>
@@ -2203,18 +2218,69 @@ export interface PublishInput {
22032218
MessageAttributes?: Record<string, MessageAttributeValue> | undefined;
22042219

22052220
/**
2206-
* <p>This parameter applies only to FIFO (first-in-first-out) topics. The
2207-
* <code>MessageDeduplicationId</code> can contain up to 128 alphanumeric characters
2208-
* <code>(a-z, A-Z, 0-9)</code> and punctuation
2209-
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
2210-
* <p>Every message must have a unique <code>MessageDeduplicationId</code>, which is a token
2211-
* used for deduplication of sent messages. If a message with a particular
2212-
* <code>MessageDeduplicationId</code> is sent successfully, any message sent with the
2213-
* same <code>MessageDeduplicationId</code> during the 5-minute deduplication interval is
2214-
* treated as a duplicate. </p>
2215-
* <p>If the topic has <code>ContentBasedDeduplication</code> set, the system generates a
2216-
* <code>MessageDeduplicationId</code> based on the contents of the message. Your
2217-
* <code>MessageDeduplicationId</code> overrides the generated one.</p>
2221+
* <ul>
2222+
* <li>
2223+
* <p>This parameter applies only to FIFO (first-in-first-out) topics. The
2224+
* <code>MessageDeduplicationId</code> can contain up to 128 alphanumeric
2225+
* characters <code>(a-z, A-Z, 0-9)</code> and punctuation
2226+
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
2227+
* </li>
2228+
* <li>
2229+
* <p>Every message must have a unique <code>MessageDeduplicationId</code>, which is
2230+
* a token used for deduplication of sent messages within the 5 minute minimum
2231+
* deduplication interval.</p>
2232+
* </li>
2233+
* <li>
2234+
* <p>The scope of deduplication depends on the <code>FifoThroughputScope</code>
2235+
* attribute, when set to <code>Topic</code> the message deduplication scope is
2236+
* across the entire topic, when set to <code>MessageGroup</code> the message
2237+
* deduplication scope is within each individual message group.</p>
2238+
* </li>
2239+
* <li>
2240+
* <p>If a message with a particular <code>MessageDeduplicationId</code> is sent
2241+
* successfully, subsequent messages within the deduplication scope and interval,
2242+
* with the same <code>MessageDeduplicationId</code>, are accepted successfully but
2243+
* aren't delivered.</p>
2244+
* </li>
2245+
* <li>
2246+
* <p>Every message must have a unique <code>MessageDeduplicationId</code>:</p>
2247+
* <ul>
2248+
* <li>
2249+
* <p>You may provide a <code>MessageDeduplicationId</code>
2250+
* explicitly.</p>
2251+
* </li>
2252+
* <li>
2253+
* <p>If you aren't able to provide a <code>MessageDeduplicationId</code>
2254+
* and you enable <code>ContentBasedDeduplication</code> for your topic,
2255+
* Amazon SNS uses a SHA-256 hash to generate the
2256+
* <code>MessageDeduplicationId</code> using the body of the message
2257+
* (but not the attributes of the message).</p>
2258+
* </li>
2259+
* <li>
2260+
* <p>If you don't provide a <code>MessageDeduplicationId</code> and the
2261+
* topic doesn't have <code>ContentBasedDeduplication</code> set, the
2262+
* action fails with an error.</p>
2263+
* </li>
2264+
* <li>
2265+
* <p>If the topic has a <code>ContentBasedDeduplication</code> set, your
2266+
* <code>MessageDeduplicationId</code> overrides the generated one.
2267+
* </p>
2268+
* </li>
2269+
* </ul>
2270+
* </li>
2271+
* <li>
2272+
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with
2273+
* identical content sent within the deduplication scope and interval are treated
2274+
* as duplicates and only one copy of the message is delivered.</p>
2275+
* </li>
2276+
* <li>
2277+
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled,
2278+
* and then another message with a <code>MessageDeduplicationId</code> that is the
2279+
* same as the one generated for the first <code>MessageDeduplicationId</code>, the
2280+
* two messages are treated as duplicates, within the deduplication scope and
2281+
* interval, and only one copy of the message is delivered.</p>
2282+
* </li>
2283+
* </ul>
22182284
* @public
22192285
*/
22202286
MessageDeduplicationId?: string | undefined;
@@ -2396,12 +2462,31 @@ export interface PublishBatchRequestEntry {
23962462

23972463
/**
23982464
* <p>This parameter applies only to FIFO (first-in-first-out) topics.</p>
2399-
* <p>The token used for deduplication of messages within a 5-minute minimum deduplication
2400-
* interval. If a message with a particular <code>MessageDeduplicationId</code> is sent
2401-
* successfully, subsequent messages with the same <code>MessageDeduplicationId</code> are
2402-
* accepted successfully but aren't delivered.</p>
24032465
* <ul>
24042466
* <li>
2467+
* <p>This parameter applies only to FIFO (first-in-first-out) topics. The
2468+
* <code>MessageDeduplicationId</code> can contain up to 128 alphanumeric
2469+
* characters <code>(a-z, A-Z, 0-9)</code> and punctuation
2470+
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
2471+
* </li>
2472+
* <li>
2473+
* <p>Every message must have a unique <code>MessageDeduplicationId</code>, which is
2474+
* a token used for deduplication of sent messages within the 5 minute minimum
2475+
* deduplication interval.</p>
2476+
* </li>
2477+
* <li>
2478+
* <p>The scope of deduplication depends on the <code>FifoThroughputScope</code>
2479+
* attribute, when set to <code>Topic</code> the message deduplication scope is
2480+
* across the entire topic, when set to <code>MessageGroup</code> the message
2481+
* deduplication scope is within each individual message group. </p>
2482+
* </li>
2483+
* <li>
2484+
* <p>If a message with a particular <code>MessageDeduplicationId</code> is sent
2485+
* successfully, subsequent messages within the deduplication scope and interval,
2486+
* with the same <code>MessageDeduplicationId</code>, are accepted successfully but
2487+
* aren't delivered.</p>
2488+
* </li>
2489+
* <li>
24052490
* <p>Every message must have a unique <code>MessageDeduplicationId</code>.</p>
24062491
* <ul>
24072492
* <li>
@@ -2429,15 +2514,15 @@ export interface PublishBatchRequestEntry {
24292514
* </li>
24302515
* <li>
24312516
* <p>When <code>ContentBasedDeduplication</code> is in effect, messages with
2432-
* identical content sent within the deduplication interval are treated as
2433-
* duplicates and only one copy of the message is delivered.</p>
2517+
* identical content sent within the deduplication scope and interval are treated
2518+
* as duplicates and only one copy of the message is delivered.</p>
24342519
* </li>
24352520
* <li>
24362521
* <p>If you send one message with <code>ContentBasedDeduplication</code> enabled,
24372522
* and then another message with a <code>MessageDeduplicationId</code> that is the
24382523
* same as the one generated for the first <code>MessageDeduplicationId</code>, the
2439-
* two messages are treated as duplicates and only one copy of the message is
2440-
* delivered. </p>
2524+
* two messages are treated as duplicates, within the deduplication scope and
2525+
* interval, and only one copy of the message is delivered. </p>
24412526
* </li>
24422527
* </ul>
24432528
* <note>
@@ -2449,11 +2534,6 @@ export interface PublishBatchRequestEntry {
24492534
* <p>Amazon SNS continues to keep track of the message deduplication ID even after the
24502535
* message is received and deleted. </p>
24512536
* </note>
2452-
* <p>The length of <code>MessageDeduplicationId</code> is 128 characters.</p>
2453-
* <p>
2454-
* <code>MessageDeduplicationId</code> can contain alphanumeric characters <code>(a-z,
2455-
* A-Z, 0-9)</code> and punctuation
2456-
* <code>(!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)</code>.</p>
24572537
* @public
24582538
*/
24592539
MessageDeduplicationId?: string | undefined;
@@ -3199,8 +3279,8 @@ export interface SetTopicAttributesInput {
31993279
* <li>
32003280
* <p>
32013281
* <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>
3282+
* for messages stored in the message archive of an Amazon SNS FIFO
3283+
* topic.</p>
32043284
* </li>
32053285
* <li>
32063286
* <p>
@@ -3209,19 +3289,34 @@ export interface SetTopicAttributesInput {
32093289
* <ul>
32103290
* <li>
32113291
* <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>
3292+
* <code>false</code>. If you create a FIFO topic and this attribute is
3293+
* <code>false</code>, you must specify a value for the
3294+
* <code>MessageDeduplicationId</code> parameter for the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Publish.html">Publish</a> action. </p>
3295+
* </li>
3296+
* <li>
3297+
* <p>When you set <code>ContentBasedDeduplication</code> to
3298+
* <code>true</code>, Amazon SNS uses a SHA-256 hash to
3299+
* generate the <code>MessageDeduplicationId</code> using the body of the
3300+
* message (but not the attributes of the message).</p>
3301+
* <p>(Optional) To override the generated value, you can specify a value
3302+
* for the <code>MessageDeduplicationId</code> parameter for the
3303+
* <code>Publish</code> action.</p>
3304+
* </li>
3305+
* </ul>
3306+
* </li>
3307+
* </ul>
3308+
* <ul>
3309+
* <li>
3310+
* <p>
3311+
* <code>FifoThroughputScope</code> – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:</p>
3312+
* <ul>
3313+
* <li>
3314+
* <p>
3315+
* <code>Topic</code> – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.</p>
32163316
* </li>
32173317
* <li>
3218-
* <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>,
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>
3318+
* <p>
3319+
* <code>MessageGroup</code> – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon SNS service quotas</a> in the Amazon Web Services General Reference.</p>
32253320
* </li>
32263321
* </ul>
32273322
* </li>

0 commit comments

Comments
 (0)