aws-sdk-sns 1.60.0 → 1.96.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.
@@ -123,7 +123,7 @@ module Aws::SNS
123
123
  #
124
124
  class CheckIfPhoneNumberIsOptedOutInput < Struct.new(
125
125
  :phone_number)
126
- SENSITIVE = []
126
+ SENSITIVE = [:phone_number]
127
127
  include Aws::Structure
128
128
  end
129
129
 
@@ -232,7 +232,8 @@ module Aws::SNS
232
232
  # @return [String]
233
233
  #
234
234
  # @!attribute [rw] attributes
235
- # For a list of attributes, see [SetPlatformApplicationAttributes][1].
235
+ # For a list of attributes, see [ `SetPlatformApplicationAttributes`
236
+ # ][1].
236
237
  #
237
238
  #
238
239
  #
@@ -252,7 +253,7 @@ module Aws::SNS
252
253
  # Response from CreatePlatformApplication action.
253
254
  #
254
255
  # @!attribute [rw] platform_application_arn
255
- # PlatformApplicationArn is returned.
256
+ # `PlatformApplicationArn` is returned.
256
257
  # @return [String]
257
258
  #
258
259
  # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformApplicationResponse AWS API Documentation
@@ -266,7 +267,7 @@ module Aws::SNS
266
267
  # Input for CreatePlatformEndpoint action.
267
268
  #
268
269
  # @!attribute [rw] platform_application_arn
269
- # PlatformApplicationArn returned from CreatePlatformApplication is
270
+ # `PlatformApplicationArn` returned from CreatePlatformApplication is
270
271
  # used to create a an endpoint.
271
272
  # @return [String]
272
273
  #
@@ -286,7 +287,7 @@ module Aws::SNS
286
287
  # @return [String]
287
288
  #
288
289
  # @!attribute [rw] attributes
289
- # For a list of attributes, see [SetEndpointAttributes][1].
290
+ # For a list of attributes, see [ `SetEndpointAttributes` ][1].
290
291
  #
291
292
  #
292
293
  #
@@ -320,7 +321,7 @@ module Aws::SNS
320
321
  class CreateSMSSandboxPhoneNumberInput < Struct.new(
321
322
  :phone_number,
322
323
  :language_code)
323
- SENSITIVE = []
324
+ SENSITIVE = [:phone_number]
324
325
  include Aws::Structure
325
326
  end
326
327
 
@@ -344,8 +345,8 @@ module Aws::SNS
344
345
  # @!attribute [rw] attributes
345
346
  # A map of attributes with their corresponding values.
346
347
  #
347
- # The following lists the names, descriptions, and values of the
348
- # special request parameters that the `CreateTopic` action uses:
348
+ # The following lists names, descriptions, and values of the special
349
+ # request parameters that the `CreateTopic` action uses:
349
350
  #
350
351
  # * `DeliveryPolicy` – The policy that defines how Amazon SNS retries
351
352
  # failed deliveries to HTTP/S endpoints.
@@ -373,8 +374,7 @@ module Aws::SNS
373
374
  # flag in the tracing header is true. This is only supported on
374
375
  # standard topics.
375
376
  #
376
- # The following attribute applies only to [server-side
377
- # encryption][1]\:
377
+ # The following attribute applies only to [server-side encryption][1]:
378
378
  #
379
379
  # * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
380
380
  # customer master key (CMK) for Amazon SNS or a custom CMK. For more
@@ -383,9 +383,11 @@ module Aws::SNS
383
383
  #
384
384
  # ^
385
385
  #
386
- # The following attributes apply only to [FIFO topics][4]\:
386
+ # The following attributes apply only to [FIFO topics][4]:
387
387
  #
388
- # * `FifoTopic` – When this is set to `true`, a FIFO topic is created.
388
+ # * `ArchivePolicy` – The policy that sets the retention period for
389
+ # messages stored in the message archive of an Amazon SNS FIFO
390
+ # topic.
389
391
  #
390
392
  # * `ContentBasedDeduplication` – Enables content-based deduplication
391
393
  # for FIFO topics.
@@ -403,6 +405,22 @@ module Aws::SNS
403
405
  # (Optional) To override the generated value, you can specify a
404
406
  # value for the `MessageDeduplicationId` parameter for the
405
407
  # `Publish` action.
408
+ # ^
409
+ #
410
+ # * `FifoThroughputScope` – Enables higher throughput for your FIFO
411
+ # topic by adjusting the scope of deduplication. This attribute has
412
+ # two possible values:
413
+ #
414
+ # * `Topic` – The scope of message deduplication is across the
415
+ # entire topic. This is the default value and maintains existing
416
+ # behavior, with a maximum throughput of 3000 messages per second
417
+ # or 20MB per second, whichever comes first.
418
+ #
419
+ # * `MessageGroup` – The scope of deduplication is within each
420
+ # individual message group, which enables higher throughput per
421
+ # topic subject to regional quotas. For more information on quotas
422
+ # or to request an increase, see [Amazon SNS service quotas][6] in
423
+ # the Amazon Web Services General Reference.
406
424
  #
407
425
  #
408
426
  #
@@ -411,6 +429,7 @@ module Aws::SNS
411
429
  # [3]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
412
430
  # [4]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
413
431
  # [5]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
