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 http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see 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.
METHODS
AddPermission(ActionName => ArrayRef[Str], AWSAccountId => ArrayRef[Str], 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 AWS 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 C<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 C<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, to which devices and
mobile apps may register. You must specify PlatformPrincipal and
PlatformCredential attributes when using the
C<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".For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS.
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 and APNS.
C<CreatePlatformEndpoint> requires the PlatformApplicationArn that is
returned from C<CreatePlatformApplication>. The EndpointArn that is
returned when using C<CreatePlatformEndpoint> can then be used by the
C<Publish> action to send a message to a mobile app or by the
C<Subscribe> action for subscription to a topic. The
C<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.
CreateTopic(Name => Str)
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 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.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.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. For more information, see
Using Amazon SNS Mobile Push Notifications.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 and APNS. For more information,
see Using Amazon SNS Mobile Push Notifications.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. For more
information, see Using Amazon SNS Mobile Push Notifications.GetSMSAttributes([Attributes => ArrayRef[Str]])
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.
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 and APNS. The results for
C<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
C<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.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. The results for
C<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 C<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.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 C<NextToken> is also returned. Use the C<NextToken>
parameter in a new C<ListSubscriptions> call to get further results.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 C<NextToken> is also returned. Use the C<NextToken>
parameter in a new C<ListSubscriptionsByTopic> call to get further
results.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 C<NextToken> is
also returned. Use the C<NextToken> parameter in a new C<ListTopics>
call to get further results.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, 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 all of a topic's subscribed endpoints. When a
C<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. The second example below shows a request and response for publishing to a mobile endpoint.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
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 and APNS. For more
information, see Using Amazon SNS Mobile Push Notifications.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. For more
information, see Using Amazon SNS Mobile Push Notifications. For
information on configuring attributes for message delivery status, see
Using Amazon SNS Application Attributes for Message Delivery Status.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 Sending an SMS Message in the Amazon SNS Developer Guide.
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 topic 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.Subscribe(Protocol => Str, TopicArn => Str, [Endpoint => Str])
Each argument is described in detail in: Paws::SNS::Subscribe
Returns: a Paws::SNS::SubscribeResponse instance
Prepares to subscribe an endpoint by sending the endpoint a
confirmation message. To actually create a subscription, the endpoint
owner must call the C<ConfirmSubscription> action with the token from
the confirmation message. Confirmation tokens are valid for three days.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 AWS signature is required. If the C<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 C<Unsubscribe> request was unintended.SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues