NAME

Paws::SNS - Perl Interface to AWS Amazon Simple Notification Service

SYNOPSIS

use Paws;

my $obj = Paws->service('SNS');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

Amazon Simple Notification Service

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see the Amazon SNS product page (http://aws.amazon.com/sns/). For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/).

For information on the permissions you need to use this API, see Identity and access management in Amazon SNS (https://docs.aws.amazon.com/sns/latest/dg/sns-authentication-and-access-control.html) in the Amazon SNS Developer Guide.

We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services (http://aws.amazon.com/tools/).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31

METHODS

AddPermission

ActionName => ArrayRef[Str|Undef]
AWSAccountId => ArrayRef[Str|Undef]
Label => Str
TopicArn => Str

Each argument is described in detail in: Paws::SNS::AddPermission

Returns: nothing

Adds a statement to a topic's access control policy, granting access for the specified accounts to the specified actions.

CheckIfPhoneNumberIsOptedOut

PhoneNumber => Str

Each argument is described in detail in: Paws::SNS::CheckIfPhoneNumberIsOptedOut

Returns: a Paws::SNS::CheckIfPhoneNumberIsOptedOutResponse instance

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.

To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.

ConfirmSubscription

Token => Str
TopicArn => Str
[AuthenticateOnUnsubscribe => Str]

Each argument is described in detail in: Paws::SNS::ConfirmSubscription

Returns: a Paws::SNS::ConfirmSubscriptionResponse instance

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

CreatePlatformApplication

Attributes => Paws::SNS::MapStringToString
Name => Str
Platform => Str

Each argument is described in detail in: Paws::SNS::CreatePlatformApplication

Returns: a Paws::SNS::CreatePlatformApplicationResponse instance

Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.

PlatformPrincipal and PlatformCredential are received from the notification service.

For ADM, PlatformPrincipal is client id and PlatformCredential is client secret.
For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.
For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate and PlatformCredential is private key.
For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal and the PlatformCredential is API key.
For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.
For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.

You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.

CreatePlatformEndpoint

PlatformApplicationArn => Str
Token => Str
[Attributes => Paws::SNS::MapStringToString]
[CustomUserData => Str]

Each argument is described in detail in: Paws::SNS::CreatePlatformEndpoint

Returns: a Paws::SNS::CreateEndpointResponse instance

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. You can use the returned EndpointArn 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 (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).

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 (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html).

CreateSMSSandboxPhoneNumber

PhoneNumber => Str
[LanguageCode => Str]

Each argument is described in detail in: Paws::SNS::CreateSMSSandboxPhoneNumber

Returns: a Paws::SNS::CreateSMSSandboxPhoneNumberResult instance

Adds a destination phone number to an account in the SMS sandbox and sends a one-time password (OTP) to that phone number.

When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the Amazon SNS Developer Guide.

CreateTopic

Name => Str
[Attributes => Paws::SNS::TopicAttributesMap]
[Tags => ArrayRef[Paws::SNS::Tag]]

Each argument is described in detail in: Paws::SNS::CreateTopic

Returns: a Paws::SNS::CreateTopicResponse instance

Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS topic (https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html) in the Amazon SNS Developer Guide. 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.

DeleteEndpoint

EndpointArn => Str

Each argument is described in detail in: Paws::SNS::DeleteEndpoint

Returns: nothing

Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).

When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.

DeletePlatformApplication

PlatformApplicationArn => Str

Each argument is described in detail in: Paws::SNS::DeletePlatformApplication

Returns: nothing

Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).

DeleteSMSSandboxPhoneNumber

PhoneNumber => Str

Each argument is described in detail in: Paws::SNS::DeleteSMSSandboxPhoneNumber

Returns: a Paws::SNS::DeleteSMSSandboxPhoneNumberResult instance

Deletes an account's verified or pending phone number from the SMS sandbox.

DeleteTopic

TopicArn => Str

Each argument is described in detail in: Paws::SNS::DeleteTopic

Returns: nothing

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.

GetEndpointAttributes

EndpointArn => Str

Each argument is described in detail in: Paws::SNS::GetEndpointAttributes

Returns: a Paws::SNS::GetEndpointAttributesResponse instance

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).