432
+ # [6]: https://docs.aws.amazon.com/general/latest/gr/sns.html
414
433
  # @return [Hash<String,String>]
415
434
  #
416
435
  # @!attribute [rw] tags
@@ -457,10 +476,10 @@ module Aws::SNS
457
476
  include Aws::Structure
458
477
  end
459
478
 
460
- # Input for DeleteEndpoint action.
479
+ # Input for `DeleteEndpoint` action.
461
480
  #
462
481
  # @!attribute [rw] endpoint_arn
463
- # EndpointArn of endpoint to delete.
482
+ # `EndpointArn` of endpoint to delete.
464
483
  # @return [String]
465
484
  #
466
485
  # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteEndpointInput AWS API Documentation
@@ -471,10 +490,10 @@ module Aws::SNS
471
490
  include Aws::Structure
472
491
  end
473
492
 
474
- # Input for DeletePlatformApplication action.
493
+ # Input for `DeletePlatformApplication` action.
475
494
  #
476
495
  # @!attribute [rw] platform_application_arn
477
- # PlatformApplicationArn of platform application object to delete.
496
+ # `PlatformApplicationArn` of platform application object to delete.
478
497
  # @return [String]
479
498
  #
480
499
  # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeletePlatformApplicationInput AWS API Documentation
@@ -493,7 +512,7 @@ module Aws::SNS
493
512
  #
494
513
  class DeleteSMSSandboxPhoneNumberInput < Struct.new(
495
514
  :phone_number)
496
- SENSITIVE = []
515
+ SENSITIVE = [:phone_number]
497
516
  include Aws::Structure
498
517
  end
499
518
 
@@ -606,10 +625,10 @@ module Aws::SNS
606
625
  include Aws::Structure
607
626
  end
608
627
 
609
- # Input for GetEndpointAttributes action.
628
+ # Input for `GetEndpointAttributes` action.
610
629
  #
611
630
  # @!attribute [rw] endpoint_arn
612
- # EndpointArn for GetEndpointAttributes input.
631
+ # `EndpointArn` for `GetEndpointAttributes` input.
613
632
  # @return [String]
614
633
  #
615
634
  # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetEndpointAttributesInput AWS API Documentation
@@ -620,7 +639,7 @@ module Aws::SNS
620
639
  include Aws::Structure
621
640
  end
622
641
 
623
- # Response from GetEndpointAttributes of the EndpointArn.
642
+ # Response from `GetEndpointAttributes` of the `EndpointArn`.
624
643
  #
625
644
  # @!attribute [rw] attributes
626
645
  # Attributes include the following:
@@ -652,10 +671,10 @@ module Aws::SNS
652
671
  include Aws::Structure
653
672
  end
654
673
 
655
- # Input for GetPlatformApplicationAttributes action.
674
+ # Input for `GetPlatformApplicationAttributes` action.
656
675
  #
657
676
  # @!attribute [rw] platform_application_arn
658
- # PlatformApplicationArn for GetPlatformApplicationAttributesInput.
677
+ # `PlatformApplicationArn` for GetPlatformApplicationAttributesInput.
659
678
  # @return [String]
660
679
  #
661
680
  # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetPlatformApplicationAttributesInput AWS API Documentation
@@ -666,7 +685,7 @@ module Aws::SNS
666
685
  include Aws::Structure
667
686
  end
668
687
 
669
- # Response for GetPlatformApplicationAttributes action.
688
+ # Response for `GetPlatformApplicationAttributes` action.
670
689
  #
671
690
  # @!attribute [rw] attributes
672
691
  # Attributes include the following:
@@ -680,6 +699,13 @@ module Aws::SNS
680
699
  # * `ApplePlatformBundleID` – The app identifier used to configure
681
700
  # token-based authentication.
682
701
  #
702
+ # * `AuthenticationMethod` – Returns the credential type used when
703
+ # sending push notifications from application to APNS/APNS\_Sandbox,
704
+ # or application to GCM.
705
+ #
706
+ # * APNS – Returns the token or certificate.
707
+ #
708
+ # * GCM – Returns the token or key.
683
709
  # * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
684
710
  # notifications should be sent.
685
711
  #
@@ -800,7 +826,6 @@ module Aws::SNS
800
826
  # message attributes.
801
827
  #
802
828
  # * `MessageBody` – The filter is applied on the message body.
803
- #
804
829
  # * `Owner` – The Amazon Web Services account ID of the
805
830
  # subscription's owner.
806
831
  #
@@ -825,20 +850,19 @@ module Aws::SNS
825
850
  # * `TopicArn` – The topic ARN that the subscription is associated
826
851
  # with.
827
852
  #
828
- # The following attribute applies only to Amazon Kinesis Data Firehose
853
+ # The following attribute applies only to Amazon Data Firehose
829
854
  # delivery stream subscriptions:
830
855
  #
831
856
  # * `SubscriptionRoleArn` – The ARN of the IAM role that has the
832
857
  # following:
833
858
  #
834
- # * Permission to write to the Kinesis Data Firehose delivery stream
859
+ # * Permission to write to the Firehose delivery stream
835
860
  #
836
861
  # * Amazon SNS listed as a trusted entity
