Verifies an endpoint owner's intent to receive messages by validating
the token sent to the endpoint by an earlier Subscribe action. If
the token is valid, the action creates a new subscription and returns
its Amazon Resource Name (ARN). This call requires an AWS signature
only when the AuthenticateOnUnsubscribe flag is set to "true".

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.

Creates a platform application object for one of the supported push
notification services, such as APNS and GCM, to which devices and
mobile apps may register. You must specify PlatformPrincipal and
PlatformCredential attributes when using the
CreatePlatformApplication action. The PlatformPrincipal is received
from the notification service. For APNS/APNS_SANDBOX,
PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal
is not applicable. For ADM, PlatformPrincipal is "client id". The
PlatformCredential is also received from the notification service. For
WNS, PlatformPrincipal is "Package Security Identifier". For MPNS,
PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal
is "API key".

Creates an endpoint for a device and mobile app on one of the
supported push notification services, such as GCM and APNS.
CreatePlatformEndpoint requires the PlatformApplicationArn that is
returned from CreatePlatformApplication. The EndpointArn that is
returned when using CreatePlatformEndpoint can then be used by the
Publish action to send a message to a mobile app or by the
Subscribe action for subscription to a topic. The
CreatePlatformEndpoint action is idempotent, so if the requester
already owns an endpoint with the same device token and attributes,
that endpoint's ARN is returned without creating a new endpoint. For
more information, see Using Amazon SNS Mobile Push Notifications.

When using CreatePlatformEndpoint with Baidu, two attributes must be
provided: ChannelId and UserId. The token field must also contain the
ChannelId. For more information, see Creating an Amazon SNS Endpoint
for Baidu.

PlatformApplicationArn returned from CreatePlatformApplication is used
to create a an endpoint.

:token(required, String)
—

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 or ADM, the device token equivalent is called the
registration ID.

:custom_user_data(String)
—

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.

Creates a topic to which notifications can be published. Users can
create at most 100,000 topics. For more information, see
http://aws.amazon.com/sns. This action is idempotent, so if the
requester already owns a topic with the specified name, that topic's
ARN is returned without creating a new topic.

Examples:

Request syntax with placeholder values

resp=client.create_topic({name:"topicName",# required
})

Response structure

resp.topic_arn#=> String

Parameters:

params(Hash)(defaults to: {})
—

({})

Options Hash (params):

:name(required, String)
—

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.

#delete_topic(params = {}) ⇒ Struct

Deletes a topic and all its subscriptions. Deleting a topic might
prevent some messages previously sent to the topic from being
delivered to subscribers. This action is idempotent, so deleting a
topic that does not exist does not result in an error.

Lists the endpoints and endpoint attributes for devices in a supported
push notification service, such as GCM and APNS. The results for
ListEndpointsByPlatformApplication are paginated and return a
limited list of endpoints, up to 100. If additional records are
available after the first page results, then a NextToken string will
be returned. To receive the next page, you call
ListEndpointsByPlatformApplication again using the NextToken string
received from the previous call. When there are no more records to
return, NextToken will be null. For more information, see Using
Amazon SNS Mobile Push Notifications.

Returns a list of phone numbers that are opted out, meaning you cannot
send SMS messages to them.

The results for ListPhoneNumbersOptedOut are paginated, and each
page returns up to 100 phone numbers. If additional phone numbers are
available after the first page of results, then a NextToken string
will be returned. To receive the next page, you call
ListPhoneNumbersOptedOut again using the NextToken string received
from the previous call. When there are no more records to return,
NextToken will be null.

Lists the platform application objects for the supported push
notification services, such as APNS and GCM. The results for
ListPlatformApplications are paginated and return a limited list of
applications, up to 100. If additional records are available after the
first page results, then a NextToken string will be returned. To
receive the next page, you call ListPlatformApplications using the
NextToken string received from the previous call. When there are no
more records to return, NextToken will be null. For more information,
see Using Amazon SNS Mobile Push Notifications.

Returns a list of the requester's subscriptions. Each call returns a
limited list of subscriptions, up to 100. If there are more
subscriptions, a NextToken is also returned. Use the NextToken
parameter in a new ListSubscriptions call to get further results.

Returns a list of the subscriptions to a specific topic. Each call
returns a limited list of subscriptions, up to 100. If there are more
subscriptions, a NextToken is also returned. Use the NextToken
parameter in a new ListSubscriptionsByTopic call to get further
results.

Returns a list of the requester's topics. Each call returns a limited
list of topics, up to 100. If there are more topics, a NextToken is
also returned. Use the NextToken parameter in a new ListTopics
call to get further results.

Sends a message to all of a topic's subscribed endpoints. When a
messageId is returned, the message has been saved and Amazon SNS
will attempt to deliver it to the topic's subscribers shortly. The
format of the outgoing message to each subscribed endpoint depends on
the notification protocol.

To use the Publish action for sending a message to a mobile
endpoint, such as an app on a Kindle device or mobile phone, you must
specify the EndpointArn for the TargetArn parameter. The EndpointArn
is returned when making a call with the CreatePlatformEndpoint
action.

If you don't specify a value for the TopicArn parameter, you must
specify a value for the PhoneNumber or TargetArn parameters.

:target_arn(String)
—

Either TopicArn or EndpointArn, but not both.

If you don't specify a value for the TargetArn parameter, you must
specify a value for the PhoneNumber or TopicArn parameters.

:phone_number(String)
—

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.

:message(required, String)
—

The message you want to send to the topic.

If 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: Messages must be UTF-8 encoded strings at most 256 KB in
size (262144 bytes, not 262144 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).

:subject(String)
—

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.

:message_structure(String)
—

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").

For information about sending different messages for each protocol
using the AWS Management Console, go to Create Different Messages for
Each Protocol in the Amazon Simple Notification Service Getting
Started Guide.

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.

A map of the platform application attributes. Attributes in this map
include the following:

PlatformCredential -- The credential received from the
notification service. For APNS/APNS_SANDBOX, PlatformCredential is
private key. For GCM, PlatformCredential is "API key". For ADM,
PlatformCredential is "client secret".

PlatformPrincipal -- The principal received from the notification
service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL
certificate. For GCM, PlatformPrincipal is not applicable. For ADM,
PlatformPrincipal is "client id".

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.

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.

#set_sms_attributes(params = {}) ⇒ Struct

Use this request to set the default settings for sending SMS messages
and receiving daily SMS usage reports.

You can override some of these settings for a single message when you
use the Publish action with the MessageAttributes.entry.N
parameter. For more information, see Sending an SMS Message in
the Amazon SNS Developer Guide.

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 exceed the maximum, contact AWS Support or
your AWS sales representative for a service 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:

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.

Prepares to subscribe an endpoint by sending the endpoint a
confirmation message. To actually create a subscription, the endpoint
owner must call the ConfirmSubscription action with the token from
the confirmation message. Confirmation tokens are valid for three
days.

#unsubscribe(params = {}) ⇒ Struct

Deletes a subscription. If the subscription requires authentication
for deletion, only the owner of the subscription or the topic's owner
can unsubscribe, and an AWS signature is required. If the
Unsubscribe call does not require authentication and the requester
is not the subscription owner, a final cancellation message is
delivered to the endpoint, so that the endpoint owner can easily
resubscribe to the topic if the Unsubscribe request was unintended.