Module erlcloud_sns

Data Types

sns_acl()

sns_acl() = [{string(), sns_permission()}]

sns_application()

sns_application() = [{arn, string()} | {attributes, [{arn | sns_application_attribute(), string()}]}]

sns_application_attribute()

sns_application_attribute() = event_endpoint_created | event_endpoint_deleted | event_endpoint_updated | event_delivery_failure

sns_endpoint()

sns_endpoint() = [{arn, string()} | {attributes, [{arn | sns_endpoint_attribute(), string()}]}]

sns_endpoint_attribute()

sns_endpoint_attribute() = custom_user_data | enabled | token

sns_event()

abstract datatype: sns_event()

sns_event_type()

sns_event_type() = subscription_confirmation | notification

sns_message()

sns_message() = string() | jsx:json_term()

sns_message_attributes()

sns_message_attributes() = [{string(), string() | binary() | number()}]

sns_notification()

abstract datatype: sns_notification()

sns_permission()

sns_permission() = all | add_permission | confirm_subscription | create_platform_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_endpoints_by_platform_application | list_platform_applications | list_subscriptions | list_subscriptions_by_topic | list_topics | publish | remove_permission | set_endpoint_attributes | set_platform_application_attributes | set_subscription_attributes | set_topic_attributes | subscribe | unsubscribe

sns_subscribe_protocol_type()

sns_subscribe_protocol_type() = http | https | email | 'email-json' | sms | sqs | application

sns_subscription_attribute_name()

sns_subscription_attribute_name() = 'DeliveryPolicy' | 'RawMessageDelivery' | 'FilterPolicy'

sns_topic_attribute_name()

sns_topic_attribute_name() = 'Policy' | 'DisplayName' | 'DeliveryPolicy'

Function Index

add_permission/3
add_permission/4
configure/2
configure/3
confirm_subscription/1
confirm_subscription/2
confirm_subscription/3
confirm_subscription2/2
confirm_subscription2/3
confirm_subscription2/4
create_platform_endpoint/2
create_platform_endpoint/3
create_platform_endpoint/4
create_platform_endpoint/5
create_platform_endpoint/6
create_topic/1
create_topic/2
delete_endpoint/1
delete_endpoint/2
delete_endpoint/3
delete_topic/1
delete_topic/2
get_endpoint_attributes/1
get_endpoint_attributes/2
get_endpoint_attributes/3
get_event_type/1
get_notification_attribute/2
get_subscription_attributes/1
get_subscription_attributes/2
get_topic_attributes/1
get_topic_attributes/2
list_endpoints_by_platform_application/1
list_endpoints_by_platform_application/2
list_endpoints_by_platform_application/3
list_endpoints_by_platform_application/4
list_platform_applications/0
list_platform_applications/1
list_platform_applications/2
list_platform_applications/3
list_subscriptions/0
list_subscriptions/1
list_subscriptions/2
list_subscriptions_all/0
list_subscriptions_all/1
list_subscriptions_by_topic/1
list_subscriptions_by_topic/2
list_subscriptions_by_topic/3
list_subscriptions_by_topic_all/1
list_subscriptions_by_topic_all/2
list_topics/0
list_topics/1
list_topics/2
list_topics_all/0
list_topics_all/1
new/2
new/3
parse_event/1
parse_event_message/1
publish/5 Publish API: http://docs.aws.amazon.com/sns/latest/api/API_Publish.html
publish/6
publish_to_phone/2
publish_to_phone/3
publish_to_phone/4
publish_to_target/2
publish_to_target/3
publish_to_target/4
publish_to_target/5
publish_to_topic/2
publish_to_topic/3
publish_to_topic/4
publish_to_topic/5
set_endpoint_attributes/2
set_endpoint_attributes/3
set_subscription_attributes/3
set_subscription_attributes/4
set_topic_attributes/3
set_topic_attributes/4
subscribe/3
subscribe/4
unsubscribe/1
unsubscribe/2

Function Details

add_permission/3

add_permission(TopicArn::string(), Label::string(), Permissions::sns_acl()) -> ok

add_permission/4

add_permission(TopicArn::string(), Label::string(), Permissions::sns_acl(), Config::aws_config()) -> ok

configure/2

configure(AccessKeyID::string(), SecretAccessKey::string()) -> ok

configure/3

configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> ok

confirm_subscription/1

confirm_subscription(SnsEvent::sns_event()) -> string()

confirm_subscription/2

confirm_subscription(SnsEvent::sns_event(), Config::aws_config()) -> string()

confirm_subscription/3

confirm_subscription(SnsEvent::sns_event(), AccessKeyID::string(), SecretAccessKey::string()) -> string()

confirm_subscription2/2

confirm_subscription2(Token::string(), TopicArn::string()) -> string()

confirm_subscription2/3

confirm_subscription2(Token::string(), TopicArn::string(), Config::aws_config()) -> string()

confirm_subscription2/4