837
- #
838
- # Specifying a valid ARN for this attribute is required for Kinesis
839
- # Data Firehose delivery stream subscriptions. For more information,
840
- # see [Fanout to Kinesis Data Firehose delivery streams][2] in the
841
- # *Amazon SNS Developer Guide*.
862
+ # Specifying a valid ARN for this attribute is required for Firehose
863
+ # delivery stream subscriptions. For more information, see [Fanout
864
+ # to Firehose delivery streams][2] in the *Amazon SNS Developer
865
+ # Guide*.
842
866
  #
843
867
  #
844
868
  #
@@ -905,7 +929,6 @@ module Aws::SNS
905
929
  # has value **1**.
906
930
  #
907
931
  # </note>
908
- #
909
932
  # * `SubscriptionsConfirmed` – The number of confirmed subscriptions
910
933
  # for the topic.
911
934
  #
@@ -925,8 +948,7 @@ module Aws::SNS
925
948
  # flag in the tracing header is true. This is only supported on
926
949
  # standard topics.
927
950
  #
928
- # The following attribute applies only to
929
- # [server-side-encryption][1]\:
951
+ # The following attribute applies only to [server-side-encryption][1]:
930
952
  #
931
953
  # * `KmsMasterKeyId` - The ID of an Amazon Web Services managed
932
954
  # customer master key (CMK) for Amazon SNS or a custom CMK. For more
@@ -935,9 +957,16 @@ module Aws::SNS
935
957
  #
936
958
  # ^
937
959
  #
938
- # The following attributes apply only to [FIFO topics][4]\:
960
+ # The following attributes apply only to [FIFO topics][4]:
939
961
  #
940
- # * `FifoTopic` – When this is set to `true`, a FIFO topic is created.
962
+ # * `ArchivePolicy` – The policy that sets the retention period for
963
+ # messages stored in the message archive of an Amazon SNS FIFO
964
+ # topic.
965
+ #
966
+ # * `BeginningArchiveTime` – The earliest starting point at which a
967
+ # message in the topic’s archive can be replayed from. This point in
968
+ # time is based on the configured message retention period set by
969
+ # the topic’s message archiving policy.
941
970
  #
942
971
  # * `ContentBasedDeduplication` – Enables content-based deduplication
943
972
  # for FIFO topics.
@@ -955,6 +984,7 @@ module Aws::SNS
955
984
  # (Optional) To override the generated value, you can specify a
956
985
  # value for the `MessageDeduplicationId` parameter for the
957
986
  # `Publish` action.
987
+ # * `FifoTopic` – When this is set to `true`, a FIFO topic is created.
958
988
  #
959
989
  #
960
990
  #
@@ -1044,6 +1074,20 @@ module Aws::SNS
1044
1074
  include Aws::Structure
1045
1075
  end
1046
1076
 
1077
+ # Indicates that the specified state is not a valid state for an event
1078
+ # source.
1079
+ #
1080
+ # @!attribute [rw] message
1081
+ # @return [String]
1082
+ #
1083
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/InvalidStateException AWS API Documentation
1084
+ #
1085
+ class InvalidStateException < Struct.new(
1086
+ :message)
1087
+ SENSITIVE = []
1088
+ include Aws::Structure
1089
+ end
1090
+
1047
1091
  # The ciphertext references a key that doesn't exist or that you don't
1048
1092
  # have access to.
1049
1093
  #
@@ -1058,8 +1102,8 @@ module Aws::SNS
1058
1102
  include Aws::Structure
1059
1103
  end
1060
1104
 
1061
- # The request was rejected because the specified customer master key
1062
- # (CMK) isn't enabled.
1105
+ # The request was rejected because the specified Amazon Web Services KMS
1106
+ # key isn't enabled.
1063
1107
  #
1064
1108
  # @!attribute [rw] message
1065
1109
  # @return [String]
@@ -1073,9 +1117,9 @@ module Aws::SNS
1073
1117
  end
1074
1118
 
1075
1119
  # The request was rejected because the state of the specified resource
1076
- # isn't valid for this request. For more information, see [How Key
1077
- # State Affects Use of a Customer Master Key][1] in the *Key Management
1078
- # Service Developer Guide*.
1120
+ # isn't valid for this request. For more information, see [Key states
1121
+ # of Amazon Web Services KMS keys][1] in the *Key Management Service
1122
+ # Developer Guide*.
1079
1123
  #
1080
1124
  #
1081
1125
  #
@@ -1139,16 +1183,16 @@ module Aws::SNS
1139
1183
  include Aws::Structure
1140
1184
  end
1141
1185
 
1142
- # Input for ListEndpointsByPlatformApplication action.
1186
+ # Input for `ListEndpointsByPlatformApplication` action.
1143
1187
  #
1144
1188
  # @!attribute [rw] platform_application_arn
1145
- # PlatformApplicationArn for ListEndpointsByPlatformApplicationInput
1146
- # action.
1189
+ # `PlatformApplicationArn` for
1190
+ # `ListEndpointsByPlatformApplicationInput` action.
1147
1191
  # @return [String]
1148
1192
  #
1149
1193
  # @!attribute [rw] next_token
1150
- # NextToken string is used when calling
1151
- # ListEndpointsByPlatformApplication action to retrieve additional
1194
+ # `NextToken` string is used when calling
1195
+ # `ListEndpointsByPlatformApplication` action to retrieve additional
1152
1196
  # records that are available after the first page results.
