aws-sdk-sns 1.102.0 → 1.103.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sns/client.rb +155 -62
- data/lib/aws-sdk-sns/platform_endpoint.rb +19 -9
- data/lib/aws-sdk-sns/resource.rb +100 -19
- data/lib/aws-sdk-sns/topic.rb +29 -23
- data/lib/aws-sdk-sns/types.rb +148 -58
- data/lib/aws-sdk-sns.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e7ba8bcd6011b3e5563415fb1e38a1c9d12b680b54d89aa8bf7e00914e8d1c3a
|
4
|
+
data.tar.gz: 0b560364c0ff7003f7d4f8d878817ada468dac13c99a225ecc0bd258b67fab5b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 69d1eb8ec7c720257d02c7b4317730dfc77b80487f40da122611b3fb5a89d4de4ae3ef892348dd192775885b46af61165de65ccbbe0576083eca542fb70106c4
|
7
|
+
data.tar.gz: ec530020ad9b6962aa3c6bb130f73838a9e9d12932f8fffc1510e448dce3ce52f40d58d0b0d5bf9d683a36ade21848e6b0e546317ddd55a29033b1f07e45c2ee
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.103.0
|
data/lib/aws-sdk-sns/client.rb
CHANGED
@@ -631,10 +631,11 @@ module Aws::SNS
|
|
631
631
|
#
|
632
632
|
# * For GCM (Firebase Cloud Messaging) using token credentials, there is
|
633
633
|
# no `PlatformPrincipal`. The `PlatformCredential` is a JSON formatted
|
634
|
-
# private key file. When using the Amazon Web Services CLI
|
635
|
-
# must be in string format and special
|
636
|
-
# format the file correctly, Amazon SNS
|
637
|
-
# command:
|
634
|
+
# private key file. When using the Amazon Web Services CLI or Amazon
|
635
|
+
# Web Services SDKs, the file must be in string format and special
|
636
|
+
# characters must be ignored. To format the file correctly, Amazon SNS
|
637
|
+
# recommends using the following command: `SERVICE_JSON=$(jq @json <
|
638
|
+
# service.json)`.
|
638
639
|
#
|
639
640
|
# * For MPNS, `PlatformPrincipal` is `TLS certificate` and
|
640
641
|
# `PlatformCredential` is `private key`.
|
@@ -840,17 +841,9 @@ module Aws::SNS
|
|
840
841
|
# * `DisplayName` – The display name to use for a topic with SMS
|
841
842
|
# subscriptions.
|
842
843
|
#
|
843
|
-
# * `FifoTopic` – Set to true to create a FIFO topic.
|
844
|
-
#
|
845
844
|
# * `Policy` – The policy that defines who can access your topic. By
|
846
845
|
# default, only the topic owner can publish or subscribe to the topic.
|
847
846
|
#
|
848
|
-
# * `SignatureVersion` – The signature version corresponds to the
|
849
|
-
# hashing algorithm used while creating the signature of the
|
850
|
-
# notifications, subscription confirmations, or unsubscribe
|
851
|
-
# confirmation messages sent by Amazon SNS. By default,
|
852
|
-
# `SignatureVersion` is set to `1`.
|
853
|
-
#
|
854
847
|
# * `TracingConfig` – Tracing mode of an Amazon SNS topic. By default
|
855
848
|
# `TracingConfig` is set to `PassThrough`, and the topic passes
|
856
849
|
# through the tracing header it receives from an Amazon SNS publisher
|
@@ -858,16 +851,104 @@ module Aws::SNS
|
|
858
851
|
# segment data to topic owner account if the sampled flag in the
|
859
852
|
# tracing header is true. This is only supported on standard topics.
|
860
853
|
#
|
861
|
-
#
|
854
|
+
# * HTTP
|
855
|
+
#
|
856
|
+
# * `HTTPSuccessFeedbackRoleArn` – Indicates successful message
|
857
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
858
|
+
# HTTP endpoint.
|
859
|
+
#
|
860
|
+
# * `HTTPSuccessFeedbackSampleRate` – Indicates percentage of
|
861
|
+
# successful messages to sample for an Amazon SNS topic that is
|
862
|
+
# subscribed to an HTTP endpoint.
|
863
|
+
#
|
864
|
+
# * `HTTPFailureFeedbackRoleArn` – Indicates failed message delivery
|
865
|
+
# status for an Amazon SNS topic that is subscribed to an HTTP
|
866
|
+
# endpoint.
|
867
|
+
# * Amazon Data Firehose
|
868
|
+
#
|
869
|
+
# * `FirehoseSuccessFeedbackRoleArn` – Indicates successful message
|
870
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
871
|
+
# Amazon Data Firehose endpoint.
|
872
|
+
#
|
873
|
+
# * `FirehoseSuccessFeedbackSampleRate` – Indicates percentage of
|
874
|
+
# successful messages to sample for an Amazon SNS topic that is
|
875
|
+
# subscribed to an Amazon Data Firehose endpoint.
|
876
|
+
#
|
877
|
+
# * `FirehoseFailureFeedbackRoleArn` – Indicates failed message
|
878
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
879
|
+
# Amazon Data Firehose endpoint.
|
880
|
+
# * Lambda
|
881
|
+
#
|
882
|
+
# * `LambdaSuccessFeedbackRoleArn` – Indicates successful message
|
883
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
884
|
+
# Lambda endpoint.
|
885
|
+
#
|
886
|
+
# * `LambdaSuccessFeedbackSampleRate` – Indicates percentage of
|
887
|
+
# successful messages to sample for an Amazon SNS topic that is
|
888
|
+
# subscribed to an Lambda endpoint.
|
889
|
+
#
|
890
|
+
# * `LambdaFailureFeedbackRoleArn` – Indicates failed message delivery
|
891
|
+
# status for an Amazon SNS topic that is subscribed to an Lambda
|
892
|
+
# endpoint.
|
893
|
+
# * Platform application endpoint
|
894
|
+
#
|
895
|
+
# * `ApplicationSuccessFeedbackRoleArn` – Indicates successful message
|
896
|
+
# delivery status for an Amazon SNS topic that is subscribed to a
|
897
|
+
# platform application endpoint.
|
898
|
+
#
|
899
|
+
# * `ApplicationSuccessFeedbackSampleRate` – Indicates percentage of
|
900
|
+
# successful messages to sample for an Amazon SNS topic that is
|
901
|
+
# subscribed to an platform application endpoint.
|
902
|
+
#
|
903
|
+
# * `ApplicationFailureFeedbackRoleArn` – Indicates failed message
|
904
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
905
|
+
# platform application endpoint.
|
906
|
+
# <note markdown="1"> In addition to being able to configure topic attributes for message
|
907
|
+
# delivery status of notification messages sent to Amazon SNS
|
908
|
+
# application endpoints, you can also configure application attributes
|
909
|
+
# for the delivery status of push notification messages sent to push
|
910
|
+
# notification services.
|
911
|
+
#
|
912
|
+
# For example, For more information, see [Using Amazon SNS Application
|
913
|
+
# Attributes for Message Delivery Status][1].
|
914
|
+
#
|
915
|
+
# </note>
|
916
|
+
#
|
917
|
+
# * Amazon SQS
|
918
|
+
#
|
919
|
+
# * `SQSSuccessFeedbackRoleArn` – Indicates successful message
|
920
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
921
|
+
# Amazon SQS endpoint.
|
922
|
+
#
|
923
|
+
# * `SQSSuccessFeedbackSampleRate` – Indicates percentage of
|
924
|
+
# successful messages to sample for an Amazon SNS topic that is
|
925
|
+
# subscribed to an Amazon SQS endpoint.
|
926
|
+
#
|
927
|
+
# * `SQSFailureFeedbackRoleArn` – Indicates failed message delivery
|
928
|
+
# status for an Amazon SNS topic that is subscribed to an Amazon SQS
|
929
|
+
# endpoint.
|
930
|
+
#
|
931
|
+
# <note markdown="1"> The <ENDPOINT>SuccessFeedbackRoleArn and
|
932
|
+
# <ENDPOINT>FailureFeedbackRoleArn attributes are used to give
|
933
|
+
# Amazon SNS write access to use CloudWatch Logs on your behalf. The
|
934
|
+
# <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying
|
935
|
+
# the sample rate percentage (0-100) of successfully delivered messages.
|
936
|
+
# After you configure the <ENDPOINT>FailureFeedbackRoleArn
|
937
|
+
# attribute, then all failed message deliveries generate CloudWatch
|
938
|
+
# Logs.
|
939
|
+
#
|
940
|
+
# </note>
|
941
|
+
#
|
942
|
+
# The following attribute applies only to [server-side encryption][2]:
|
862
943
|
#
|
863
944
|
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
864
945
|
# master key (CMK) for Amazon SNS or a custom CMK. For more
|
865
|
-
# information, see [Key Terms][
|
946
|
+
# information, see [Key Terms][3]. For more examples, see [KeyId][4]
|
866
947
|
# in the *Key Management Service API Reference*.
|
867
948
|
#
|
868
949
|
# ^
|
869
950
|
#
|
870
|
-
# The following attributes apply only to [FIFO topics][
|
951
|
+
# The following attributes apply only to [FIFO topics][5]:
|
871
952
|
#
|
872
953
|
# * `ArchivePolicy` – The policy that sets the retention period for
|
873
954
|
# messages stored in the message archive of an Amazon SNS FIFO topic.
|
@@ -878,7 +959,7 @@ module Aws::SNS
|
|
878
959
|
# * By default, `ContentBasedDeduplication` is set to `false`. If you
|
879
960
|
# create a FIFO topic and this attribute is `false`, you must
|
880
961
|
# specify a value for the `MessageDeduplicationId` parameter for the
|
881
|
-
# [Publish][
|
962
|
+
# [Publish][6] action.
|
882
963
|
#
|
883
964
|
# * When you set `ContentBasedDeduplication` to `true`, Amazon SNS
|
884
965
|
# uses a SHA-256 hash to generate the `MessageDeduplicationId` using
|
@@ -901,17 +982,18 @@ module Aws::SNS
|
|
901
982
|
# * `MessageGroup` – The scope of deduplication is within each
|
902
983
|
# individual message group, which enables higher throughput per
|
903
984
|
# topic subject to regional quotas. For more information on quotas
|
904
|
-
# or to request an increase, see [Amazon SNS service quotas][
|
985
|
+
# or to request an increase, see [Amazon SNS service quotas][7] in
|
905
986
|
# the Amazon Web Services General Reference.
|
906
987
|
#
|
907
988
|
#
|
908
989
|
#
|
909
|
-
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-
|
910
|
-
# [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
|
911
|
-
# [3]: https://docs.aws.amazon.com/
|
912
|
-
# [4]: https://docs.aws.amazon.com/
|
913
|
-
# [5]: https://docs.aws.amazon.com/sns/latest/
|
914
|
-
# [6]: https://docs.aws.amazon.com/
|
990
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html
|
991
|
+
# [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
|
992
|
+
# [3]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms
|
993
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
994
|
+
# [5]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
|
995
|
+
# [6]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
|
996
|
+
# [7]: https://docs.aws.amazon.com/general/latest/gr/sns.html
|
915
997
|
#
|
916
998
|
# @option params [Array<Types::Tag>] :tags
|
917
999
|
# The list of tags to add to a new topic.
|
@@ -1949,15 +2031,25 @@ module Aws::SNS
|
|
1949
2031
|
# scope and interval, and only one copy of the message is delivered.
|
1950
2032
|
#
|
1951
2033
|
# @option params [String] :message_group_id
|
1952
|
-
#
|
1953
|
-
# `
|
1954
|
-
#
|
2034
|
+
# The `MessageGroupId` can contain up to 128 alphanumeric characters
|
2035
|
+
# `(a-z, A-Z, 0-9)` and punctuation ``
|
2036
|
+
# (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
|
2037
|
+
#
|
2038
|
+
# For FIFO topics: The `MessageGroupId` is a tag that specifies that a
|
2039
|
+
# message belongs to a specific message group. Messages that belong to
|
2040
|
+
# the same message group are processed in a FIFO manner (however,
|
2041
|
+
# messages in different message groups might be processed out of order).
|
2042
|
+
# Every message must include a `MessageGroupId`.
|
2043
|
+
#
|
2044
|
+
# For standard topics: The `MessageGroupId` is optional and is forwarded
|
2045
|
+
# only to Amazon SQS standard subscriptions to activate [fair
|
2046
|
+
# queues][1]. The `MessageGroupId` is not used for, or sent to, any
|
2047
|
+
# other endpoint types. When provided, the same validation rules apply
|
2048
|
+
# as for FIFO topics.
|
2049
|
+
#
|
1955
2050
|
#
|
1956
|
-
#
|
1957
|
-
#
|
1958
|
-
# group are processed in a FIFO manner (however, messages in different
|
1959
|
-
# message groups might be processed out of order). Every message must
|
1960
|
-
# include a `MessageGroupId`.
|
2051
|
+
#
|
2052
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fair-queues.html
|
1961
2053
|
#
|
1962
2054
|
# @return [Types::PublishResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1963
2055
|
#
|
@@ -1998,34 +2090,45 @@ module Aws::SNS
|
|
1998
2090
|
req.send_request(options)
|
1999
2091
|
end
|
2000
2092
|
|
2001
|
-
# Publishes up to
|
2002
|
-
# version of `Publish
|
2003
|
-
#
|
2004
|
-
#
|
2093
|
+
# Publishes up to 10 messages to the specified topic in a single batch.
|
2094
|
+
# This is a batch version of the `Publish` API. If you try to send more
|
2095
|
+
# than 10 messages in a single batch request, you will receive a
|
2096
|
+
# `TooManyEntriesInBatchRequest` exception.
|
2097
|
+
#
|
2098
|
+
# For FIFO topics, multiple messages within a single batch are published
|
2099
|
+
# in the order they are sent, and messages are deduplicated within the
|
2100
|
+
# batch and across batches for five minutes.
|
2005
2101
|
#
|
2006
2102
|
# The result of publishing each message is reported individually in the
|
2007
2103
|
# response. Because the batch request can result in a combination of
|
2008
2104
|
# successful and unsuccessful actions, you should check for batch errors
|
2009
|
-
# even when the call returns an HTTP status code of
|
2105
|
+
# even when the call returns an HTTP status code of 200.
|
2010
2106
|
#
|
2011
2107
|
# The maximum allowed individual message size and the maximum total
|
2012
2108
|
# payload size (the sum of the individual lengths of all of the batched
|
2013
2109
|
# messages) are both 256 KB (262,144 bytes).
|
2014
2110
|
#
|
2111
|
+
# The `PublishBatch` API can send up to 10 messages at a time. If you
|
2112
|
+
# attempt to send more than 10 messages in one request, you will
|
2113
|
+
# encounter a `TooManyEntriesInBatchRequest` exception. In such cases,
|
2114
|
+
# split your messages into multiple requests, each containing no more
|
2115
|
+
# than 10 messages.
|
2116
|
+
#
|
2015
2117
|
# Some actions take lists of parameters. These lists are specified using
|
2016
|
-
# the `param.n` notation. Values of `n` are integers starting from
|
2017
|
-
# For example, a parameter list with two elements looks like
|
2118
|
+
# the `param.n` notation. Values of `n` are integers starting from
|
2119
|
+
# **1**. For example, a parameter list with two elements looks like
|
2120
|
+
# this:
|
2018
2121
|
#
|
2019
|
-
#
|
2122
|
+
# `&AttributeName.1=first`
|
2020
2123
|
#
|
2021
|
-
#
|
2124
|
+
# `&AttributeName.2=second`
|
2022
2125
|
#
|
2023
2126
|
# If you send a batch message to a topic, Amazon SNS publishes the batch
|
2024
2127
|
# message to each endpoint that is subscribed to the topic. The format
|
2025
2128
|
# of the batch message depends on the notification protocol for each
|
2026
2129
|
# subscribed endpoint.
|
2027
2130
|
#
|
2028
|
-
# When a `messageId` is returned, the batch message is saved and Amazon
|
2131
|
+
# When a `messageId` is returned, the batch message is saved, and Amazon
|
2029
2132
|
# SNS immediately delivers the message to subscribers.
|
2030
2133
|
#
|
2031
2134
|
# @option params [required, String] :topic_arn
|
@@ -2530,10 +2633,6 @@ module Aws::SNS
|
|
2530
2633
|
# The following lists the names, descriptions, and values of the special
|
2531
2634
|
# request parameters that the `SetTopicAttributes` action uses:
|
2532
2635
|
#
|
2533
|
-
# * `ApplicationSuccessFeedbackRoleArn` – Indicates failed message
|
2534
|
-
# delivery status for an Amazon SNS topic that is subscribed to a
|
2535
|
-
# platform application endpoint.
|
2536
|
-
#
|
2537
2636
|
# * `DeliveryPolicy` – The policy that defines how Amazon SNS retries
|
2538
2637
|
# failed deliveries to HTTP/S endpoints.
|
2539
2638
|
#
|
@@ -2563,19 +2662,19 @@ module Aws::SNS
|
|
2563
2662
|
# * `HTTPFailureFeedbackRoleArn` – Indicates failed message delivery
|
2564
2663
|
# status for an Amazon SNS topic that is subscribed to an HTTP
|
2565
2664
|
# endpoint.
|
2566
|
-
# * Amazon
|
2665
|
+
# * Amazon Data Firehose
|
2567
2666
|
#
|
2568
2667
|
# * `FirehoseSuccessFeedbackRoleArn` – Indicates successful message
|
2569
2668
|
# delivery status for an Amazon SNS topic that is subscribed to an
|
2570
|
-
# Amazon
|
2669
|
+
# Amazon Data Firehose endpoint.
|
2571
2670
|
#
|
2572
2671
|
# * `FirehoseSuccessFeedbackSampleRate` – Indicates percentage of
|
2573
2672
|
# successful messages to sample for an Amazon SNS topic that is
|
2574
|
-
# subscribed to an Amazon
|
2673
|
+
# subscribed to an Amazon Data Firehose endpoint.
|
2575
2674
|
#
|
2576
2675
|
# * `FirehoseFailureFeedbackRoleArn` – Indicates failed message
|
2577
2676
|
# delivery status for an Amazon SNS topic that is subscribed to an
|
2578
|
-
# Amazon
|
2677
|
+
# Amazon Data Firehose endpoint.
|
2579
2678
|
# * Lambda
|
2580
2679
|
#
|
2581
2680
|
# * `LambdaSuccessFeedbackRoleArn` – Indicates successful message
|
@@ -2593,15 +2692,15 @@ module Aws::SNS
|
|
2593
2692
|
#
|
2594
2693
|
# * `ApplicationSuccessFeedbackRoleArn` – Indicates successful message
|
2595
2694
|
# delivery status for an Amazon SNS topic that is subscribed to an
|
2596
|
-
#
|
2695
|
+
# platform application endpoint.
|
2597
2696
|
#
|
2598
2697
|
# * `ApplicationSuccessFeedbackSampleRate` – Indicates percentage of
|
2599
2698
|
# successful messages to sample for an Amazon SNS topic that is
|
2600
|
-
# subscribed to an
|
2699
|
+
# subscribed to an platform application endpoint.
|
2601
2700
|
#
|
2602
2701
|
# * `ApplicationFailureFeedbackRoleArn` – Indicates failed message
|
2603
2702
|
# delivery status for an Amazon SNS topic that is subscribed to an
|
2604
|
-
#
|
2703
|
+
# platform application endpoint.
|
2605
2704
|
# <note markdown="1"> In addition to being able to configure topic attributes for message
|
2606
2705
|
# delivery status of notification messages sent to Amazon SNS
|
2607
2706
|
# application endpoints, you can also configure application attributes
|
@@ -2753,8 +2852,8 @@ module Aws::SNS
|
|
2753
2852
|
#
|
2754
2853
|
# * `lambda` – delivery of JSON-encoded message to an Lambda function
|
2755
2854
|
#
|
2756
|
-
# * `firehose` – delivery of JSON-encoded message to an Amazon
|
2757
|
-
#
|
2855
|
+
# * `firehose` – delivery of JSON-encoded message to an Amazon Data
|
2856
|
+
# Firehose delivery stream.
|
2758
2857
|
#
|
2759
2858
|
# @option params [String] :endpoint
|
2760
2859
|
# The endpoint that you want to receive notifications. Endpoints vary by
|
@@ -2783,7 +2882,7 @@ module Aws::SNS
|
|
2783
2882
|
# function.
|
2784
2883
|
#
|
2785
2884
|
# * For the `firehose` protocol, the endpoint is the ARN of an Amazon
|
2786
|
-
#
|
2885
|
+
# Data Firehose delivery stream.
|
2787
2886
|
#
|
2788
2887
|
# @option params [Hash<String,String>] :attributes
|
2789
2888
|
# A map of attributes with their corresponding values.
|
@@ -2962,12 +3061,6 @@ module Aws::SNS
|
|
2962
3061
|
# is delivered to the endpoint, so that the endpoint owner can easily
|
2963
3062
|
# resubscribe to the topic if the `Unsubscribe` request was unintended.
|
2964
3063
|
#
|
2965
|
-
# <note markdown="1"> Amazon SQS queue subscriptions require authentication for deletion.
|
2966
|
-
# Only the owner of the subscription, or the owner of the topic can
|
2967
|
-
# unsubscribe using the required Amazon Web Services signature.
|
2968
|
-
#
|
2969
|
-
# </note>
|
2970
|
-
#
|
2971
3064
|
# This action is throttled at 100 transactions per second (TPS).
|
2972
3065
|
#
|
2973
3066
|
# @option params [required, String] :subscription_arn
|
@@ -3081,7 +3174,7 @@ module Aws::SNS
|
|
3081
3174
|
tracer: tracer
|
3082
3175
|
)
|
3083
3176
|
context[:gem_name] = 'aws-sdk-sns'
|
3084
|
-
context[:gem_version] = '1.
|
3177
|
+
context[:gem_version] = '1.103.0'
|
3085
3178
|
Seahorse::Client::Request.new(handlers, context)
|
3086
3179
|
end
|
3087
3180
|
|
@@ -266,15 +266,25 @@ module Aws::SNS
|
|
266
266
|
# the two messages are treated as duplicates, within the deduplication
|
267
267
|
# scope and interval, and only one copy of the message is delivered.
|
268
268
|
# @option options [String] :message_group_id
|
269
|
-
#
|
270
|
-
# `
|
271
|
-
#
|
272
|
-
#
|
273
|
-
# The `MessageGroupId` is a tag that specifies that a
|
274
|
-
# a specific message group. Messages that belong to
|
275
|
-
# group are processed in a FIFO manner (however,
|
276
|
-
# message groups might be processed out of order).
|
277
|
-
# include a `MessageGroupId`.
|
269
|
+
# The `MessageGroupId` can contain up to 128 alphanumeric characters
|
270
|
+
# `(a-z, A-Z, 0-9)` and punctuation ``
|
271
|
+
# (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
|
272
|
+
#
|
273
|
+
# For FIFO topics: The `MessageGroupId` is a tag that specifies that a
|
274
|
+
# message belongs to a specific message group. Messages that belong to
|
275
|
+
# the same message group are processed in a FIFO manner (however,
|
276
|
+
# messages in different message groups might be processed out of order).
|
277
|
+
# Every message must include a `MessageGroupId`.
|
278
|
+
#
|
279
|
+
# For standard topics: The `MessageGroupId` is optional and is forwarded
|
280
|
+
# only to Amazon SQS standard subscriptions to activate [fair
|
281
|
+
# queues][1]. The `MessageGroupId` is not used for, or sent to, any
|
282
|
+
# other endpoint types. When provided, the same validation rules apply
|
283
|
+
# as for FIFO topics.
|
284
|
+
#
|
285
|
+
#
|
286
|
+
#
|
287
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fair-queues.html
|
278
288
|
# @return [Types::PublishResponse]
|
279
289
|
def publish(options = {})
|
280
290
|
options = options.merge(target_arn: @arn)
|
data/lib/aws-sdk-sns/resource.rb
CHANGED
@@ -108,17 +108,9 @@ module Aws::SNS
|
|
108
108
|
# * `DisplayName` – The display name to use for a topic with SMS
|
109
109
|
# subscriptions.
|
110
110
|
#
|
111
|
-
# * `FifoTopic` – Set to true to create a FIFO topic.
|
112
|
-
#
|
113
111
|
# * `Policy` – The policy that defines who can access your topic. By
|
114
112
|
# default, only the topic owner can publish or subscribe to the topic.
|
115
113
|
#
|
116
|
-
# * `SignatureVersion` – The signature version corresponds to the
|
117
|
-
# hashing algorithm used while creating the signature of the
|
118
|
-
# notifications, subscription confirmations, or unsubscribe
|
119
|
-
# confirmation messages sent by Amazon SNS. By default,
|
120
|
-
# `SignatureVersion` is set to `1`.
|
121
|
-
#
|
122
114
|
# * `TracingConfig` – Tracing mode of an Amazon SNS topic. By default
|
123
115
|
# `TracingConfig` is set to `PassThrough`, and the topic passes
|
124
116
|
# through the tracing header it receives from an Amazon SNS publisher
|
@@ -126,16 +118,104 @@ module Aws::SNS
|
|
126
118
|
# segment data to topic owner account if the sampled flag in the
|
127
119
|
# tracing header is true. This is only supported on standard topics.
|
128
120
|
#
|
129
|
-
#
|
121
|
+
# * HTTP
|
122
|
+
#
|
123
|
+
# * `HTTPSuccessFeedbackRoleArn` – Indicates successful message
|
124
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
125
|
+
# HTTP endpoint.
|
126
|
+
#
|
127
|
+
# * `HTTPSuccessFeedbackSampleRate` – Indicates percentage of
|
128
|
+
# successful messages to sample for an Amazon SNS topic that is
|
129
|
+
# subscribed to an HTTP endpoint.
|
130
|
+
#
|
131
|
+
# * `HTTPFailureFeedbackRoleArn` – Indicates failed message delivery
|
132
|
+
# status for an Amazon SNS topic that is subscribed to an HTTP
|
133
|
+
# endpoint.
|
134
|
+
# * Amazon Data Firehose
|
135
|
+
#
|
136
|
+
# * `FirehoseSuccessFeedbackRoleArn` – Indicates successful message
|
137
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
138
|
+
# Amazon Data Firehose endpoint.
|
139
|
+
#
|
140
|
+
# * `FirehoseSuccessFeedbackSampleRate` – Indicates percentage of
|
141
|
+
# successful messages to sample for an Amazon SNS topic that is
|
142
|
+
# subscribed to an Amazon Data Firehose endpoint.
|
143
|
+
#
|
144
|
+
# * `FirehoseFailureFeedbackRoleArn` – Indicates failed message
|
145
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
146
|
+
# Amazon Data Firehose endpoint.
|
147
|
+
# * Lambda
|
148
|
+
#
|
149
|
+
# * `LambdaSuccessFeedbackRoleArn` – Indicates successful message
|
150
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
151
|
+
# Lambda endpoint.
|
152
|
+
#
|
153
|
+
# * `LambdaSuccessFeedbackSampleRate` – Indicates percentage of
|
154
|
+
# successful messages to sample for an Amazon SNS topic that is
|
155
|
+
# subscribed to an Lambda endpoint.
|
156
|
+
#
|
157
|
+
# * `LambdaFailureFeedbackRoleArn` – Indicates failed message delivery
|
158
|
+
# status for an Amazon SNS topic that is subscribed to an Lambda
|
159
|
+
# endpoint.
|
160
|
+
# * Platform application endpoint
|
161
|
+
#
|
162
|
+
# * `ApplicationSuccessFeedbackRoleArn` – Indicates successful message
|
163
|
+
# delivery status for an Amazon SNS topic that is subscribed to a
|
164
|
+
# platform application endpoint.
|
165
|
+
#
|
166
|
+
# * `ApplicationSuccessFeedbackSampleRate` – Indicates percentage of
|
167
|
+
# successful messages to sample for an Amazon SNS topic that is
|
168
|
+
# subscribed to an platform application endpoint.
|
169
|
+
#
|
170
|
+
# * `ApplicationFailureFeedbackRoleArn` – Indicates failed message
|
171
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
172
|
+
# platform application endpoint.
|
173
|
+
# <note markdown="1"> In addition to being able to configure topic attributes for message
|
174
|
+
# delivery status of notification messages sent to Amazon SNS
|
175
|
+
# application endpoints, you can also configure application attributes
|
176
|
+
# for the delivery status of push notification messages sent to push
|
177
|
+
# notification services.
|
178
|
+
#
|
179
|
+
# For example, For more information, see [Using Amazon SNS Application
|
180
|
+
# Attributes for Message Delivery Status][1].
|
181
|
+
#
|
182
|
+
# </note>
|
183
|
+
#
|
184
|
+
# * Amazon SQS
|
185
|
+
#
|
186
|
+
# * `SQSSuccessFeedbackRoleArn` – Indicates successful message
|
187
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
188
|
+
# Amazon SQS endpoint.
|
189
|
+
#
|
190
|
+
# * `SQSSuccessFeedbackSampleRate` – Indicates percentage of
|
191
|
+
# successful messages to sample for an Amazon SNS topic that is
|
192
|
+
# subscribed to an Amazon SQS endpoint.
|
193
|
+
#
|
194
|
+
# * `SQSFailureFeedbackRoleArn` – Indicates failed message delivery
|
195
|
+
# status for an Amazon SNS topic that is subscribed to an Amazon SQS
|
196
|
+
# endpoint.
|
197
|
+
#
|
198
|
+
# <note markdown="1"> The <ENDPOINT>SuccessFeedbackRoleArn and
|
199
|
+
# <ENDPOINT>FailureFeedbackRoleArn attributes are used to give
|
200
|
+
# Amazon SNS write access to use CloudWatch Logs on your behalf. The
|
201
|
+
# <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying
|
202
|
+
# the sample rate percentage (0-100) of successfully delivered messages.
|
203
|
+
# After you configure the <ENDPOINT>FailureFeedbackRoleArn
|
204
|
+
# attribute, then all failed message deliveries generate CloudWatch
|
205
|
+
# Logs.
|
206
|
+
#
|
207
|
+
# </note>
|
208
|
+
#
|
209
|
+
# The following attribute applies only to [server-side encryption][2]:
|
130
210
|
#
|
131
211
|
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
132
212
|
# master key (CMK) for Amazon SNS or a custom CMK. For more
|
133
|
-
# information, see [Key Terms][
|
213
|
+
# information, see [Key Terms][3]. For more examples, see [KeyId][4]
|
134
214
|
# in the *Key Management Service API Reference*.
|
135
215
|
#
|
136
216
|
# ^
|
137
217
|
#
|
138
|
-
# The following attributes apply only to [FIFO topics][
|
218
|
+
# The following attributes apply only to [FIFO topics][5]:
|
139
219
|
#
|
140
220
|
# * `ArchivePolicy` – The policy that sets the retention period for
|
141
221
|
# messages stored in the message archive of an Amazon SNS FIFO topic.
|
@@ -146,7 +226,7 @@ module Aws::SNS
|
|
146
226
|
# * By default, `ContentBasedDeduplication` is set to `false`. If you
|
147
227
|
# create a FIFO topic and this attribute is `false`, you must
|
148
228
|
# specify a value for the `MessageDeduplicationId` parameter for the
|
149
|
-
# [Publish][
|
229
|
+
# [Publish][6] action.
|
150
230
|
#
|
151
231
|
# * When you set `ContentBasedDeduplication` to `true`, Amazon SNS
|
152
232
|
# uses a SHA-256 hash to generate the `MessageDeduplicationId` using
|
@@ -169,17 +249,18 @@ module Aws::SNS
|
|
169
249
|
# * `MessageGroup` – The scope of deduplication is within each
|
170
250
|
# individual message group, which enables higher throughput per
|
171
251
|
# topic subject to regional quotas. For more information on quotas
|
172
|
-
# or to request an increase, see [Amazon SNS service quotas][
|
252
|
+
# or to request an increase, see [Amazon SNS service quotas][7] in
|
173
253
|
# the Amazon Web Services General Reference.
|
174
254
|
#
|
175
255
|
#
|
176
256
|
#
|
177
|
-
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-
|
178
|
-
# [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
|
179
|
-
# [3]: https://docs.aws.amazon.com/
|
180
|
-
# [4]: https://docs.aws.amazon.com/
|
181
|
-
# [5]: https://docs.aws.amazon.com/sns/latest/
|
182
|
-
# [6]: https://docs.aws.amazon.com/
|
257
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html
|
258
|
+
# [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
|
259
|
+
# [3]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms
|
260
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
261
|
+
# [5]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
|
262
|
+
# [6]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
|
263
|
+
# [7]: https://docs.aws.amazon.com/general/latest/gr/sns.html
|
183
264
|
# @option options [Array<Types::Tag>] :tags
|
184
265
|
# The list of tags to add to a new topic.
|
185
266
|
#
|
data/lib/aws-sdk-sns/topic.rb
CHANGED
@@ -394,15 +394,25 @@ module Aws::SNS
|
|
394
394
|
# the two messages are treated as duplicates, within the deduplication
|
395
395
|
# scope and interval, and only one copy of the message is delivered.
|
396
396
|
# @option options [String] :message_group_id
|
397
|
-
#
|
398
|
-
# `
|
399
|
-
#
|
400
|
-
#
|
401
|
-
# The `MessageGroupId` is a tag that specifies that a
|
402
|
-
# a specific message group. Messages that belong to
|
403
|
-
# group are processed in a FIFO manner (however,
|
404
|
-
# message groups might be processed out of order).
|
405
|
-
# include a `MessageGroupId`.
|
397
|
+
# The `MessageGroupId` can contain up to 128 alphanumeric characters
|
398
|
+
# `(a-z, A-Z, 0-9)` and punctuation ``
|
399
|
+
# (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
|
400
|
+
#
|
401
|
+
# For FIFO topics: The `MessageGroupId` is a tag that specifies that a
|
402
|
+
# message belongs to a specific message group. Messages that belong to
|
403
|
+
# the same message group are processed in a FIFO manner (however,
|
404
|
+
# messages in different message groups might be processed out of order).
|
405
|
+
# Every message must include a `MessageGroupId`.
|
406
|
+
#
|
407
|
+
# For standard topics: The `MessageGroupId` is optional and is forwarded
|
408
|
+
# only to Amazon SQS standard subscriptions to activate [fair
|
409
|
+
# queues][1]. The `MessageGroupId` is not used for, or sent to, any
|
410
|
+
# other endpoint types. When provided, the same validation rules apply
|
411
|
+
# as for FIFO topics.
|
412
|
+
#
|
413
|
+
#
|
414
|
+
#
|
415
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fair-queues.html
|
406
416
|
# @return [Types::PublishResponse]
|
407
417
|
def publish(options = {})
|
408
418
|
options = options.merge(topic_arn: @arn)
|
@@ -442,10 +452,6 @@ module Aws::SNS
|
|
442
452
|
# The following lists the names, descriptions, and values of the special
|
443
453
|
# request parameters that the `SetTopicAttributes` action uses:
|
444
454
|
#
|
445
|
-
# * `ApplicationSuccessFeedbackRoleArn` – Indicates failed message
|
446
|
-
# delivery status for an Amazon SNS topic that is subscribed to a
|
447
|
-
# platform application endpoint.
|
448
|
-
#
|
449
455
|
# * `DeliveryPolicy` – The policy that defines how Amazon SNS retries
|
450
456
|
# failed deliveries to HTTP/S endpoints.
|
451
457
|
#
|
@@ -475,19 +481,19 @@ module Aws::SNS
|
|
475
481
|
# * `HTTPFailureFeedbackRoleArn` – Indicates failed message delivery
|
476
482
|
# status for an Amazon SNS topic that is subscribed to an HTTP
|
477
483
|
# endpoint.
|
478
|
-
# * Amazon
|
484
|
+
# * Amazon Data Firehose
|
479
485
|
#
|
480
486
|
# * `FirehoseSuccessFeedbackRoleArn` – Indicates successful message
|
481
487
|
# delivery status for an Amazon SNS topic that is subscribed to an
|
482
|
-
# Amazon
|
488
|
+
# Amazon Data Firehose endpoint.
|
483
489
|
#
|
484
490
|
# * `FirehoseSuccessFeedbackSampleRate` – Indicates percentage of
|
485
491
|
# successful messages to sample for an Amazon SNS topic that is
|
486
|
-
# subscribed to an Amazon
|
492
|
+
# subscribed to an Amazon Data Firehose endpoint.
|
487
493
|
#
|
488
494
|
# * `FirehoseFailureFeedbackRoleArn` – Indicates failed message
|
489
495
|
# delivery status for an Amazon SNS topic that is subscribed to an
|
490
|
-
# Amazon
|
496
|
+
# Amazon Data Firehose endpoint.
|
491
497
|
# * Lambda
|
492
498
|
#
|
493
499
|
# * `LambdaSuccessFeedbackRoleArn` – Indicates successful message
|
@@ -505,15 +511,15 @@ module Aws::SNS
|
|
505
511
|
#
|
506
512
|
# * `ApplicationSuccessFeedbackRoleArn` – Indicates successful message
|
507
513
|
# delivery status for an Amazon SNS topic that is subscribed to an
|
508
|
-
#
|
514
|
+
# platform application endpoint.
|
509
515
|
#
|
510
516
|
# * `ApplicationSuccessFeedbackSampleRate` – Indicates percentage of
|
511
517
|
# successful messages to sample for an Amazon SNS topic that is
|
512
|
-
# subscribed to an
|
518
|
+
# subscribed to an platform application endpoint.
|
513
519
|
#
|
514
520
|
# * `ApplicationFailureFeedbackRoleArn` – Indicates failed message
|
515
521
|
# delivery status for an Amazon SNS topic that is subscribed to an
|
516
|
-
#
|
522
|
+
# platform application endpoint.
|
517
523
|
# <note markdown="1"> In addition to being able to configure topic attributes for message
|
518
524
|
# delivery status of notification messages sent to Amazon SNS
|
519
525
|
# application endpoints, you can also configure application attributes
|
@@ -651,8 +657,8 @@ module Aws::SNS
|
|
651
657
|
#
|
652
658
|
# * `lambda` – delivery of JSON-encoded message to an Lambda function
|
653
659
|
#
|
654
|
-
# * `firehose` – delivery of JSON-encoded message to an Amazon
|
655
|
-
#
|
660
|
+
# * `firehose` – delivery of JSON-encoded message to an Amazon Data
|
661
|
+
# Firehose delivery stream.
|
656
662
|
# @option options [String] :endpoint
|
657
663
|
# The endpoint that you want to receive notifications. Endpoints vary by
|
658
664
|
# protocol:
|
@@ -680,7 +686,7 @@ module Aws::SNS
|
|
680
686
|
# function.
|
681
687
|
#
|
682
688
|
# * For the `firehose` protocol, the endpoint is the ARN of an Amazon
|
683
|
-
#
|
689
|
+
# Data Firehose delivery stream.
|
684
690
|
# @option options [Hash<String,String>] :attributes
|
685
691
|
# A map of attributes with their corresponding values.
|
686
692
|
#
|
data/lib/aws-sdk-sns/types.rb
CHANGED
@@ -354,18 +354,10 @@ module Aws::SNS
|
|
354
354
|
# * `DisplayName` – The display name to use for a topic with SMS
|
355
355
|
# subscriptions.
|
356
356
|
#
|
357
|
-
# * `FifoTopic` – Set to true to create a FIFO topic.
|
358
|
-
#
|
359
357
|
# * `Policy` – The policy that defines who can access your topic. By
|
360
358
|
# default, only the topic owner can publish or subscribe to the
|
361
359
|
# topic.
|
362
360
|
#
|
363
|
-
# * `SignatureVersion` – The signature version corresponds to the
|
364
|
-
# hashing algorithm used while creating the signature of the
|
365
|
-
# notifications, subscription confirmations, or unsubscribe
|
366
|
-
# confirmation messages sent by Amazon SNS. By default,
|
367
|
-
# `SignatureVersion` is set to `1`.
|
368
|
-
#
|
369
361
|
# * `TracingConfig` – Tracing mode of an Amazon SNS topic. By default
|
370
362
|
# `TracingConfig` is set to `PassThrough`, and the topic passes
|
371
363
|
# through the tracing header it receives from an Amazon SNS
|
@@ -374,16 +366,104 @@ module Aws::SNS
|
|
374
366
|
# flag in the tracing header is true. This is only supported on
|
375
367
|
# standard topics.
|
376
368
|
#
|
377
|
-
#
|
369
|
+
# * HTTP
|
370
|
+
#
|
371
|
+
# * `HTTPSuccessFeedbackRoleArn` – Indicates successful message
|
372
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
373
|
+
# HTTP endpoint.
|
374
|
+
#
|
375
|
+
# * `HTTPSuccessFeedbackSampleRate` – Indicates percentage of
|
376
|
+
# successful messages to sample for an Amazon SNS topic that is
|
377
|
+
# subscribed to an HTTP endpoint.
|
378
|
+
#
|
379
|
+
# * `HTTPFailureFeedbackRoleArn` – Indicates failed message delivery
|
380
|
+
# status for an Amazon SNS topic that is subscribed to an HTTP
|
381
|
+
# endpoint.
|
382
|
+
# * Amazon Data Firehose
|
383
|
+
#
|
384
|
+
# * `FirehoseSuccessFeedbackRoleArn` – Indicates successful message
|
385
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
386
|
+
# Amazon Data Firehose endpoint.
|
387
|
+
#
|
388
|
+
# * `FirehoseSuccessFeedbackSampleRate` – Indicates percentage of
|
389
|
+
# successful messages to sample for an Amazon SNS topic that is
|
390
|
+
# subscribed to an Amazon Data Firehose endpoint.
|
391
|
+
#
|
392
|
+
# * `FirehoseFailureFeedbackRoleArn` – Indicates failed message
|
393
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
394
|
+
# Amazon Data Firehose endpoint.
|
395
|
+
# * Lambda
|
396
|
+
#
|
397
|
+
# * `LambdaSuccessFeedbackRoleArn` – Indicates successful message
|
398
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
399
|
+
# Lambda endpoint.
|
400
|
+
#
|
401
|
+
# * `LambdaSuccessFeedbackSampleRate` – Indicates percentage of
|
402
|
+
# successful messages to sample for an Amazon SNS topic that is
|
403
|
+
# subscribed to an Lambda endpoint.
|
404
|
+
#
|
405
|
+
# * `LambdaFailureFeedbackRoleArn` – Indicates failed message
|
406
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
407
|
+
# Lambda endpoint.
|
408
|
+
# * Platform application endpoint
|
409
|
+
#
|
410
|
+
# * `ApplicationSuccessFeedbackRoleArn` – Indicates successful
|
411
|
+
# message delivery status for an Amazon SNS topic that is
|
412
|
+
# subscribed to a platform application endpoint.
|
413
|
+
#
|
414
|
+
# * `ApplicationSuccessFeedbackSampleRate` – Indicates percentage of
|
415
|
+
# successful messages to sample for an Amazon SNS topic that is
|
416
|
+
# subscribed to an platform application endpoint.
|
417
|
+
#
|
418
|
+
# * `ApplicationFailureFeedbackRoleArn` – Indicates failed message
|
419
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
420
|
+
# platform application endpoint.
|
421
|
+
# <note markdown="1"> In addition to being able to configure topic attributes for
|
422
|
+
# message delivery status of notification messages sent to Amazon
|
423
|
+
# SNS application endpoints, you can also configure application
|
424
|
+
# attributes for the delivery status of push notification messages
|
425
|
+
# sent to push notification services.
|
426
|
+
#
|
427
|
+
# For example, For more information, see [Using Amazon SNS
|
428
|
+
# Application Attributes for Message Delivery Status][1].
|
429
|
+
#
|
430
|
+
# </note>
|
431
|
+
#
|
432
|
+
# * Amazon SQS
|
433
|
+
#
|
434
|
+
# * `SQSSuccessFeedbackRoleArn` – Indicates successful message
|
435
|
+
# delivery status for an Amazon SNS topic that is subscribed to an
|
436
|
+
# Amazon SQS endpoint.
|
437
|
+
#
|
438
|
+
# * `SQSSuccessFeedbackSampleRate` – Indicates percentage of
|
439
|
+
# successful messages to sample for an Amazon SNS topic that is
|
440
|
+
# subscribed to an Amazon SQS endpoint.
|
441
|
+
#
|
442
|
+
# * `SQSFailureFeedbackRoleArn` – Indicates failed message delivery
|
443
|
+
# status for an Amazon SNS topic that is subscribed to an Amazon
|
444
|
+
# SQS endpoint.
|
445
|
+
#
|
446
|
+
# <note markdown="1"> The <ENDPOINT>SuccessFeedbackRoleArn and
|
447
|
+
# <ENDPOINT>FailureFeedbackRoleArn attributes are used to give
|
448
|
+
# Amazon SNS write access to use CloudWatch Logs on your behalf. The
|
449
|
+
# <ENDPOINT>SuccessFeedbackSampleRate attribute is for
|
450
|
+
# specifying the sample rate percentage (0-100) of successfully
|
451
|
+
# delivered messages. After you configure the
|
452
|
+
# <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed
|
453
|
+
# message deliveries generate CloudWatch Logs.
|
454
|
+
#
|
455
|
+
# </note>
|
456
|
+
#
|
457
|
+
# The following attribute applies only to [server-side encryption][2]:
|
378
458
|
#
|
379
459
|
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
|
380
460
|
# customer master key (CMK) for Amazon SNS or a custom CMK. For more
|
381
|
-
# information, see [Key Terms][
|
461
|
+
# information, see [Key Terms][3]. For more examples, see [KeyId][4]
|
382
462
|
# in the *Key Management Service API Reference*.
|
383
463
|
#
|
384
464
|
# ^
|
385
465
|
#
|
386
|
-
# The following attributes apply only to [FIFO topics][
|
466
|
+
# The following attributes apply only to [FIFO topics][5]:
|
387
467
|
#
|
388
468
|
# * `ArchivePolicy` – The policy that sets the retention period for
|
389
469
|
# messages stored in the message archive of an Amazon SNS FIFO
|
@@ -395,7 +475,7 @@ module Aws::SNS
|
|
395
475
|
# * By default, `ContentBasedDeduplication` is set to `false`. If
|
396
476
|
# you create a FIFO topic and this attribute is `false`, you must
|
397
477
|
# specify a value for the `MessageDeduplicationId` parameter for
|
398
|
-
# the [Publish][
|
478
|
+
# the [Publish][6] action.
|
399
479
|
#
|
400
480
|
# * When you set `ContentBasedDeduplication` to `true`, Amazon SNS
|
401
481
|
# uses a SHA-256 hash to generate the `MessageDeduplicationId`
|
@@ -419,17 +499,18 @@ module Aws::SNS
|
|
419
499
|
# * `MessageGroup` – The scope of deduplication is within each
|
420
500
|
# individual message group, which enables higher throughput per
|
421
501
|
# topic subject to regional quotas. For more information on quotas
|
422
|
-
# or to request an increase, see [Amazon SNS service quotas][
|
502
|
+
# or to request an increase, see [Amazon SNS service quotas][7] in
|
423
503
|
# the Amazon Web Services General Reference.
|
424
504
|
#
|
425
505
|
#
|
426
506
|
#
|
427
|
-
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-
|
428
|
-
# [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
|
429
|
-
# [3]: https://docs.aws.amazon.com/
|
430
|
-
# [4]: https://docs.aws.amazon.com/
|
431
|
-
# [5]: https://docs.aws.amazon.com/sns/latest/
|
432
|
-
# [6]: https://docs.aws.amazon.com/
|
507
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html
|
508
|
+
# [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
|
509
|
+
# [3]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms
|
510
|
+
# [4]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
511
|
+
# [5]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
|
512
|
+
# [6]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
|
513
|
+
# [7]: https://docs.aws.amazon.com/general/latest/gr/sns.html
|
433
514
|
# @return [Hash<String,String>]
|
434
515
|
#
|
435
516
|
# @!attribute [rw] tags
|
@@ -580,7 +661,7 @@ module Aws::SNS
|
|
580
661
|
|
581
662
|
# Indicates that the number of filter polices in your Amazon Web
|
582
663
|
# Services account exceeds the limit. To add more filter polices, submit
|
583
|
-
# an Amazon SNS Limit Increase case in the Amazon Web
|
664
|
+
# an Amazon SNS Limit Increase case in the Amazon Web ServicesSupport
|
584
665
|
# Center.
|
585
666
|
#
|
586
667
|
# @!attribute [rw] message
|
@@ -1734,7 +1815,7 @@ module Aws::SNS
|
|
1734
1815
|
# that is a string.
|
1735
1816
|
#
|
1736
1817
|
# You can define other top-level keys that define the message you want
|
1737
|
-
# to send to a specific transport protocol (
|
1818
|
+
# to send to a specific transport protocol (for example, http).
|
1738
1819
|
# @return [String]
|
1739
1820
|
#
|
1740
1821
|
# @!attribute [rw] message_attributes
|
@@ -1812,27 +1893,30 @@ module Aws::SNS
|
|
1812
1893
|
# @return [String]
|
1813
1894
|
#
|
1814
1895
|
# @!attribute [rw] message_group_id
|
1815
|
-
#
|
1816
|
-
#
|
1817
|
-
#
|
1818
|
-
#
|
1819
|
-
#
|
1820
|
-
#
|
1821
|
-
#
|
1822
|
-
#
|
1823
|
-
#
|
1824
|
-
#
|
1825
|
-
#
|
1826
|
-
#
|
1827
|
-
#
|
1896
|
+
# FIFO topics: The tag that specifies that a message belongs to a
|
1897
|
+
# specific message group. Messages that belong to the same message
|
1898
|
+
# group are processed in a FIFO manner (however, messages in different
|
1899
|
+
# message groups might be processed out of order). To interleave
|
1900
|
+
# multiple ordered streams within a single topic, use `MessageGroupId`
|
1901
|
+
# values (for example, session data for multiple users). In this
|
1902
|
+
# scenario, multiple consumers can process the topic, but the session
|
1903
|
+
# data of each user is processed in a FIFO fashion. You must associate
|
1904
|
+
# a non-empty `MessageGroupId` with a message. If you do not provide a
|
1905
|
+
# `MessageGroupId`, the action fails.
|
1906
|
+
#
|
1907
|
+
# Standard topics: The `MessageGroupId` is optional and is forwarded
|
1908
|
+
# only to Amazon SQS standard subscriptions to activate [fair
|
1909
|
+
# queues][1]. The `MessageGroupId` is not used for, or sent to, any
|
1910
|
+
# other endpoint types.
|
1828
1911
|
#
|
1829
1912
|
# The length of `MessageGroupId` is 128 characters.
|
1830
1913
|
#
|
1831
1914
|
# `MessageGroupId` can contain alphanumeric characters `(a-z, A-Z,
|
1832
1915
|
# 0-9)` and punctuation `` (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
|
1833
1916
|
#
|
1834
|
-
#
|
1835
|
-
#
|
1917
|
+
#
|
1918
|
+
#
|
1919
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fair-queues.html
|
1836
1920
|
# @return [String]
|
1837
1921
|
#
|
1838
1922
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/PublishBatchRequestEntry AWS API Documentation
|
@@ -2060,16 +2144,25 @@ module Aws::SNS
|
|
2060
2144
|
# @return [String]
|
2061
2145
|
#
|
2062
2146
|
# @!attribute [rw] message_group_id
|
2063
|
-
#
|
2064
|
-
# `MessageGroupId` can contain up to 128 alphanumeric characters
|
2147
|
+
# The `MessageGroupId` can contain up to 128 alphanumeric characters
|
2065
2148
|
# `(a-z, A-Z, 0-9)` and punctuation ``
|
2066
2149
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
|
2067
2150
|
#
|
2068
|
-
# The `MessageGroupId` is a tag that specifies that a
|
2069
|
-
# to a specific message group. Messages that belong to
|
2070
|
-
# message group are processed in a FIFO manner (however,
|
2071
|
-
# different message groups might be processed out of
|
2072
|
-
# message must include a `MessageGroupId`.
|
2151
|
+
# For FIFO topics: The `MessageGroupId` is a tag that specifies that a
|
2152
|
+
# message belongs to a specific message group. Messages that belong to
|
2153
|
+
# the same message group are processed in a FIFO manner (however,
|
2154
|
+
# messages in different message groups might be processed out of
|
2155
|
+
# order). Every message must include a `MessageGroupId`.
|
2156
|
+
#
|
2157
|
+
# For standard topics: The `MessageGroupId` is optional and is
|
2158
|
+
# forwarded only to Amazon SQS standard subscriptions to activate
|
2159
|
+
# [fair queues][1]. The `MessageGroupId` is not used for, or sent to,
|
2160
|
+
# any other endpoint types. When provided, the same validation rules
|
2161
|
+
# apply as for FIFO topics.
|
2162
|
+
#
|
2163
|
+
#
|
2164
|
+
#
|
2165
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fair-queues.html
|
2073
2166
|
# @return [String]
|
2074
2167
|
#
|
2075
2168
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/PublishInput AWS API Documentation
|
@@ -2536,10 +2629,6 @@ module Aws::SNS
|
|
2536
2629
|
# special request parameters that the `SetTopicAttributes` action
|
2537
2630
|
# uses:
|
2538
2631
|
#
|
2539
|
-
# * `ApplicationSuccessFeedbackRoleArn` – Indicates failed message
|
2540
|
-
# delivery status for an Amazon SNS topic that is subscribed to a
|
2541
|
-
# platform application endpoint.
|
2542
|
-
#
|
2543
2632
|
# * `DeliveryPolicy` – The policy that defines how Amazon SNS retries
|
2544
2633
|
# failed deliveries to HTTP/S endpoints.
|
2545
2634
|
#
|
@@ -2571,19 +2660,19 @@ module Aws::SNS
|
|
2571
2660
|
# * `HTTPFailureFeedbackRoleArn` – Indicates failed message delivery
|
2572
2661
|
# status for an Amazon SNS topic that is subscribed to an HTTP
|
2573
2662
|
# endpoint.
|
2574
|
-
# * Amazon
|
2663
|
+
# * Amazon Data Firehose
|
2575
2664
|
#
|
2576
2665
|
# * `FirehoseSuccessFeedbackRoleArn` – Indicates successful message
|
2577
2666
|
# delivery status for an Amazon SNS topic that is subscribed to an
|
2578
|
-
# Amazon
|
2667
|
+
# Amazon Data Firehose endpoint.
|
2579
2668
|
#
|
2580
2669
|
# * `FirehoseSuccessFeedbackSampleRate` – Indicates percentage of
|
2581
2670
|
# successful messages to sample for an Amazon SNS topic that is
|
2582
|
-
# subscribed to an Amazon
|
2671
|
+
# subscribed to an Amazon Data Firehose endpoint.
|
2583
2672
|
#
|
2584
2673
|
# * `FirehoseFailureFeedbackRoleArn` – Indicates failed message
|
2585
2674
|
# delivery status for an Amazon SNS topic that is subscribed to an
|
2586
|
-
# Amazon
|
2675
|
+
# Amazon Data Firehose endpoint.
|
2587
2676
|
# * Lambda
|
2588
2677
|
#
|
2589
2678
|
# * `LambdaSuccessFeedbackRoleArn` – Indicates successful message
|
@@ -2601,15 +2690,15 @@ module Aws::SNS
|
|
2601
2690
|
#
|
2602
2691
|
# * `ApplicationSuccessFeedbackRoleArn` – Indicates successful
|
2603
2692
|
# message delivery status for an Amazon SNS topic that is
|
2604
|
-
# subscribed to an
|
2693
|
+
# subscribed to an platform application endpoint.
|
2605
2694
|
#
|
2606
2695
|
# * `ApplicationSuccessFeedbackSampleRate` – Indicates percentage of
|
2607
2696
|
# successful messages to sample for an Amazon SNS topic that is
|
2608
|
-
# subscribed to an
|
2697
|
+
# subscribed to an platform application endpoint.
|
2609
2698
|
#
|
2610
2699
|
# * `ApplicationFailureFeedbackRoleArn` – Indicates failed message
|
2611
2700
|
# delivery status for an Amazon SNS topic that is subscribed to an
|
2612
|
-
#
|
2701
|
+
# platform application endpoint.
|
2613
2702
|
# <note markdown="1"> In addition to being able to configure topic attributes for
|
2614
2703
|
# message delivery status of notification messages sent to Amazon
|
2615
2704
|
# SNS application endpoints, you can also configure application
|
@@ -2763,8 +2852,8 @@ module Aws::SNS
|
|
2763
2852
|
#
|
2764
2853
|
# * `lambda` – delivery of JSON-encoded message to an Lambda function
|
2765
2854
|
#
|
2766
|
-
# * `firehose` – delivery of JSON-encoded message to an Amazon
|
2767
|
-
#
|
2855
|
+
# * `firehose` – delivery of JSON-encoded message to an Amazon Data
|
2856
|
+
# Firehose delivery stream.
|
2768
2857
|
# @return [String]
|
2769
2858
|
#
|
2770
2859
|
# @!attribute [rw] endpoint
|
@@ -2794,7 +2883,7 @@ module Aws::SNS
|
|
2794
2883
|
# function.
|
2795
2884
|
#
|
2796
2885
|
# * For the `firehose` protocol, the endpoint is the ARN of an Amazon
|
2797
|
-
#
|
2886
|
+
# Data Firehose delivery stream.
|
2798
2887
|
# @return [String]
|
2799
2888
|
#
|
2800
2889
|
# @!attribute [rw] attributes
|
@@ -3049,7 +3138,8 @@ module Aws::SNS
|
|
3049
3138
|
include Aws::Structure
|
3050
3139
|
end
|
3051
3140
|
|
3052
|
-
# The batch request contains more entries than permissible
|
3141
|
+
# The batch request contains more entries than permissible (more than
|
3142
|
+
# 10).
|
3053
3143
|
#
|
3054
3144
|
# @!attribute [rw] message
|
3055
3145
|
# @return [String]
|
data/lib/aws-sdk-sns.rb
CHANGED