confirm_subscription2(Token::string(), TopicArn::string(), AccessKeyID::string(), SecretAccessKey::string()) -> string()

create_platform_endpoint/2

create_platform_endpoint(PlatformApplicationArn::string(), Token::string()) -> string()

create_platform_endpoint/3

create_platform_endpoint(PlatformApplicationArn::string(), Token::string(), CustomUserData::string()) -> string()

create_platform_endpoint/4

create_platform_endpoint(PlatformApplicationArn::string(), Token::string(), CustomUserData::string(), Attributes::[{sns_endpoint_attribute(), string()}]) -> string()

create_platform_endpoint/5

create_platform_endpoint(PlatformApplicationArn::string(), Token::string(), CustomUserData::string(), Attributes::[{sns_endpoint_attribute(), string()}], Config::aws_config()) -> string()

create_platform_endpoint/6

create_platform_endpoint(PlatformApplicationArn::string(), Token::string(), CustomUserData::string(), Attributes::[{sns_endpoint_attribute(), string()}], AccessKeyID::string(), SecretAccessKey::string()) -> string()

create_topic/1

create_topic(TopicName::string()) -> string()

create_topic/2

create_topic(TopicName::string(), Config::aws_config()) -> string()

delete_endpoint/1

delete_endpoint(EndpointArn::string()) -> ok

delete_endpoint/2

delete_endpoint(EndpointArn::string(), Config::aws_config()) -> ok

delete_endpoint/3

delete_endpoint(EndpointArn::string(), AccessKeyID::string(), SecretAccessKey::string()) -> ok

delete_topic/1

delete_topic(TopicArn::string()) -> ok

delete_topic/2

delete_topic(TopicArn::string(), Config::aws_config()) -> ok

get_endpoint_attributes/1

get_endpoint_attributes(EndpointArn::string()) -> sns_endpoint()

get_endpoint_attributes/2

get_endpoint_attributes(EndpointArn::string(), Config::aws_config()) -> sns_endpoint()

get_endpoint_attributes/3

get_endpoint_attributes(EndpointArn::string(), AccessKeyID::string(), SecretAccessKey::string()) -> sns_endpoint()

get_event_type/1

get_event_type(Event::sns_event()) -> sns_event_type()

get_notification_attribute/2

get_notification_attribute(Attribute::binary(), Notification::sns_notification()) -> sns_application_attribute() | binary()

get_subscription_attributes/1

get_subscription_attributes(SubscriptionArn::string()) -> [{attributes, [{sns_subscription_attribute_name() | atom(), string()}]}]

get_subscription_attributes/2

get_subscription_attributes(SubscriptionArn::string(), Config::aws_config()) -> [{attributes, [{sns_subscription_attribute_name() | atom(), string()}]}]

get_topic_attributes/1

get_topic_attributes(TopicArn::string()) -> [{attributes, [{atom(), string()}]}]

get_topic_attributes/2

get_topic_attributes(TopicArn::string(), Config::aws_config()) -> [{attributes, [{atom(), string()}]}]

list_endpoints_by_platform_application/1

list_endpoints_by_platform_application(PlatformApplicationArn::string()) -> [{endpoints, [sns_endpoint()]} | {next_token, string()}]

list_endpoints_by_platform_application/2

list_endpoints_by_platform_application(PlatformApplicationArn::string(), NextToken::undefined | string()) -> [{endpoints, [sns_endpoint()]} | {next_token, string()}]

list_endpoints_by_platform_application/3

list_endpoints_by_platform_application(PlatformApplicationArn::string(), NextToken::undefined | string(), Config::aws_config()) -> [{endpoints, [sns_endpoint()]} | {next_token, string()}]

list_endpoints_by_platform_application/4

list_endpoints_by_platform_application(PlatformApplicationArn::string(), NextToken::undefined | string(), AccessKeyID::string(), SecretAccessKey::string()) -> [{endpoints, [sns_endpoint()]} | {next_token, string()}]

list_platform_applications/0

list_platform_applications() -> [sns_application()]

list_platform_applications/1

list_platform_applications(NextToken::undefined | string()) -> [sns_application()]

list_platform_applications/2

list_platform_applications(NextToken::undefined | string(), Config::aws_config()) -> [sns_application()]

list_platform_applications/3

list_platform_applications(NextToken::undefined | string(), AccessKeyID::string(), SecretAccessKey::string()) -> [sns_application()]

list_subscriptions/0

list_subscriptions() -> proplist()

list_subscriptions/1

list_subscriptions(Config::string() | aws_config()) -> proplist()

list_subscriptions/2

list_subscriptions(NextToken::undefined | string(), Config::aws_config()) -> proplist()

list_subscriptions_all/0

list_subscriptions_all() -> proplist()

list_subscriptions_all/1

list_subscriptions_all(Config::aws_config()) -> proplist()

list_subscriptions_by_topic/1

list_subscriptions_by_topic(TopicArn::string()) -> proplist()

list_subscriptions_by_topic/2