1153
1197
  # @return [String]
1154
1198
  #
@@ -1161,16 +1205,16 @@ module Aws::SNS
1161
1205
  include Aws::Structure
1162
1206
  end
1163
1207
 
1164
- # Response for ListEndpointsByPlatformApplication action.
1208
+ # Response for `ListEndpointsByPlatformApplication` action.
1165
1209
  #
1166
1210
  # @!attribute [rw] endpoints
1167
- # Endpoints returned for ListEndpointsByPlatformApplication action.
1211
+ # Endpoints returned for `ListEndpointsByPlatformApplication` action.
1168
1212
  # @return [Array<Types::Endpoint>]
1169
1213
  #
1170
1214
  # @!attribute [rw] next_token
1171
- # NextToken string is returned when calling
1172
- # ListEndpointsByPlatformApplication action if additional records are
1173
- # available after the first page results.
1215
+ # `NextToken` string is returned when calling
1216
+ # `ListEndpointsByPlatformApplication` action if additional records
1217
+ # are available after the first page results.
1174
1218
  # @return [String]
1175
1219
  #
1176
1220
  # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListEndpointsByPlatformApplicationResponse AWS API Documentation
@@ -1254,14 +1298,14 @@ module Aws::SNS
1254
1298
  class ListPhoneNumbersOptedOutResponse < Struct.new(
1255
1299
  :phone_numbers,
1256
1300
  :next_token)
1257
- SENSITIVE = []
1301
+ SENSITIVE = [:phone_numbers]
1258
1302
  include Aws::Structure
1259
1303
  end
1260
1304
 
1261
- # Input for ListPlatformApplications action.
1305
+ # Input for `ListPlatformApplications` action.
1262
1306
  #
1263
1307
  # @!attribute [rw] next_token
1264
- # NextToken string is used when calling ListPlatformApplications
1308
+ # `NextToken` string is used when calling `ListPlatformApplications`
1265
1309
  # action to retrieve additional records that are available after the
1266
1310
  # first page results.
1267
1311
  # @return [String]
@@ -1274,17 +1318,17 @@ module Aws::SNS
1274
1318
  include Aws::Structure
1275
1319
  end
1276
1320
 
1277
- # Response for ListPlatformApplications action.
1321
+ # Response for `ListPlatformApplications` action.
1278
1322
  #
1279
1323
  # @!attribute [rw] platform_applications
1280
- # Platform applications returned when calling ListPlatformApplications
1281
- # action.
1324
+ # Platform applications returned when calling
1325
+ # `ListPlatformApplications` action.
1282
1326
  # @return [Array<Types::PlatformApplication>]
1283
1327
  #
1284
1328
  # @!attribute [rw] next_token
1285
- # NextToken string is returned when calling ListPlatformApplications
1286
- # action if additional records are available after the first page
1287
- # results.
1329
+ # `NextToken` string is returned when calling
1330
+ # `ListPlatformApplications` action if additional records are
1331
+ # available after the first page results.
1288
1332
  # @return [String]
1289
1333
  #
1290
1334
  # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPlatformApplicationsResponse AWS API Documentation
@@ -1537,7 +1581,7 @@ module Aws::SNS
1537
1581
  #
1538
1582
  class OptInPhoneNumberInput < Struct.new(
1539
1583
  :phone_number)
1540
- SENSITIVE = []
1584
+ SENSITIVE = [:phone_number]
1541
1585
  include Aws::Structure
1542
1586
  end
1543
1587
 
@@ -1598,7 +1642,7 @@ module Aws::SNS
1598
1642
  :iso_2_country_code,
1599
1643
  :route_type,
1600
1644
  :number_capabilities)
1601
- SENSITIVE = []
1645
+ SENSITIVE = [:phone_number]
1602
1646
  include Aws::Structure
1603
1647
  end
1604
1648
 
@@ -1706,11 +1750,24 @@ module Aws::SNS
1706
1750
  # @!attribute [rw] message_deduplication_id
1707
1751
  # This parameter applies only to FIFO (first-in-first-out) topics.
1708
1752
  #
1709
- # The token used for deduplication of messages within a 5-minute
1710
- # minimum deduplication interval. If a message with a particular
1711
- # `MessageDeduplicationId` is sent successfully, subsequent messages
1712
- # with the same `MessageDeduplicationId` are accepted successfully but
1713
- # aren't delivered.
1753
+ # * This parameter applies only to FIFO (first-in-first-out) topics.
1754
+ # The `MessageDeduplicationId` can contain up to 128 alphanumeric
1755
+ # characters `(a-z, A-Z, 0-9)` and punctuation ``
1756
+ # (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
1757
+ #
1758
+ # * Every message must have a unique `MessageDeduplicationId`, which
1759
+ # is a token used for deduplication of sent messages within the 5
1760
+ # minute minimum deduplication interval.
1761
+ #
1762
+ # * The scope of deduplication depends on the `FifoThroughputScope`
1763
+ # attribute, when set to `Topic` the message deduplication scope is
1764
+ # across the entire topic, when set to `MessageGroup` the message
1765
+ # deduplication scope is within each individual message group.
1766
+ #
1767
+ # * If a message with a particular `MessageDeduplicationId` is sent
1768
+ # successfully, subsequent messages within the deduplication scope
1769
+ # and interval, with the same `MessageDeduplicationId`, are accepted
1770
+ # successfully but aren't delivered.
1714
1771
  #
