Class: Aws::SNS::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SNS::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb
Overview
An API client for SNS. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::SNS::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_permission(params = {}) ⇒ Struct
Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.
-
#check_if_phone_number_is_opted_out(params = {}) ⇒ Types::CheckIfPhoneNumberIsOptedOutResponse
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account.
-
#confirm_subscription(params = {}) ⇒ Types::ConfirmSubscriptionResponse
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier
Subscribe
action. -
#create_platform_application(params = {}) ⇒ Types::CreatePlatformApplicationResponse
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.
-
#create_platform_endpoint(params = {}) ⇒ Types::CreateEndpointResponse
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.
-
#create_sms_sandbox_phone_number(params = {}) ⇒ Struct
Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number.
-
#create_topic(params = {}) ⇒ Types::CreateTopicResponse
Creates a topic to which notifications can be published.
-
#delete_endpoint(params = {}) ⇒ Struct
Deletes the endpoint for a device and mobile app from Amazon SNS.
-
#delete_platform_application(params = {}) ⇒ Struct
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
-
#delete_sms_sandbox_phone_number(params = {}) ⇒ Struct
Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.
-
#delete_topic(params = {}) ⇒ Struct
Deletes a topic and all its subscriptions.
-
#get_data_protection_policy(params = {}) ⇒ Types::GetDataProtectionPolicyResponse
Retrieves the specified inline
DataProtectionPolicy
document that is stored in the specified Amazon SNS topic. -
#get_endpoint_attributes(params = {}) ⇒ Types::GetEndpointAttributesResponse
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.
-
#get_platform_application_attributes(params = {}) ⇒ Types::GetPlatformApplicationAttributesResponse
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
-
#get_sms_attributes(params = {}) ⇒ Types::GetSMSAttributesResponse
Returns the settings for sending SMS messages from your Amazon Web Services account.
-
#get_sms_sandbox_account_status(params = {}) ⇒ Types::GetSMSSandboxAccountStatusResult
Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.
-
#get_subscription_attributes(params = {}) ⇒ Types::GetSubscriptionAttributesResponse
Returns all of the properties of a subscription.
-
#get_topic_attributes(params = {}) ⇒ Types::GetTopicAttributesResponse
Returns all of the properties of a topic.
-
#list_endpoints_by_platform_application(params = {}) ⇒ Types::ListEndpointsByPlatformApplicationResponse
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS.
-
#list_origination_numbers(params = {}) ⇒ Types::ListOriginationNumbersResult
Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata.
-
#list_phone_numbers_opted_out(params = {}) ⇒ Types::ListPhoneNumbersOptedOutResponse
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
-
#list_platform_applications(params = {}) ⇒ Types::ListPlatformApplicationsResponse
Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
-
#list_sms_sandbox_phone_numbers(params = {}) ⇒ Types::ListSMSSandboxPhoneNumbersResult
Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox.
-
#list_subscriptions(params = {}) ⇒ Types::ListSubscriptionsResponse
Returns a list of the requester's subscriptions.
-
#list_subscriptions_by_topic(params = {}) ⇒ Types::ListSubscriptionsByTopicResponse
Returns a list of the subscriptions to a specific topic.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List all tags added to the specified Amazon SNS topic.
-
#list_topics(params = {}) ⇒ Types::ListTopicsResponse
Returns a list of the requester's topics.
-
#opt_in_phone_number(params = {}) ⇒ Struct
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
-
#publish(params = {}) ⇒ Types::PublishResponse
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
). -
#publish_batch(params = {}) ⇒ Types::PublishBatchResponse
Publishes up to ten messages to the specified topic.
-
#put_data_protection_policy(params = {}) ⇒ Struct
Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.
-
#remove_permission(params = {}) ⇒ Struct
Removes a statement from a topic's access control policy.
-
#set_endpoint_attributes(params = {}) ⇒ Struct
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.
-
#set_platform_application_attributes(params = {}) ⇒ Struct
Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
-
#set_sms_attributes(params = {}) ⇒ Struct
Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
-
#set_subscription_attributes(params = {}) ⇒ Struct
Allows a subscription owner to set an attribute of the subscription to a new value.
-
#set_topic_attributes(params = {}) ⇒ Struct
Allows a topic owner to set an attribute of the topic to a new value.
-
#subscribe(params = {}) ⇒ Types::SubscribeResponse
Subscribes an endpoint to an Amazon SNS topic.
-
#tag_resource(params = {}) ⇒ Struct
Add tags to the specified Amazon SNS topic.
-
#unsubscribe(params = {}) ⇒ Struct
Deletes a subscription.
-
#untag_resource(params = {}) ⇒ Struct
Remove tags from the specified Amazon SNS topic.
-
#verify_sms_sandbox_phone_number(params = {}) ⇒ Struct
Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
444 445 446 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 444 def initialize(*args) super end |
Instance Method Details
#add_permission(params = {}) ⇒ Struct
Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.
AddPermission
, RemovePermission
, and
SetTopicAttributes
actions in your IAM policy.
492 493 494 495 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 492 def (params = {}, = {}) req = build_request(:add_permission, params) req.send_request() end |
#check_if_phone_number_is_opted_out(params = {}) ⇒ Types::CheckIfPhoneNumberIsOptedOutResponse
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services 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.
525 526 527 528 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 525 def check_if_phone_number_is_opted_out(params = {}, = {}) req = build_request(:check_if_phone_number_is_opted_out, params) req.send_request() end |
#confirm_subscription(params = {}) ⇒ Types::ConfirmSubscriptionResponse
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".
569 570 571 572 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 569 def confirm_subscription(params = {}, = {}) req = build_request(:confirm_subscription, params) req.send_request() end |
#create_platform_application(params = {}) ⇒ Types::CreatePlatformApplicationResponse
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
isclient id
andPlatformCredential
isclient secret
.For APNS and
APNS_SANDBOX
using certificate credentials,PlatformPrincipal
isSSL certificate
andPlatformCredential
isprivate key
.For APNS and
APNS_SANDBOX
using token credentials,PlatformPrincipal
issigning key ID
andPlatformCredential
issigning key
.For Baidu,
PlatformPrincipal
isAPI key
andPlatformCredential
issecret key
.For GCM (Firebase Cloud Messaging) using key credentials, there is no
PlatformPrincipal
. ThePlatformCredential
isAPI key
.For GCM (Firebase Cloud Messaging) using token credentials, there is no
PlatformPrincipal
. ThePlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command:SERVICE_JSON=`jq @json <<< cat service.json`
.For MPNS,
PlatformPrincipal
isTLS certificate
andPlatformCredential
isprivate key
.For WNS,
PlatformPrincipal
isPackage Security Identifier
andPlatformCredential
issecret key
.
You can use the returned PlatformApplicationArn
as an attribute for
the CreatePlatformEndpoint
action.
656 657 658 659 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 656 def create_platform_application(params = {}, = {}) req = build_request(:create_platform_application, params) req.send_request() end |
#create_platform_endpoint(params = {}) ⇒ Types::CreateEndpointResponse
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.
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.
729 730 731 732 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 729 def create_platform_endpoint(params = {}, = {}) req = build_request(:create_platform_endpoint, params) req.send_request() end |
#create_sms_sandbox_phone_number(params = {}) ⇒ Struct
Adds a destination phone number to an Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 in the Amazon SNS Developer Guide.
773 774 775 776 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 773 def create_sms_sandbox_phone_number(params = {}, = {}) req = build_request(:create_sms_sandbox_phone_number, params) req.send_request() end |
#create_topic(params = {}) ⇒ Types::CreateTopicResponse
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 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.
912 913 914 915 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 912 def create_topic(params = {}, = {}) req = build_request(:create_topic, params) req.send_request() end |
#delete_endpoint(params = {}) ⇒ Struct
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.
943 944 945 946 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 943 def delete_endpoint(params = {}, = {}) req = build_request(:delete_endpoint, params) req.send_request() end |
#delete_platform_application(params = {}) ⇒ Struct
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.
972 973 974 975 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 972 def delete_platform_application(params = {}, = {}) req = build_request(:delete_platform_application, params) req.send_request() end |
#delete_sms_sandbox_phone_number(params = {}) ⇒ Struct
Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services 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 Amazon Web Services 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 in the Amazon SNS Developer Guide.
1009 1010 1011 1012 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1009 def delete_sms_sandbox_phone_number(params = {}, = {}) req = build_request(:delete_sms_sandbox_phone_number, params) req.send_request() end |
#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.
1034 1035 1036 1037 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1034 def delete_topic(params = {}, = {}) req = build_request(:delete_topic, params) req.send_request() end |
#get_data_protection_policy(params = {}) ⇒ Types::GetDataProtectionPolicyResponse
Retrieves the specified inline DataProtectionPolicy
document that is
stored in the specified Amazon SNS topic.
1070 1071 1072 1073 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1070 def get_data_protection_policy(params = {}, = {}) req = build_request(:get_data_protection_policy, params) req.send_request() end |
#get_endpoint_attributes(params = {}) ⇒ Types::GetEndpointAttributesResponse
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.
1106 1107 1108 1109 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1106 def get_endpoint_attributes(params = {}, = {}) req = build_request(:get_endpoint_attributes, params) req.send_request() end |
#get_platform_application_attributes(params = {}) ⇒ Types::GetPlatformApplicationAttributesResponse
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.
1142 1143 1144 1145 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1142 def get_platform_application_attributes(params = {}, = {}) req = build_request(:get_platform_application_attributes, params) req.send_request() end |
#get_sms_attributes(params = {}) ⇒ Types::GetSMSAttributesResponse
Returns the settings for sending SMS messages from your Amazon Web Services account.
These settings are set with the SetSMSAttributes
action.
1184 1185 1186 1187 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1184 def get_sms_attributes(params = {}, = {}) req = build_request(:get_sms_attributes, params) req.send_request() end |
#get_sms_sandbox_account_status(params = {}) ⇒ Types::GetSMSSandboxAccountStatusResult
Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services 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 Amazon Web Services 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 in the Amazon SNS Developer Guide.
1218 1219 1220 1221 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1218 def get_sms_sandbox_account_status(params = {}, = {}) req = build_request(:get_sms_sandbox_account_status, params) req.send_request() end |
#get_subscription_attributes(params = {}) ⇒ Types::GetSubscriptionAttributesResponse
Returns all of the properties of a subscription.
1247 1248 1249 1250 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1247 def get_subscription_attributes(params = {}, = {}) req = build_request(:get_subscription_attributes, params) req.send_request() end |
#get_topic_attributes(params = {}) ⇒ Types::GetTopicAttributesResponse
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
1277 1278 1279 1280 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1277 def get_topic_attributes(params = {}, = {}) req = build_request(:get_topic_attributes, params) req.send_request() end |
#list_endpoints_by_platform_application(params = {}) ⇒ Types::ListEndpointsByPlatformApplicationResponse
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.
This action is throttled at 30 transactions per second (TPS).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1334 1335 1336 1337 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1334 def list_endpoints_by_platform_application(params = {}, = {}) req = build_request(:list_endpoints_by_platform_application, params) req.send_request() end |
#list_origination_numbers(params = {}) ⇒ Types::ListOriginationNumbersResult
Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1384 1385 1386 1387 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1384 def list_origination_numbers(params = {}, = {}) req = build_request(:list_origination_numbers, params) req.send_request() end |
#list_phone_numbers_opted_out(params = {}) ⇒ Types::ListPhoneNumbersOptedOutResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1428 1429 1430 1431 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1428 def list_phone_numbers_opted_out(params = {}, = {}) req = build_request(:list_phone_numbers_opted_out, params) req.send_request() end |
#list_platform_applications(params = {}) ⇒ Types::ListPlatformApplicationsResponse
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.
This action is throttled at 15 transactions per second (TPS).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1480 1481 1482 1483 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1480 def list_platform_applications(params = {}, = {}) req = build_request(:list_platform_applications, params) req.send_request() end |
#list_sms_sandbox_phone_numbers(params = {}) ⇒ Types::ListSMSSandboxPhoneNumbersResult
Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services 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 Amazon Web Services 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 in the Amazon SNS Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1534 1535 1536 1537 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1534 def list_sms_sandbox_phone_numbers(params = {}, = {}) req = build_request(:list_sms_sandbox_phone_numbers, params) req.send_request() end |
#list_subscriptions(params = {}) ⇒ Types::ListSubscriptionsResponse
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).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1576 1577 1578 1579 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1576 def list_subscriptions(params = {}, = {}) req = build_request(:list_subscriptions, params) req.send_request() end |
#list_subscriptions_by_topic(params = {}) ⇒ Types::ListSubscriptionsByTopicResponse
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).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1623 1624 1625 1626 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1623 def list_subscriptions_by_topic(params = {}, = {}) req = build_request(:list_subscriptions_by_topic, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.
1659 1660 1661 1662 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1659 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_topics(params = {}) ⇒ Types::ListTopicsResponse
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).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1697 1698 1699 1700 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1697 def list_topics(params = {}, = {}) req = build_request(:list_topics, params) req.send_request() end |
#opt_in_phone_number(params = {}) ⇒ Struct
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.
1722 1723 1724 1725 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1722 def opt_in_phone_number(params = {}, = {}) req = build_request(:opt_in_phone_number, params) req.send_request() end |
#publish(params = {}) ⇒ Types::PublishResponse
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 is saved and Amazon SNS
immediately delivers it to subscribers.
To use the Publish
action for publishing 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.
You can publish messages only to topics and endpoints in the same Amazon Web Services Region.
1917 1918 1919 1920 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 1917 def publish(params = {}, = {}) req = build_request(:publish, params) req.send_request() end |
#publish_batch(params = {}) ⇒ Types::PublishBatchResponse
Publishes up to ten messages to the specified topic. This is a batch
version of Publish
. For FIFO topics, multiple messages within a
single batch are published in the order they are sent, and messages
are deduplicated within the batch and across batches for 5 minutes.
The result of publishing each message is reported individually in the
response. Because the batch request can result in a combination of
successful and unsuccessful actions, you should check for batch errors
even when the call returns an HTTP status code of 200
.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
Some actions take lists of parameters. These lists are specified using
the param.n
notation. Values of n
are integers starting from 1.
For example, a parameter list with two elements looks like this:
&AttributeName.1=first
&AttributeName.2=second
If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.
When a messageId
is returned, the batch message is saved and Amazon
SNS immediately delivers the message to subscribers.
2003 2004 2005 2006 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 2003 def publish_batch(params = {}, = {}) req = build_request(:publish_batch, params) req.send_request() end |
#put_data_protection_policy(params = {}) ⇒ Struct
Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.
2042 2043 2044 2045 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 2042 def put_data_protection_policy(params = {}, = {}) req = build_request(:put_data_protection_policy, params) req.send_request() end |
#remove_permission(params = {}) ⇒ Struct
Removes a statement from a topic's access control policy.
AddPermission
, RemovePermission
, and
SetTopicAttributes
actions in your IAM policy.
2074 2075 2076 2077 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 2074 def (params = {}, = {}) req = build_request(:remove_permission, params) req.send_request() end |
#set_endpoint_attributes(params = {}) ⇒ Struct
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.
2124 2125 2126 2127 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 2124 def set_endpoint_attributes(params = {}, = {}) req = build_request(:set_endpoint_attributes, params) req.send_request() end |
#set_platform_application_attributes(params = {}) ⇒ Struct
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. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.
2233 2234 2235 2236 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 2233 def set_platform_application_attributes(params = {}, = {}) req = build_request(:set_platform_application_attributes, params) req.send_request() end |
#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 Publishing to a mobile phone
in the Amazon SNS Developer Guide.
sns.amazonaws.com
) permission to perform the s3:ListBucket
action.
2355 2356 2357 2358 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 2355 def set_sms_attributes(params = {}, = {}) req = build_request(:set_sms_attributes, params) req.send_request() end |
#set_subscription_attributes(params = {}) ⇒ Struct
Allows a subscription owner to set an attribute of the subscription to a new value.
2432 2433 2434 2435 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 2432 def set_subscription_attributes(params = {}, = {}) req = build_request(:set_subscription_attributes, params) req.send_request() end |
#set_topic_attributes(params = {}) ⇒ Struct
Allows a topic owner to set an attribute of the topic to a new value.
AddPermission
, RemovePermission
, and
SetTopicAttributes
actions in your IAM policy.
2622 2623 2624 2625 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 2622 def set_topic_attributes(params = {}, = {}) req = build_request(:set_topic_attributes, params) req.send_request() end |
#subscribe(params = {}) ⇒ Types::SubscribeResponse
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
Amazon Web Services 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 two days.
This action is throttled at 100 transactions per second (TPS).
2802 2803 2804 2805 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 2802 def subscribe(params = {}, = {}) req = build_request(:subscribe, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags 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 Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request.
2856 2857 2858 2859 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 2856 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#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 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).
2892 2893 2894 2895 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 2892 def unsubscribe(params = {}, = {}) req = build_request(:unsubscribe, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
2923 2924 2925 2926 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 2923 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#verify_sms_sandbox_phone_number(params = {}) ⇒ Struct
Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services 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 Amazon Web Services 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 in the Amazon SNS Developer Guide.
2965 2966 2967 2968 |
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/client.rb', line 2965 def verify_sms_sandbox_phone_number(params = {}, = {}) req = build_request(:verify_sms_sandbox_phone_number, params) req.send_request() end |