list_subscriptions_by_topic(TopicArn::string(), Config::string() | aws_config()) -> proplist()

list_subscriptions_by_topic/3

list_subscriptions_by_topic(TopicArn::string(), NextToken::undefined | string(), Config::aws_config()) -> proplist()

list_subscriptions_by_topic_all/1

list_subscriptions_by_topic_all(TopicArn::string()) -> proplist()

list_subscriptions_by_topic_all/2

list_subscriptions_by_topic_all(TopicArn::string(), Config::aws_config()) -> proplist()

list_topics/0

list_topics() -> [{topics, [[{arn, string()}]]} | {next_token, string()}]

list_topics/1

list_topics(Config::undefined | string() | aws_config()) -> [{topics, [[{arn, string()}]]} | {next_token, string()}]

list_topics/2

list_topics(NextToken::undefined | string(), Config::aws_config()) -> [{topics, [[{arn, string()}]]} | {next_token, string()}]

list_topics_all/0

list_topics_all() -> [[{arn, string()}]]

list_topics_all/1

list_topics_all(Config::aws_config()) -> [[{arn, string()}]]

new/2

new(AccessKeyID::string(), SecretAccessKey::string()) -> aws_config()

new/3

new(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> aws_config()

parse_event/1

parse_event(EventSource::iodata()) -> sns_event()

parse_event_message/1

parse_event_message(Event::sns_event()) -> sns_notification() | binary()

publish/5

publish(Type::topic | target | phone, RecipientArn::string(), Message::sns_message(), Subject::undefined | string(), Config::aws_config()) -> string()

Publish API: http://docs.aws.amazon.com/sns/latest/api/API_Publish.html

publish/6

publish(Type::topic | target | phone, RecipientArn::string(), Message::sns_message(), Subject::undefined | string(), Attributes::sns_message_attributes(), Config::aws_config()) -> string()

publish_to_phone/2

publish_to_phone(TargetArn::string(), Message::sns_message()) -> string()

publish_to_phone/3

publish_to_phone(TargetArn::string(), Message::sns_message(), Config::aws_config()) -> string()

publish_to_phone/4

publish_to_phone(TargetArn::string(), Message::sns_message(), AccessKeyID::string(), SecretAccessKey::string()) -> string()

publish_to_target/2

publish_to_target(TargetArn::string(), Message::sns_message()) -> string()

publish_to_target/3

publish_to_target(TargetArn::string(), Message::sns_message(), Subject::undefined | string()) -> string()

publish_to_target/4

publish_to_target(TargetArn::string(), Message::sns_message(), Subject::undefined | string(), Config::aws_config()) -> string()

publish_to_target/5

publish_to_target(TargetArn::string(), Message::sns_message(), Subject::undefined | string(), AccessKeyID::string(), SecretAccessKey::string()) -> string()

publish_to_topic/2

publish_to_topic(TopicArn::string(), Message::sns_message()) -> string()

publish_to_topic/3

publish_to_topic(TopicArn::string(), Message::sns_message(), Subject::undefined | string()) -> string()

publish_to_topic/4

publish_to_topic(TopicArn::string(), Message::sns_message(), Subject::undefined | string(), Config::aws_config()) -> string()

publish_to_topic/5

publish_to_topic(TopicArn::string(), Message::sns_message(), Subject::undefined | string(), AccessKeyID::string(), SecretAccessKey::string()) -> string()

set_endpoint_attributes/2

set_endpoint_attributes(EndpointArn::string(), Attributes::[{sns_endpoint_attribute(), string()}]) -> string()

set_endpoint_attributes/3

set_endpoint_attributes(EndpointArn::string(), Attributes::[{sns_endpoint_attribute(), string()}], Config::aws_config()) -> string()

set_subscription_attributes/3

set_subscription_attributes(AttributeName::sns_subscription_attribute_name(), AttributeValue::string() | binary(), SubscriptionArn::string()) -> ok

set_subscription_attributes/4

set_subscription_attributes(AttributeName::sns_subscription_attribute_name(), AttributeValue::string() | binary(), SubscriptionArn::string(), Config::aws_config()) -> ok

set_topic_attributes/3

set_topic_attributes(AttributeName::sns_topic_attribute_name(), AttributeValue::string() | binary(), TopicArn::string()) -> ok

set_topic_attributes/4

set_topic_attributes(AttributeName::sns_topic_attribute_name(), AttributeValue::string() | binary(), TopicArn::string(), Config::aws_config()) -> ok

subscribe/3

subscribe(Endpoint::string(), Protocol::sns_subscribe_protocol_type(), TopicArn::string()) -> Arn::string()

subscribe/4

subscribe(Endpoint::string(), Protocol::sns_subscribe_protocol_type(), TopicArn::string(), Config::aws_config()) -> Arn::string()

unsubscribe/1

unsubscribe(SubArn::string()) -> ok

unsubscribe/2

unsubscribe(SubArn::string(), Config::aws_config()) -> ok


Generated by EDoc