1715
1772
  # * Every message must have a unique `MessageDeduplicationId`.
1716
1773
  #
@@ -1728,17 +1785,17 @@ module Aws::SNS
1728
1785
  #
1729
1786
  # * If the topic has a `ContentBasedDeduplication` set, your
1730
1787
  # `MessageDeduplicationId` overrides the generated one.
1731
- #
1732
1788
  # * When `ContentBasedDeduplication` is in effect, messages with
1733
- # identical content sent within the deduplication interval are
1734
- # treated as duplicates and only one copy of the message is
1789
+ # identical content sent within the deduplication scope and interval
1790
+ # are treated as duplicates and only one copy of the message is
1735
1791
  # delivered.
1736
1792
  #
1737
1793
  # * If you send one message with `ContentBasedDeduplication` enabled,
1738
1794
  # and then another message with a `MessageDeduplicationId` that is
1739
1795
  # the same as the one generated for the first
1740
1796
  # `MessageDeduplicationId`, the two messages are treated as
1741
- # duplicates and only one copy of the message is delivered.
1797
+ # duplicates, within the deduplication scope and interval, and only
1798
+ # one copy of the message is delivered.
1742
1799
  #
1743
1800
  # <note markdown="1"> The `MessageDeduplicationId` is available to the consumer of the
1744
1801
  # message (this can be useful for troubleshooting delivery issues).
@@ -1752,12 +1809,6 @@ module Aws::SNS
1752
1809
  # even after the message is received and deleted.
1753
1810
  #
1754
1811
  # </note>
1755
- #
1756
- # The length of `MessageDeduplicationId` is 128 characters.
1757
- #
1758
- # `MessageDeduplicationId` can contain alphanumeric characters `(a-z,
1759
- # A-Z, 0-9)` and punctuation `` (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~)
1760
- # ``.
1761
1812
  # @return [String]
1762
1813
  #
1763
1814
  # @!attribute [rw] message_group_id
@@ -1778,7 +1829,7 @@ module Aws::SNS
1778
1829
  # The length of `MessageGroupId` is 128 characters.
1779
1830
  #
1780
1831
  # `MessageGroupId` can contain alphanumeric characters `(a-z, A-Z,
1781
- # 0-9)` and punctuation `` (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
1832
+ # 0-9)` and punctuation `` (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
1782
1833
  #
1783
1834
  # `MessageGroupId` is required for FIFO topics. You can't use it for
1784
1835
  # standard topics.
@@ -1933,9 +1984,8 @@ module Aws::SNS
1933
1984
  # included, if present, in the standard JSON messages delivered to
1934
1985
  # other endpoints.
1935
1986
  #
1936
- # Constraints: Subjects must be ASCII text that begins with a letter,
1937
- # number, or punctuation mark; must not include line breaks or control
1938
- # characters; and must be less than 100 characters long.
1987
+ # Constraints: Subjects must be UTF-8 text with no line breaks or
1988
+ # control characters, and less than 100 characters long.
1939
1989
  # @return [String]
1940
1990
  #
1941
1991
  # @!attribute [rw] message_structure
@@ -1961,27 +2011,59 @@ module Aws::SNS
1961
2011
  # @return [Hash<String,Types::MessageAttributeValue>]
1962
2012
  #
1963
2013
  # @!attribute [rw] message_deduplication_id
1964
- # This parameter applies only to FIFO (first-in-first-out) topics. The
1965
- # `MessageDeduplicationId` can contain up to 128 alphanumeric
1966
- # characters `(a-z, A-Z, 0-9)` and punctuation ``
1967
- # (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
2014
+ # * This parameter applies only to FIFO (first-in-first-out) topics.
2015
+ # The `MessageDeduplicationId` can contain up to 128 alphanumeric
2016
+ # characters `(a-z, A-Z, 0-9)` and punctuation ``
2017
+ # (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
2018
+ #
2019
+ # * Every message must have a unique `MessageDeduplicationId`, which
2020
+ # is a token used for deduplication of sent messages within the 5
2021
+ # minute minimum deduplication interval.
2022
+ #
2023
+ # * The scope of deduplication depends on the `FifoThroughputScope`
2024
+ # attribute, when set to `Topic` the message deduplication scope is
2025
+ # across the entire topic, when set to `MessageGroup` the message
2026
+ # deduplication scope is within each individual message group.
2027
+ #
2028
+ # * If a message with a particular `MessageDeduplicationId` is sent
2029
+ # successfully, subsequent messages within the deduplication scope
2030
+ # and interval, with the same `MessageDeduplicationId`, are accepted
2031
+ # successfully but aren't delivered.
2032
+ #
2033
+ # * Every message must have a unique `MessageDeduplicationId`:
2034
+ #
2035
+ # * You may provide a `MessageDeduplicationId` explicitly.
2036
+ #
2037
+ # * If you aren't able to provide a `MessageDeduplicationId` and
2038
+ # you enable `ContentBasedDeduplication` for your topic, Amazon
2039
+ # SNS uses a SHA-256 hash to generate the `MessageDeduplicationId`
2040
+ # using the body of the message (but not the attributes of the
2041
+ # message).
1968
2042
  #