GetPlatformApplicationAttributes

PlatformApplicationArn => Str

Each argument is described in detail in: Paws::SNS::GetPlatformApplicationAttributes

Returns: a Paws::SNS::GetPlatformApplicationAttributesResponse instance

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).

GetSMSAttributes

[Attributes => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::SNS::GetSMSAttributes

Returns: a Paws::SNS::GetSMSAttributesResponse instance

Returns the settings for sending SMS messages from your account.

These settings are set with the SetSMSAttributes action.

GetSMSSandboxAccountStatus

Each argument is described in detail in: Paws::SNS::GetSMSSandboxAccountStatus

Returns: a Paws::SNS::GetSMSSandboxAccountStatusResult instance

Retrieves the SMS sandbox status for the calling account in the target Region.

GetSubscriptionAttributes

SubscriptionArn => Str

Each argument is described in detail in: Paws::SNS::GetSubscriptionAttributes

Returns: a Paws::SNS::GetSubscriptionAttributesResponse instance

Returns all of the properties of a subscription.

GetTopicAttributes

TopicArn => Str

Each argument is described in detail in: Paws::SNS::GetTopicAttributes

Returns: a Paws::SNS::GetTopicAttributesResponse instance

Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

ListEndpointsByPlatformApplication

PlatformApplicationArn => Str
[NextToken => Str]

Each argument is described in detail in: Paws::SNS::ListEndpointsByPlatformApplication

Returns: a Paws::SNS::ListEndpointsByPlatformApplicationResponse instance

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) 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 (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).

This action is throttled at 30 transactions per second (TPS).

ListOriginationNumbers

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SNS::ListOriginationNumbers

Returns: a Paws::SNS::ListOriginationNumbersResult instance

Lists the calling account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers (https://docs.aws.amazon.com/sns/latest/dg/channels-sms-originating-identities-origination-numbers.html) in the Amazon SNS Developer Guide.

ListPhoneNumbersOptedOut

[NextToken => Str]

Each argument is described in detail in: Paws::SNS::ListPhoneNumbersOptedOut

Returns: a Paws::SNS::ListPhoneNumbersOptedOutResponse instance

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.

ListPlatformApplications

[NextToken => Str]

Each argument is described in detail in: Paws::SNS::ListPlatformApplications

Returns: a Paws::SNS::ListPlatformApplicationsResponse instance

Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). 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 (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).

This action is throttled at 15 transactions per second (TPS).

ListSMSSandboxPhoneNumbers

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SNS::ListSMSSandboxPhoneNumbers

Returns: a Paws::SNS::ListSMSSandboxPhoneNumbersResult instance

Lists the calling account's current verified and pending destination phone numbers in the SMS sandbox.

ListSubscriptions

[NextToken => Str]

Each argument is described in detail in: Paws::SNS::ListSubscriptions

Returns: a Paws::SNS::ListSubscriptionsResponse instance

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.

This action is throttled at 30 transactions per second (TPS).

ListSubscriptionsByTopic

TopicArn => Str
[NextToken => Str]

Each argument is described in detail in: Paws::SNS::ListSubscriptionsByTopic

Returns: a Paws::SNS::ListSubscriptionsByTopicResponse instance

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.

This action is throttled at 30 transactions per second (TPS).

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::SNS::ListTagsForResource

Returns: a Paws::SNS::ListTagsForResourceResponse instance

List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags (https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html) in the Amazon Simple Notification Service Developer Guide.

ListTopics

[NextToken => Str]

Each argument is described in detail in: Paws::SNS::ListTopics

Returns: a Paws::SNS::ListTopicsResponse instance

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.

This action is throttled at 30 transactions per second (TPS).

OptInPhoneNumber

PhoneNumber => Str

Each argument is described in detail in: Paws::SNS::OptInPhoneNumber

