int statusCode
String topicArn
The ARN of the topic whose access control policy you wish to modify.
String label
A unique identifier for the new policy statement.
SdkInternalList<T> aWSAccountIds
The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.
SdkInternalList<T> actionNames
The action you want to allow for the specified principal(s).
Valid values: Any Amazon SNS action name, for example Publish
.
String phoneNumber
The phone number for which you want to check the opt out status.
Boolean isOptedOut
Indicates whether the phone number is opted out:
true
– The phone number is opted out, meaning you cannot publish SMS messages to it.
false
– The phone number is opted in, meaning you can publish SMS messages to it.
String topicArn
The ARN of the topic for which you wish to confirm a subscription.
String token
Short-lived token sent to an endpoint during the Subscribe
action.
String authenticateOnUnsubscribe
Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true
and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the
endpoint. The unsubscribe action requires AWS authentication.
String subscriptionArn
The ARN of the created subscription.
String name
Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.
String platform
The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).
SdkInternalMap<K,V> attributes
For a list of attributes, see SetPlatformApplicationAttributes
String platformApplicationArn
PlatformApplicationArn is returned.
String platformApplicationArn
PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
String token
Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.
String customUserData
Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
SdkInternalMap<K,V> attributes
For a list of attributes, see SetEndpointAttributes.
String endpointArn
EndpointArn returned from CreateEndpoint action.
String name
The name of the topic you want to create.
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
For a FIFO (first-in-first-out) topic, the name must end with the .fifo
suffix.
SdkInternalMap<K,V> attributes
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the
CreateTopic
action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S
endpoints.
DisplayName
– The display name to use for a topic with SMS subscriptions.
FifoTopic
– Set to true to create a FIFO topic.
Policy
– The policy that defines who can access your topic. By default, only the topic owner can
publish or subscribe to the topic.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId
– The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK.
For more information, see Key Terms. For
more examples, see KeyId in the AWS Key Management Service API Reference.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication
– Enables content-based deduplication. Amazon SNS uses a SHA-256 hash to
generate the MessageDeduplicationId
using the body of the message (but not the attributes of the
message).
When ContentBasedDeduplication
is in effect, messages with identical content sent within the
deduplication interval are treated as duplicates and only one copy of the message is delivered.
If the queue has ContentBasedDeduplication
set, your MessageDeduplicationId
overrides
the generated one.
SdkInternalList<T> tags
The list of tags to add to a new topic.
To be able to tag a topic on creation, you must have the sns:CreateTopic
and
sns:TagResource
permissions.
String topicArn
The Amazon Resource Name (ARN) assigned to the created topic.
String endpointArn
EndpointArn of endpoint to delete.
String platformApplicationArn
PlatformApplicationArn of platform application object to delete.
String topicArn
The ARN of the topic you want to delete.
String endpointArn
EndpointArn for mobile app and device.
SdkInternalMap<K,V> attributes
Attributes for endpoint.
String endpointArn
EndpointArn for GetEndpointAttributes input.
SdkInternalMap<K,V> attributes
Attributes include the following:
CustomUserData
– arbitrary user data to associate with the endpoint. Amazon SNS does not use this
data. The data must be in UTF-8 format and less than 2KB.
Enabled
– flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false
when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true,
typically after updating Token.
Token
– device token, also referred to as a registration id, for an app and mobile device. This is
returned from the notification service when an app and mobile device are registered with the notification
service.
The device token for the iOS platform is returned in lowercase.
String platformApplicationArn
PlatformApplicationArn for GetPlatformApplicationAttributesInput.
SdkInternalMap<K,V> attributes
Attributes include the following:
EventEndpointCreated
– Topic ARN to which EndpointCreated event notifications should be sent.
EventEndpointDeleted
– Topic ARN to which EndpointDeleted event notifications should be sent.
EventEndpointUpdated
– Topic ARN to which EndpointUpdate event notifications should be sent.
EventDeliveryFailure
– Topic ARN to which DeliveryFailure event notifications should be sent upon
Direct Publish delivery failure (permanent) to one of the application's endpoints.
SdkInternalList<T> attributes
A list of the individual attribute names, such as MonthlySpendLimit
, for which you want values.
For all attribute names, see SetSMSAttributes.
If you don't use this parameter, Amazon SNS returns all SMS attributes.
SdkInternalMap<K,V> attributes
The SMS attribute names and their values.
String subscriptionArn
The ARN of the subscription whose properties you want to get.
SdkInternalMap<K,V> attributes
A map of the subscription's attributes. Attributes in this map include the following:
ConfirmationWasAuthenticated
– true
if the subscription confirmation request was
authenticated.
DeliveryPolicy
– The JSON serialization of the subscription's delivery policy.
EffectiveDeliveryPolicy
– The JSON serialization of the effective delivery policy that takes into
account the topic delivery policy and account system defaults.
FilterPolicy
– The filter policy JSON that is assigned to the subscription. For more information,
see Amazon SNS Message
Filtering in the Amazon SNS Developer Guide.
Owner
– The AWS account ID of the subscription's owner.
PendingConfirmation
– true
if the subscription hasn't been confirmed. To confirm a
pending subscription, call the ConfirmSubscription
action with a confirmation token.
RawMessageDelivery
– true
if raw message delivery is enabled for the subscription. Raw
messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.
RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter
queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is
unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes
unavailable) are held in the dead-letter queue for further analysis or reprocessing.
SubscriptionArn
– The subscription's ARN.
TopicArn
– The topic ARN that the subscription is associated with.
String topicArn
The ARN of the topic whose properties you want to get.
SdkInternalMap<K,V> attributes
A map of the topic's attributes. Attributes in this map include the following:
DeliveryPolicy
– The JSON serialization of the topic's delivery policy.
DisplayName
– The human-readable name used in the From
field for notifications to
email
and email-json
endpoints.
Owner
– The AWS account ID of the topic's owner.
Policy
– The JSON serialization of the topic's access control policy.
SubscriptionsConfirmed
– The number of confirmed subscriptions for the topic.
SubscriptionsDeleted
– The number of deleted subscriptions for the topic.
SubscriptionsPending
– The number of subscriptions pending confirmation for the topic.
TopicArn
– The topic's ARN.
EffectiveDeliveryPolicy
– The JSON serialization of the effective delivery policy, taking system
defaults into account.
The following attribute applies only to server-side-encryption:
String platformApplicationArn
PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
String nextToken
NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.
SdkInternalList<T> endpoints
Endpoints returned for ListEndpointsByPlatformApplication action.
String nextToken
NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.
String nextToken
A NextToken
string is used when you call the ListPhoneNumbersOptedOut
action to
retrieve additional records that are available after the first page of results.
SdkInternalList<T> phoneNumbers
A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.
String nextToken
A NextToken
string is returned when you call the ListPhoneNumbersOptedOut
action if
additional records are available after the first page of results.
String nextToken
NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.
SdkInternalList<T> platformApplications
Platform applications returned when calling ListPlatformApplications action.
String nextToken
NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.
SdkInternalList<T> subscriptions
A list of subscriptions.
String nextToken
Token to pass along to the next ListSubscriptionsByTopic
request. This element is returned if there
are more subscriptions to retrieve.
String nextToken
Token returned by the previous ListSubscriptions
request.
SdkInternalList<T> subscriptions
A list of subscriptions.
String nextToken
Token to pass along to the next ListSubscriptions
request. This element is returned if there are
more subscriptions to retrieve.
String resourceArn
The ARN of the topic for which to list tags.
SdkInternalList<T> tags
The tags associated with the specified topic.
String nextToken
Token returned by the previous ListTopics
request.
SdkInternalList<T> topics
A list of topic ARNs.
String nextToken
Token to pass along to the next ListTopics
request. This element is returned if there are additional
topics to retrieve.
String dataType
Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types.
String stringValue
Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.
ByteBuffer binaryValue
Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
String phoneNumber
The phone number to opt in.
String platformApplicationArn
PlatformApplicationArn for platform application object.
SdkInternalMap<K,V> attributes
Attributes for platform application object.
String topicArn
The topic you want to publish to.
If you don't specify a value for the TopicArn
parameter, you must specify a value for the
PhoneNumber
or TargetArn
parameters.
String targetArn
If you don't specify a value for the TargetArn
parameter, you must specify a value for the
PhoneNumber
or TopicArn
parameters.
String phoneNumber
The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber
parameter, you must specify a value for the
TargetArn
or TopicArn
parameters.
String message
The message you want to send.
If you are publishing to a topic and you want to send the same message to all transport protocols, include the
text of the message as a String value. If you want to send different messages for each transport protocol, set
the value of the MessageStructure
parameter to json
and use a JSON object for the
Message
parameter.
Constraints:
With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
The total size limit for a single SMS Publish
action is 1,600 characters.
JSON-specific constraints:
Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
Values have a minimum length of 0 (the empty string, "", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored.
Duplicate keys are not allowed.
Failure to parse or validate any key or value in the message will cause the Publish
call to return
an error (no partial delivery).
String subject
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
String messageStructure
Set MessageStructure
to json
if you want to send a different message for each protocol.
For example, using one publish action, you can send a short message to your SMS subscribers and a longer message
to your email subscribers. If you set MessageStructure
to json
, the value of the
Message
parameter must:
be a syntactically valid JSON object; and
contain at least a top-level JSON key of "default" with a value that is a string.
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
Valid value: json
SdkInternalMap<K,V> messageAttributes
Message attributes for Publish action.
String messageId
Unique identifier assigned to the published message.
Length Constraint: Maximum 100 characters
String endpointArn
EndpointArn used for SetEndpointAttributes action.
SdkInternalMap<K,V> attributes
A map of the endpoint attributes. Attributes in this map include the following:
CustomUserData
– arbitrary user data to associate with the endpoint. Amazon SNS does not use this
data. The data must be in UTF-8 format and less than 2KB.
Enabled
– flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false
when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true,
typically after updating Token.
Token
– device token, also referred to as a registration id, for an app and mobile device. This is
returned from the notification service when an app and mobile device are registered with the notification
service.
String platformApplicationArn
PlatformApplicationArn for SetPlatformApplicationAttributes action.
SdkInternalMap<K,V> attributes
A map of the platform application attributes. Attributes in this map include the following:
PlatformCredential
– The credential received from the notification service. For APNS
and APNS_SANDBOX
, PlatformCredential
is private key
. For GCM
(Firebase Cloud Messaging), PlatformCredential
is API key
. For ADM
,
PlatformCredential
is client secret
.
PlatformPrincipal
– The principal received from the notification service. For APNS
and
APNS_SANDBOX
, PlatformPrincipal
is SSL certificate
. For GCM
(Firebase Cloud Messaging), there is no PlatformPrincipal
. For ADM
,
PlatformPrincipal
is client id
.
EventEndpointCreated
– Topic ARN to which EndpointCreated
event notifications are sent.
EventEndpointDeleted
– Topic ARN to which EndpointDeleted
event notifications are sent.
EventEndpointUpdated
– Topic ARN to which EndpointUpdate
event notifications are sent.
EventDeliveryFailure
– Topic ARN to which DeliveryFailure
event notifications are sent
upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
SuccessFeedbackRoleArn
– IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on
your behalf.
FailureFeedbackRoleArn
– IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on
your behalf.
SuccessFeedbackSampleRate
– Sample rate percentage (0-100) of successfully delivered messages.
SdkInternalMap<K,V> attributes
The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit
– The maximum amount in USD that you are willing to spend each month to send SMS
messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it
stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.
DeliveryStatusIAMRole
– The ARN of the IAM role that allows Amazon SNS to write logs about SMS
deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the
message price, the success or failure status, the reason for failure (if the message failed), the message dwell
time, and other information.
DeliveryStatusSuccessSamplingRate
– The percentage of successful SMS deliveries for which Amazon SNS
will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for
failed deliveries, set this value to 0
. To write logs for 10% of your successful deliveries, set it
to 10
.
DefaultSenderID
– A string, such as your business brand, that is displayed as the sender on the
receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters,
and it must contain at least one letter.
DefaultSMSType
– The type of SMS message that you will send by default. You can assign the following
values:
Promotional
– (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the
message delivery to incur the lowest cost.
Transactional
– Critical messages that support customer transactions, such as one-time passcodes for
multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket
– The name of the Amazon S3 bucket to receive daily SMS usage reports from
Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the
following information for each SMS message that was successfully delivered by your account:
Time that the message was published (in UTC)
Message ID
Destination phone number
Message type
Delivery status
Message price (in USD)
Part number (a message is split into multiple parts if it is too long for a single message)
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the
s3:PutObject
and s3:GetBucketLocation
actions.
For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.
String subscriptionArn
The ARN of the subscription to modify.
String attributeName
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the
SetTopicAttributes
action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S
endpoints.
FilterPolicy
– The simple JSON object that lets your subscriber receive only a subset of messages,
rather than receiving every message published to the topic.
RawMessageDelivery
– When set to true
, enables raw message delivery to Amazon SQS or
HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise
created for Amazon SNS metadata.
RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter
queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is
unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes
unavailable) are held in the dead-letter queue for further analysis or reprocessing.
String attributeValue
The new value for the attribute in JSON format.
String topicArn
The ARN of the topic to modify.
String attributeName
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the
SetTopicAttributes
action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S
endpoints.
DisplayName
– The display name to use for a topic with SMS subscriptions.
Policy
– The policy that defines who can access your topic. By default, only the topic owner can
publish or subscribe to the topic.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId
– The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK.
For more information, see Key Terms. For
more examples, see KeyId in the AWS Key Management Service API Reference.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication
– Enables content-based deduplication. Amazon SNS uses a SHA-256 hash to
generate the MessageDeduplicationId
using the body of the message (but not the attributes of the
message).
When ContentBasedDeduplication
is in effect, messages with identical content sent within the
deduplication interval are treated as duplicates and only one copy of the message is delivered.
If the queue has ContentBasedDeduplication
set, your MessageDeduplicationId
overrides
the generated one.
String attributeValue
The new value for the attribute.
String topicArn
The ARN of the topic you want to subscribe to.
String protocol
The protocol you want to use. Supported protocols include:
http
– delivery of JSON-encoded message via HTTP POST
https
– delivery of JSON-encoded message via HTTPS POST
email
– delivery of message via SMTP
email-json
– delivery of JSON-encoded message via SMTP
sms
– delivery of message via SMS
sqs
– delivery of JSON-encoded message to an Amazon SQS queue
application
– delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
lambda
– delivery of JSON-encoded message to an Amazon Lambda function.
String endpoint
The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the http
protocol, the (public) endpoint is a URL beginning with http://
For the https
protocol, the (public) endpoint is a URL beginning with https://
For the email
protocol, the endpoint is an email address
For the email-json
protocol, the endpoint is an email address
For the sms
protocol, the endpoint is a phone number of an SMS-enabled device
For the sqs
protocol, the endpoint is the ARN of an Amazon SQS queue
For the application
protocol, the endpoint is the EndpointArn of a mobile app and device.
For the lambda
protocol, the endpoint is the ARN of an Amazon Lambda function.
SdkInternalMap<K,V> attributes
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the
SetTopicAttributes
action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S
endpoints.
FilterPolicy
– The simple JSON object that lets your subscriber receive only a subset of messages,
rather than receiving every message published to the topic.
RawMessageDelivery
– When set to true
, enables raw message delivery to Amazon SQS or
HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise
created for Amazon SNS metadata.
RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter
queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is
unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes
unavailable) are held in the dead-letter queue for further analysis or reprocessing.
Boolean returnSubscriptionArn
Sets whether the response from the Subscribe
request includes the subscription ARN, even if the
subscription is not yet confirmed.
If you set this parameter to true
, the response includes the ARN in all cases, even if the
subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes
the pending subscription
ARN value for subscriptions that aren't yet confirmed. A subscription
becomes confirmed when the subscriber calls the ConfirmSubscription
action with a confirmation
token.
The default value is false
.
String subscriptionArn
The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires
confirmation. However, if the API request parameter ReturnSubscriptionArn
is true, then the value is
always the subscription ARN, even if the subscription requires confirmation.
String subscriptionArn
The subscription's ARN.
String owner
The subscription's owner.
String protocol
The subscription's protocol.
String endpoint
The subscription's endpoint (format depends on the protocol).
String topicArn
The ARN of the subscription's topic.
String resourceArn
The ARN of the topic to which to add tags.
SdkInternalList<T> tags
The tags to be added to the specified topic. A tag consists of a required key and an optional value.
String topicArn
The topic's ARN.
String subscriptionArn
The ARN of the subscription to be deleted.
String resourceArn
The ARN of the topic from which to remove tags.
SdkInternalList<T> tagKeys
The list of tag keys to remove from the specified topic.
Copyright © 2020. All rights reserved.