1969
- # Every message must have a unique `MessageDeduplicationId`, which is
1970
- # a token used for deduplication of sent messages. If a message with a
1971
- # particular `MessageDeduplicationId` is sent successfully, any
1972
- # message sent with the same `MessageDeduplicationId` during the
1973
- # 5-minute deduplication interval is treated as a duplicate.
2043
+ # * If you don't provide a `MessageDeduplicationId` and the topic
2044
+ # doesn't have `ContentBasedDeduplication` set, the action fails
2045
+ # with an error.
1974
2046
  #
1975
- # If the topic has `ContentBasedDeduplication` set, the system
1976
- # generates a `MessageDeduplicationId` based on the contents of the
1977
- # message. Your `MessageDeduplicationId` overrides the generated one.
2047
+ # * If the topic has a `ContentBasedDeduplication` set, your
2048
+ # `MessageDeduplicationId` overrides the generated one.
2049
+ # * When `ContentBasedDeduplication` is in effect, messages with
2050
+ # identical content sent within the deduplication scope and interval
2051
+ # are treated as duplicates and only one copy of the message is
2052
+ # delivered.
2053
+ #
2054
+ # * If you send one message with `ContentBasedDeduplication` enabled,
2055
+ # and then another message with a `MessageDeduplicationId` that is
2056
+ # the same as the one generated for the first
2057
+ # `MessageDeduplicationId`, the two messages are treated as
2058
+ # duplicates, within the deduplication scope and interval, and only
2059
+ # one copy of the message is delivered.
1978
2060
  # @return [String]
1979
2061
  #
1980
2062
  # @!attribute [rw] message_group_id
1981
2063
  # This parameter applies only to FIFO (first-in-first-out) topics. The
1982
2064
  # `MessageGroupId` can contain up to 128 alphanumeric characters
1983
2065
  # `(a-z, A-Z, 0-9)` and punctuation ``
1984
- # (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
2066
+ # (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
1985
2067
  #
1986
2068
  # The `MessageGroupId` is a tag that specifies that a message belongs
1987
2069
  # to a specific message group. Messages that belong to the same
@@ -2002,7 +2084,7 @@ module Aws::SNS
2002
2084
  :message_attributes,
2003
2085
  :message_deduplication_id,
2004
2086
  :message_group_id)
2005
- SENSITIVE = []
2087
+ SENSITIVE = [:phone_number]
2006
2088
  include Aws::Structure
2007
2089
  end
2008
2090
 
@@ -2081,6 +2163,20 @@ module Aws::SNS
2081
2163
  include Aws::Structure
2082
2164
  end
2083
2165
 
2166
+ # Indicates that the request parameter has exceeded the maximum number
2167
+ # of concurrent message replays.
2168
+ #
2169
+ # @!attribute [rw] message
2170
+ # @return [String]
2171
+ #
2172
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ReplayLimitExceededException AWS API Documentation
2173
+ #
2174
+ class ReplayLimitExceededException < Struct.new(
2175
+ :message)
2176
+ SENSITIVE = []
2177
+ include Aws::Structure
2178
+ end
2179
+
2084
2180
  # Can’t perform the action on the specified resource. Make sure that the
2085
2181
  # resource exists.
2086
2182
  #
@@ -2124,14 +2220,14 @@ module Aws::SNS
2124
2220
  class SMSSandboxPhoneNumber < Struct.new(
2125
2221
  :phone_number,
2126
2222
  :status)
2127
- SENSITIVE = []
2223
+ SENSITIVE = [:phone_number]
2128
2224
  include Aws::Structure
2129
2225
  end
2130
2226
 
2131
- # Input for SetEndpointAttributes action.
2227
+ # Input for `SetEndpointAttributes` action.
2132
2228
  #
2133
2229
  # @!attribute [rw] endpoint_arn
2134
- # EndpointArn used for SetEndpointAttributes action.
2230
+ # EndpointArn used for `SetEndpointAttributes` action.
2135
2231
  # @return [String]
2136
2232
  #
2137
2233
  # @!attribute [rw] attributes
@@ -2162,10 +2258,11 @@ module Aws::SNS
2162
2258
  include Aws::Structure
2163
2259
  end
2164
2260
 
2165
- # Input for SetPlatformApplicationAttributes action.
2261
+ # Input for `SetPlatformApplicationAttributes` action.
2166
2262
  #
2167
2263
  # @!attribute [rw] platform_application_arn
2168
- # PlatformApplicationArn for SetPlatformApplicationAttributes action.
2264
+ # `PlatformApplicationArn` for `SetPlatformApplicationAttributes`
2265
+ # action.
2169
2266
  # @return [String]
2170
2267
  #
2171
2268
  # @!attribute [rw] attributes
@@ -2183,8 +2280,17 @@ module Aws::SNS
2183
2280
  # * For Apple Services using token credentials, `PlatformCredential`
2184
2281
  # is signing key.
2185
2282
  #
