ExAws.SNS v2.1.0 ExAws.SNS View Source
Operations on AWS SNS
http://docs.aws.amazon.com/sns/latest/api/API_Operations.html
Link to this section Summary
Functions
Confirm Subscription
Create plaform application
Create platform endpoint
Create topic
Delete endpoint
Delete platform application
Delete topic
Get endpoint attributes
Get platform application attributes
Get subscription attributes
Get topic attributes
List endpooints and endpoint attributes for devices in a supported push notification service
List phone numbers opted out
List platform applications
List Subscriptions
List Subscriptions by Topic
List topics
Opt in phone number
Publish message to a target/topic ARN
Set endpoint attributes
Set subscription attributes
Set topic attributes
Create Subscription
Unsubscribe
Verify message signature
Link to this section Types
list_endpoints_by_platform_application_opt()
View Sourcelist_endpoints_by_platform_application_opt() :: {:next_token, binary()}
list_subscriptions_by_topic_opt()
View Sourcelist_subscriptions_by_topic_opt() :: {:next_token, binary()}
publish_opts()
View Sourcepublish_opts() :: [ message_attributes: [message_attribute()], message_structure: :json, subject: binary(), phone_number: binary(), target_arn: binary(), topic_arn: binary() ]
subscribe_opt()
View Sourcesubscribe_opt() :: {:return_subscription_arn, boolean()}
subscription_attribute_name()
View Sourcesubscription_attribute_name() :: :delivery_policy | :filter_policy | :raw_message_delivery
topic_attribute_name()
View Sourcetopic_attribute_name() :: :policy | :display_name | :delivery_policy
Link to this section Functions
confirm_subscription(topic_arn, token, authenticate_on_unsubscribe \\ false)
View Sourceconfirm_subscription( topic_arn :: binary(), token :: binary(), authenticate_on_unsubscribe :: boolean() ) :: ExAws.Operation.Query.t()
Confirm Subscription
create_platform_application(name, platform, attributes)
View Sourcecreate_platform_application( name :: binary(), platform :: binary(), attributes :: %{required(String.t()) => String.t()} ) :: ExAws.Operation.Query.t()
Create plaform application
create_platform_endpoint(platform_application_arn, token, custom_user_data \\ nil)
View Sourcecreate_platform_endpoint( platform_application_arn :: platform_application_arn(), token :: binary(), custom_user_data :: binary() ) :: ExAws.Operation.Query.t()
Create platform endpoint
create_topic(topic_name)
View Sourcecreate_topic(topic_name :: topic_name()) :: ExAws.Operation.Query.t()
Create topic
delete_endpoint(endpoint_arn)
View Sourcedelete_endpoint(endpoint_arn :: endpoint_arn()) :: ExAws.Operation.Query.t()
Delete endpoint
delete_platform_application(platform_application_arn)
View Sourcedelete_platform_application( platform_application_arn :: platform_application_arn() ) :: ExAws.Operation.Query.t()
Delete platform application
delete_topic(topic_arn)
View Sourcedelete_topic(topic_arn :: topic_arn()) :: ExAws.Operation.Query.t()
Delete topic
get_endpoint_attributes(endpoint_arn)
View Sourceget_endpoint_attributes(endpoint_arn :: endpoint_arn()) :: ExAws.Operation.Query.t()
Get endpoint attributes
get_platform_application_attributes(platform_application_arn)
View Sourceget_platform_application_attributes( platform_application_arn :: platform_application_arn() ) :: ExAws.Operation.Query.t()
Get platform application attributes
get_subscription_attributes(subscription_arn)
View Sourceget_subscription_attributes(subscription_arn :: binary()) :: ExAws.Operation.Query.t()
Get subscription attributes
get_topic_attributes(topic_arn)
View Sourceget_topic_attributes(topic_arn :: topic_arn()) :: ExAws.Operation.Query.t()
Get topic attributes
list_endpoints_by_platform_application(platform_application_arn, opts \\ [])
View Sourcelist_endpoints_by_platform_application(topic_arn :: topic_arn(), [ list_endpoints_by_platform_application_opt() ]) :: ExAws.Operation.Query.t()
List endpooints and endpoint attributes for devices in a supported push notification service
list_phone_numbers_opted_out()
View Sourcelist_phone_numbers_opted_out() :: ExAws.Operation.Query.t()
List phone numbers opted out
list_phone_numbers_opted_out(next_token)
View Sourcelist_phone_numbers_opted_out(next_token :: binary()) :: ExAws.Operation.Query.t()
list_platform_applications()
View Sourcelist_platform_applications() :: ExAws.Operation.Query.t()
List platform applications
list_platform_applications(next_token)
View Sourcelist_platform_applications(next_token :: binary()) :: ExAws.Operation.Query.t()
list_subscriptions()
View Sourcelist_subscriptions() :: ExAws.Operation.Query.t()
List Subscriptions
list_subscriptions(next_token)
View Sourcelist_subscriptions(next_token :: binary()) :: ExAws.Operation.Query.t()
list_subscriptions_by_topic(topic_arn, opts \\ [])
View Sourcelist_subscriptions_by_topic(topic_arn :: topic_arn(), [ list_subscriptions_by_topic_opt() ]) :: ExAws.Operation.Query.t()
List Subscriptions by Topic
list_topics(opts \\ [])
View Sourcelist_topics(opts :: [{:next_token, binary()}]) :: ExAws.Operation.Query.t()
List topics
opt_in_phone_number(phone_number)
View Sourceopt_in_phone_number(phone_number :: binary()) :: ExAws.Operation.Query.t()
Opt in phone number
publish(message, opts)
View Sourcepublish(message :: binary(), opts :: publish_opts()) :: ExAws.Operation.Query.t()
Publish message to a target/topic ARN
You must set either :phone_number, :target_arn or :topic_arn but only one, via the options argument.
Do NOT assume that because your message is a JSON blob that you should set message_structure: to :json. This has a very specific meaning, please see http://docs.aws.amazon.com/sns/latest/api/API_Publish.html for details.
set_endpoint_attributes(endpoint_arn, attributes)
View Sourceset_endpoint_attributes( endpoint_arn :: endpoint_arn(), attributes :: endpoint_attributes() ) :: ExAws.Operation.Query.t()
Set endpoint attributes
set_subscription_attributes(attribute_name, attribute_value, subscription_arn)
View Sourceset_subscription_attributes( attribute_name :: subscription_attribute_name(), attribute_value :: binary(), subscription_arn :: binary() ) :: ExAws.Operation.Query.t()
Set subscription attributes
set_topic_attributes(attribute_name, attribute_value, topic_arn)
View Sourceset_topic_attributes( attribute_name :: topic_attribute_name(), attribute_value :: binary(), topic_arn :: topic_arn() ) :: ExAws.Operation.Query.t()
Set topic attributes
subscribe(topic_arn, protocol, endpoint, opts \\ [])
View Sourcesubscribe(topic_arn :: binary(), protocol :: binary(), endpoint :: binary(), [ subscribe_opt() ]) :: ExAws.Operation.Query.t()
Create Subscription
unsubscribe(subscription_arn)
View Sourceunsubscribe(subscription_arn :: binary()) :: ExAws.Operation.Query.t()
Unsubscribe
Verify message signature