Returns: a Paws::SNS::OptInPhoneNumberResponse instance

Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.

You can opt in a phone number only once every 30 days.

Publish

Message => Str
[MessageAttributes => Paws::SNS::MessageAttributeMap]
[MessageDeduplicationId => Str]
[MessageGroupId => Str]
[MessageStructure => Str]
[PhoneNumber => Str]
[Subject => Str]
[TargetArn => Str]
[TopicArn => Str]

Each argument is described in detail in: Paws::SNS::Publish

Returns: a Paws::SNS::PublishResponse instance

Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).

If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.

When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.

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.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices (https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html).

You can publish messages only to topics and endpoints in the same Region.

RemovePermission

Label => Str
TopicArn => Str

Each argument is described in detail in: Paws::SNS::RemovePermission

Returns: nothing

Removes a statement from a topic's access control policy.

SetEndpointAttributes

Attributes => Paws::SNS::MapStringToString
EndpointArn => Str

Each argument is described in detail in: Paws::SNS::SetEndpointAttributes

Returns: nothing

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).

SetPlatformApplicationAttributes

Attributes => Paws::SNS::MapStringToString
PlatformApplicationArn => Str

Each argument is described in detail in: Paws::SNS::SetPlatformApplicationAttributes

Returns: nothing

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html). For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status (https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html).

SetSMSAttributes

Attributes => Paws::SNS::MapStringToString

Each argument is described in detail in: Paws::SNS::SetSMSAttributes

Returns: a Paws::SNS::SetSMSAttributesResponse instance

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 Publishing to a mobile phone (https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html) in the Amazon SNS Developer Guide.

To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action.

SetSubscriptionAttributes

AttributeName => Str
SubscriptionArn => Str
[AttributeValue => Str]

Each argument is described in detail in: Paws::SNS::SetSubscriptionAttributes

Returns: nothing

Allows a subscription owner to set an attribute of the subscription to a new value.

SetTopicAttributes

AttributeName => Str
TopicArn => Str
[AttributeValue => Str]

Each argument is described in detail in: Paws::SNS::SetTopicAttributes

Returns: nothing

Allows a topic owner to set an attribute of the topic to a new value.

Protocol => Str
TopicArn => Str
[Attributes => Paws::SNS::SubscriptionAttributesMap]
[Endpoint => Str]
[ReturnSubscriptionArn => Bool]

Each argument is described in detail in: Paws::SNS::Subscribe

Returns: a Paws::SNS::SubscribeResponse instance

Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same account, the endpoint owner must run the ConfirmSubscription action to confirm the subscription.

You call the ConfirmSubscription action with the token from the subscription response. Confirmation tokens are valid for three days.

This action is throttled at 100 transactions per second (TPS).

TagResource

ResourceArn => Str
Tags => ArrayRef[Paws::SNS::Tag]

Each argument is described in detail in: Paws::SNS::TagResource

Returns: a Paws::SNS::TagResourceResponse instance

Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags (https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html) in the Amazon SNS Developer Guide.

When you use topic tags, keep the following guidelines in mind:

Adding more than 50 tags to a topic isn't recommended.
Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging actions are limited to 10 TPS per account, per Region. If your application requires a higher throughput, file a technical support request (https://console.aws.amazon.com/support/home#/case/create?issueType=technical).

Unsubscribe

SubscriptionArn => Str

Each argument is described in detail in: Paws::SNS::Unsubscribe

Returns: nothing

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 Amazon Web Services 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.

This action is throttled at 100 transactions per second (TPS).

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::SNS::UntagResource

Returns: a Paws::SNS::UntagResourceResponse instance

Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags (https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html) in the Amazon SNS Developer Guide.

VerifySMSSandboxPhoneNumber

OneTimePassword => Str
PhoneNumber => Str

Each argument is described in detail in: Paws::SNS::VerifySMSSandboxPhoneNumber

Returns: a Paws::SNS::VerifySMSSandboxPhoneNumberResult instance

Verifies a destination phone number with a one-time password (OTP) for the calling account.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results