2186
- # * For GCM (Firebase Cloud Messaging), `PlatformCredential` is API
2187
- # key.
2283
+ # * For GCM (Firebase Cloud Messaging) using key credentials, there
2284
+ # is no `PlatformPrincipal`. The `PlatformCredential` is `API
2285
+ # key`.
2286
+ #
2287
+ # * For GCM (Firebase Cloud Messaging) using token credentials,
2288
+ # there is no `PlatformPrincipal`. The `PlatformCredential` is a
2289
+ # JSON formatted private key file. When using the Amazon Web
2290
+ # Services CLI, the file must be in string format and special
2291
+ # characters must be ignored. To format the file correctly, Amazon
2292
+ # SNS recommends using the following command: `` SERVICE_JSON=`jq
2293
+ # @json <<< cat service.json` ``.
2188
2294
  # ^
2189
2295
  #
2190
2296
  # * `PlatformPrincipal` – The principal received from the notification
@@ -2371,7 +2477,6 @@ module Aws::SNS
2371
2477
  # message attributes.
2372
2478
  #
2373
2479
  # * `MessageBody` – The filter is applied on the message body.
2374
- #
2375
2480
  # * `RawMessageDelivery` – When set to `true`, enables raw message
2376
2481
  # delivery to Amazon SQS or HTTP/S endpoints. This eliminates the
2377
2482
  # need for the endpoints to process JSON formatting, which is
@@ -2385,20 +2490,19 @@ module Aws::SNS
2385
2490
  # unavailable) are held in the dead-letter queue for further
2386
2491
  # analysis or reprocessing.
2387
2492
  #
2388
- # The following attribute applies only to Amazon Kinesis Data Firehose
2493
+ # The following attribute applies only to Amazon Data Firehose
2389
2494
  # delivery stream subscriptions:
2390
2495
  #
2391
2496
  # * `SubscriptionRoleArn` – The ARN of the IAM role that has the
2392
2497
  # following:
2393
2498
  #
2394
- # * Permission to write to the Kinesis Data Firehose delivery stream
2499
+ # * Permission to write to the Firehose delivery stream
2395
2500
  #
2396
2501
  # * Amazon SNS listed as a trusted entity
2397
- #
2398
- # Specifying a valid ARN for this attribute is required for Kinesis
2399
- # Data Firehose delivery stream subscriptions. For more information,
2400
- # see [Fanout to Kinesis Data Firehose delivery streams][1] in the
2401
- # *Amazon SNS Developer Guide*.
2502
+ # Specifying a valid ARN for this attribute is required for Firehose
2503
+ # delivery stream subscriptions. For more information, see [Fanout
2504
+ # to Firehose delivery streams][1] in the *Amazon SNS Developer
2505
+ # Guide*.
2402
2506
  #
2403
2507
  #
2404
2508
  #
@@ -2467,7 +2571,6 @@ module Aws::SNS
2467
2571
  # * `HTTPFailureFeedbackRoleArn` – Indicates failed message delivery
2468
2572
  # status for an Amazon SNS topic that is subscribed to an HTTP
2469
2573
  # endpoint.
2470
- #
2471
2574
  # * Amazon Kinesis Data Firehose
2472
2575
  #
2473
2576
  # * `FirehoseSuccessFeedbackRoleArn` – Indicates successful message
@@ -2481,7 +2584,6 @@ module Aws::SNS
2481
2584
  # * `FirehoseFailureFeedbackRoleArn` – Indicates failed message
2482
2585
  # delivery status for an Amazon SNS topic that is subscribed to an
2483
2586
  # Amazon Kinesis Data Firehose endpoint.
2484
- #
2485
2587
  # * Lambda
2486
2588
  #
2487
2589
  # * `LambdaSuccessFeedbackRoleArn` – Indicates successful message
@@ -2495,7 +2597,6 @@ module Aws::SNS
2495
2597
  # * `LambdaFailureFeedbackRoleArn` – Indicates failed message
2496
2598
  # delivery status for an Amazon SNS topic that is subscribed to an
2497
2599
  # Lambda endpoint.
2498
- #
2499
2600
  # * Platform application endpoint
2500
2601
  #
2501
2602
  # * `ApplicationSuccessFeedbackRoleArn` – Indicates successful
@@ -2509,7 +2610,6 @@ module Aws::SNS
2509
2610
  # * `ApplicationFailureFeedbackRoleArn` – Indicates failed message
2510
2611
  # delivery status for an Amazon SNS topic that is subscribed to an
2511
2612
  # Amazon Web Services application endpoint.
2512
- #
2513
2613
  # <note markdown="1"> In addition to being able to configure topic attributes for
2514
2614
  # message delivery status of notification messages sent to Amazon
2515
2615
  # SNS application endpoints, you can also configure application
@@ -2546,8 +2646,7 @@ module Aws::SNS
2546
2646
  #
2547
2647
  # </note>
2548
2648
  #
2549
- # The following attribute applies only to
2550
- # [server-side-encryption][2]\:
2649
+ # The following attribute applies only to [server-side-encryption][2]:
2551
2650
  #
2552
2651
  # * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
2553
2652
  # customer master key (CMK) for Amazon SNS or a custom CMK. For more
@@ -2560,7 +2659,11 @@ module Aws::SNS
2560
2659
  # confirmation messages sent by Amazon SNS. By default,
2561
2660
  # `SignatureVersion` is set to `1`.
2562
2661
  #
2563
- # The following attribute applies only to [FIFO topics][5]\:
2662
+ # The following attribute applies only to [FIFO topics][5]:
2663
+ #
2664
+ # * `ArchivePolicy` – The policy that sets the retention period for
2665
+ # messages stored in the message archive of an Amazon SNS FIFO
2666
+ # topic.
2564
2667
  #
2565
2668
  # * `ContentBasedDeduplication` – Enables content-based deduplication
2566
2669
  # for FIFO topics.
@@ -2578,6 +2681,22 @@ module Aws::SNS
2578
2681
  # (Optional) To override the generated value, you can specify a
2579
2682
  # value for the `MessageDeduplicationId` parameter for the
2580
2683
  # `Publish` action.
2684
+ # ^
2685
+ #
2686
+ # * `FifoThroughputScope` – Enables higher throughput for your FIFO
2687
+ # topic by adjusting the scope of deduplication. This attribute has
2688
+ # two possible values:
2689
+ #
2690
+ # * `Topic` – The scope of message deduplication is across the
2691
+ # entire topic. This is the default value and maintains existing
2692
+ # behavior, with a maximum throughput of 3000 messages per second
2693
+ # or 20MB per second, whichever comes first.
2694
+ #
2695
+ # * `MessageGroup` – The scope of deduplication is within each
2696
+ # individual message group, which enables higher throughput per
2697
+ # topic subject to regional quotas. For more information on quotas
2698
+ # or to request an increase, see [Amazon SNS service quotas][7] in
2699
+ # the Amazon Web Services General Reference.
2581
2700
  #
2582
2701
  #
2583
2702
  #
@@ -2587,6 +2706,7 @@ module Aws::SNS
2587
2706
  # [4]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
2588
2707
  # [5]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
2589
2708
  # [6]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
2709
+ # [7]: https://docs.aws.amazon.com/general/latest/gr/sns.html
2590
2710
  # @return [String]
2591
2711
  #
2592
2712
  # @!attribute [rw] attribute_value
@@ -2697,7 +2817,6 @@ module Aws::SNS
2697
2817
  # message attributes.
2698
2818
  #
2699
2819
  # * `MessageBody` – The filter is applied on the message body.
2700
- #
2701
2820
  # * `RawMessageDelivery` – When set to `true`, enables raw message
2702
2821
  # delivery to Amazon SQS or HTTP/S endpoints. This eliminates the
2703
2822
  # need for the endpoints to process JSON formatting, which is
@@ -2711,24 +2830,45 @@ module Aws::SNS
2711
2830
  # unavailable) are held in the dead-letter queue for further
2712
2831
  # analysis or reprocessing.
2713
2832
  #
2714
- # The following attribute applies only to Amazon Kinesis Data Firehose
2833
+ # The following attribute applies only to Amazon Data Firehose
2715
2834
  # delivery stream subscriptions:
2716
2835
  #
2717
2836
  # * `SubscriptionRoleArn` – The ARN of the IAM role that has the
2718
2837
  # following:
2719
2838
  #
2720
- # * Permission to write to the Kinesis Data Firehose delivery stream
2839
+ # * Permission to write to the Firehose delivery stream
2721
2840
  #
2722
2841
  # * Amazon SNS listed as a trusted entity
2842
+ # Specifying a valid ARN for this attribute is required for Firehose
2843
+ # delivery stream subscriptions. For more information, see [Fanout
2844
+ # to Firehose delivery streams][1] in the *Amazon SNS Developer
2845
+ # Guide*.
2846
+ #
2847
+ # The following attributes apply only to [FIFO topics][2]:
2848
+ #
2849
+ # * `ReplayPolicy` – Adds or updates an inline policy document for a
2850
+ # subscription to replay messages stored in the specified Amazon SNS
2851
+ # topic.
2723
2852
  #
2724
- # Specifying a valid ARN for this attribute is required for Kinesis
2725
- # Data Firehose delivery stream subscriptions. For more information,
2726
- # see [Fanout to Kinesis Data Firehose delivery streams][1] in the
2727
- # *Amazon SNS Developer Guide*.
2853
+ # * `ReplayStatus` Retrieves the status of the subscription message
2854
+ # replay, which can be one of the following:
2855
+ #
2856
+ # * `Completed` The replay has successfully redelivered all
2857
+ # messages, and is now delivering newly published messages. If an
2858
+ # ending point was specified in the `ReplayPolicy` then the
2859
+ # subscription will no longer receive newly published messages.
2860
+ #
2861
+ # * `In progress` – The replay is currently replaying the selected
2862
+ # messages.
2863
+ #
2864
+ # * `Failed` – The replay was unable to complete.
2865
+ #
2866
+ # * `Pending` – The default state while the replay initiates.
2728
2867
  #
2729
2868
  #
2730
2869
  #
2731
2870
  # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html
2871
+ # [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
2732
2872
  # @return [Hash<String,String>]
2733
2873
  #
2734
2874
  # @!attribute [rw] return_subscription_arn
@@ -3046,7 +3186,7 @@ module Aws::SNS
3046
3186
  class VerifySMSSandboxPhoneNumberInput < Struct.new(
3047
3187
  :phone_number,
3048
3188
  :one_time_password)
3049
- SENSITIVE = []
3189
+ SENSITIVE = [:phone_number]
3050
3190
  include Aws::Structure
3051
3191
  end
3052
3192
 
@@ -3058,3 +3198,4 @@ module Aws::SNS
3058
3198
 
3059
3199
  end
3060
3200
  end
3201
+