Module Smaws_Client_SNS

SNS client library built on EIO.

Types

module Types : sig ... end

Builders

val make_verify_sms_sandbox_phone_number_input : one_time_password:Types.otp_code -> phone_number:Types.phone_number_string -> unit -> Types.verify_sms_sandbox_phone_number_input
val make_untag_resource_response : unit -> unit
val make_untag_resource_request : tag_keys:Types.tag_key_list -> resource_arn:Types.amazon_resource_name -> unit -> Types.untag_resource_request
val make_unsubscribe_input : subscription_arn:Types.subscription_ar_n -> unit -> Types.unsubscribe_input
val make_topic : ?topic_arn:Types.topic_ar_n -> unit -> Types.topic
val make_tag_resource_response : unit -> unit
val make_tag : value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag
val make_tag_resource_request : tags:Types.tag_list -> resource_arn:Types.amazon_resource_name -> unit -> Types.tag_resource_request
val make_subscription : ?topic_arn:Types.topic_ar_n -> ?endpoint:Types.endpoint2 -> ?protocol:Types.protocol -> ?owner:Types.account -> ?subscription_arn:Types.subscription_ar_n -> unit -> Types.subscription
val make_subscribe_response : ?subscription_arn:Types.subscription_ar_n -> unit -> Types.subscribe_response
val make_subscribe_input : ?return_subscription_arn:Types.boolean_ -> ?attributes:Types.subscription_attributes_map -> ?endpoint:Types.endpoint2 -> protocol:Types.protocol -> topic_arn:Types.topic_ar_n -> unit -> Types.subscribe_input
val make_set_topic_attributes_input : ?attribute_value:Types.attribute_value -> attribute_name:Types.attribute_name -> topic_arn:Types.topic_ar_n -> unit -> Types.set_topic_attributes_input
val make_set_subscription_attributes_input : ?attribute_value:Types.attribute_value -> attribute_name:Types.attribute_name -> subscription_arn:Types.subscription_ar_n -> unit -> Types.set_subscription_attributes_input
val make_set_sms_attributes_response : unit -> unit
val make_set_sms_attributes_input : attributes:Types.map_string_to_string -> unit -> Types.set_sms_attributes_input
val make_set_platform_application_attributes_input : attributes:Types.map_string_to_string -> platform_application_arn:Types.string_ -> unit -> Types.set_platform_application_attributes_input
val make_set_endpoint_attributes_input : attributes:Types.map_string_to_string -> endpoint_arn:Types.string_ -> unit -> Types.set_endpoint_attributes_input
val make_sms_sandbox_phone_number : ?status:Types.sms_sandbox_phone_number_verification_status -> ?phone_number:Types.phone_number_string -> unit -> Types.sms_sandbox_phone_number
val make_remove_permission_input : label:Types.label -> topic_arn:Types.topic_ar_n -> unit -> Types.remove_permission_input
val make_put_data_protection_policy_input : data_protection_policy:Types.attribute_value -> resource_arn:Types.topic_ar_n -> unit -> Types.put_data_protection_policy_input
val make_publish_response : ?sequence_number:Types.string_ -> ?message_id:Types.message_id -> unit -> Types.publish_response
val make_message_attribute_value : ?binary_value:Types.binary -> ?string_value:Types.string_ -> data_type:Types.string_ -> unit -> Types.message_attribute_value
val make_publish_input : ?message_group_id:Types.string_ -> ?message_deduplication_id:Types.string_ -> ?message_attributes:Types.message_attribute_map -> ?message_structure:Types.message_structure -> ?subject:Types.subject -> ?phone_number:Types.phone_number -> ?target_arn:Types.string_ -> ?topic_arn:Types.topic_ar_n -> message:Types.message -> unit -> Types.publish_input
val make_publish_batch_result_entry : ?sequence_number:Types.string_ -> ?message_id:Types.message_id -> ?id:Types.string_ -> unit -> Types.publish_batch_result_entry
val make_batch_result_error_entry : ?message:Types.string_ -> sender_fault:Types.boolean_ -> code:Types.string_ -> id:Types.string_ -> unit -> Types.batch_result_error_entry
val make_publish_batch_response : ?failed:Types.batch_result_error_entry_list -> ?successful:Types.publish_batch_result_entry_list -> unit -> Types.publish_batch_response
val make_publish_batch_request_entry : ?message_group_id:Types.string_ -> ?message_deduplication_id:Types.string_ -> ?message_attributes:Types.message_attribute_map -> ?message_structure:Types.message_structure -> ?subject:Types.subject -> message:Types.message -> id:Types.string_ -> unit -> Types.publish_batch_request_entry
val make_publish_batch_input : publish_batch_request_entries:Types.publish_batch_request_entry_list -> topic_arn:Types.topic_ar_n -> unit -> Types.publish_batch_input
val make_platform_application : ?attributes:Types.map_string_to_string -> ?platform_application_arn:Types.string_ -> unit -> Types.platform_application
val make_phone_number_information : ?number_capabilities:Types.number_capability_list -> ?route_type:Types.route_type -> ?iso2_country_code:Types.iso2_country_code -> ?status:Types.string_ -> ?phone_number:Types.phone_number -> ?created_at:Types.timestamp -> unit -> Types.phone_number_information
val make_opt_in_phone_number_response : unit -> unit
val make_opt_in_phone_number_input : phone_number:Types.phone_number -> unit -> Types.opt_in_phone_number_input
val make_list_topics_response : ?next_token:Types.next_token -> ?topics:Types.topics_list -> unit -> Types.list_topics_response
val make_list_topics_input : ?next_token:Types.next_token -> unit -> Types.list_topics_input
val make_list_tags_for_resource_response : ?tags:Types.tag_list -> unit -> Types.list_tags_for_resource_response
val make_list_tags_for_resource_request : resource_arn:Types.amazon_resource_name -> unit -> Types.list_tags_for_resource_request
val make_list_subscriptions_response : ?next_token:Types.next_token -> ?subscriptions:Types.subscriptions_list -> unit -> Types.list_subscriptions_response
val make_list_subscriptions_input : ?next_token:Types.next_token -> unit -> Types.list_subscriptions_input
val make_list_subscriptions_by_topic_response : ?next_token:Types.next_token -> ?subscriptions:Types.subscriptions_list -> unit -> Types.list_subscriptions_by_topic_response
val make_list_subscriptions_by_topic_input : ?next_token:Types.next_token -> topic_arn:Types.topic_ar_n -> unit -> Types.list_subscriptions_by_topic_input
val make_list_sms_sandbox_phone_numbers_input : ?max_results:Types.max_items -> ?next_token:Types.next_token -> unit -> Types.list_sms_sandbox_phone_numbers_input
val make_list_platform_applications_response : ?next_token:Types.string_ -> ?platform_applications:Types.list_of_platform_applications -> unit -> Types.list_platform_applications_response
val make_list_platform_applications_input : ?next_token:Types.string_ -> unit -> Types.list_platform_applications_input
val make_list_phone_numbers_opted_out_response : ?next_token:Types.string_ -> ?phone_numbers:Types.phone_number_list -> unit -> Types.list_phone_numbers_opted_out_response
val make_list_phone_numbers_opted_out_input : ?next_token:Types.string_ -> unit -> Types.list_phone_numbers_opted_out_input
val make_list_origination_numbers_request : ?max_results:Types.max_items_list_origination_numbers -> ?next_token:Types.next_token -> unit -> Types.list_origination_numbers_request
val make_endpoint : ?attributes:Types.map_string_to_string -> ?endpoint_arn:Types.string_ -> unit -> Types.endpoint
val make_list_endpoints_by_platform_application_response : ?next_token:Types.string_ -> ?endpoints:Types.list_of_endpoints -> unit -> Types.list_endpoints_by_platform_application_response
val make_list_endpoints_by_platform_application_input : ?next_token:Types.string_ -> platform_application_arn:Types.string_ -> unit -> Types.list_endpoints_by_platform_application_input
val make_get_topic_attributes_response : ?attributes:Types.topic_attributes_map -> unit -> Types.get_topic_attributes_response
val make_get_topic_attributes_input : topic_arn:Types.topic_ar_n -> unit -> Types.get_topic_attributes_input
val make_get_subscription_attributes_response : ?attributes:Types.subscription_attributes_map -> unit -> Types.get_subscription_attributes_response
val make_get_subscription_attributes_input : subscription_arn:Types.subscription_ar_n -> unit -> Types.get_subscription_attributes_input
val make_get_sms_sandbox_account_status_input : unit -> unit
val make_get_sms_attributes_response : ?attributes:Types.map_string_to_string -> unit -> Types.get_sms_attributes_response
val make_get_sms_attributes_input : ?attributes:Types.list_string -> unit -> Types.get_sms_attributes_input
val make_get_platform_application_attributes_response : ?attributes:Types.map_string_to_string -> unit -> Types.get_platform_application_attributes_response
val make_get_platform_application_attributes_input : platform_application_arn:Types.string_ -> unit -> Types.get_platform_application_attributes_input
val make_get_endpoint_attributes_response : ?attributes:Types.map_string_to_string -> unit -> Types.get_endpoint_attributes_response
val make_get_endpoint_attributes_input : endpoint_arn:Types.string_ -> unit -> Types.get_endpoint_attributes_input
val make_get_data_protection_policy_response : ?data_protection_policy:Types.attribute_value -> unit -> Types.get_data_protection_policy_response
val make_get_data_protection_policy_input : resource_arn:Types.topic_ar_n -> unit -> Types.get_data_protection_policy_input
val make_delete_topic_input : topic_arn:Types.topic_ar_n -> unit -> Types.delete_topic_input
val make_delete_sms_sandbox_phone_number_input : phone_number:Types.phone_number_string -> unit -> Types.delete_sms_sandbox_phone_number_input
val make_delete_platform_application_input : platform_application_arn:Types.string_ -> unit -> Types.delete_platform_application_input
val make_delete_endpoint_input : endpoint_arn:Types.string_ -> unit -> Types.delete_endpoint_input
val make_create_topic_response : ?topic_arn:Types.topic_ar_n -> unit -> Types.create_topic_response
val make_create_topic_input : ?data_protection_policy:Types.attribute_value -> ?tags:Types.tag_list -> ?attributes:Types.topic_attributes_map -> name:Types.topic_name -> unit -> Types.create_topic_input
val make_create_sms_sandbox_phone_number_input : ?language_code:Types.language_code_string -> phone_number:Types.phone_number_string -> unit -> Types.create_sms_sandbox_phone_number_input
val make_create_platform_endpoint_input : ?attributes:Types.map_string_to_string -> ?custom_user_data:Types.string_ -> token:Types.string_ -> platform_application_arn:Types.string_ -> unit -> Types.create_platform_endpoint_input
val make_create_endpoint_response : ?endpoint_arn:Types.string_ -> unit -> Types.create_endpoint_response
val make_create_platform_application_response : ?platform_application_arn:Types.string_ -> unit -> Types.create_platform_application_response
val make_create_platform_application_input : attributes:Types.map_string_to_string -> platform:Types.string_ -> name:Types.string_ -> unit -> Types.create_platform_application_input
val make_confirm_subscription_response : ?subscription_arn:Types.subscription_ar_n -> unit -> Types.confirm_subscription_response
val make_confirm_subscription_input : ?authenticate_on_unsubscribe:Types.authenticate_on_unsubscribe -> token:Types.token -> topic_arn:Types.topic_ar_n -> unit -> Types.confirm_subscription_input
val make_check_if_phone_number_is_opted_out_response : ?is_opted_out:Types.boolean_ -> unit -> Types.check_if_phone_number_is_opted_out_response
val make_check_if_phone_number_is_opted_out_input : phone_number:Types.phone_number -> unit -> Types.check_if_phone_number_is_opted_out_input
val make_add_permission_input : action_name:Types.actions_list -> aws_account_id:Types.delegates_list -> label:Types.label -> topic_arn:Types.topic_ar_n -> unit -> Types.add_permission_input

Operations

module AddPermission : sig ... end

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

module CheckIfPhoneNumberIsOptedOut : sig ... end

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.

module ConfirmSubscription : sig ... end

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

module CreatePlatformApplication : sig ... end

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.

module CreatePlatformEndpoint : sig ... end

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.

module CreateSMSSandboxPhoneNumber : sig ... end

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.

module CreateTopic : sig ... end

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.

module DeleteEndpoint : sig ... end

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.

module DeletePlatformApplication : sig ... end

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.

module DeleteSMSSandboxPhoneNumber : sig ... end

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

module DeleteTopic : sig ... end

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.

module GetDataProtectionPolicy : sig ... end

Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic.

module GetEndpointAttributes : sig ... end

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.

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.

module GetSMSAttributes : sig ... end

Returns the settings for sending SMS messages from your Amazon Web Services account.

module GetSMSSandboxAccountStatus : sig ... end

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

module GetSubscriptionAttributes : sig ... end

Returns all of the properties of a subscription.

module GetTopicAttributes : sig ... end

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

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.

module ListOriginationNumbers : sig ... end

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.

module ListPhoneNumbersOptedOut : sig ... end

Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.

module ListPlatformApplications : sig ... end

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.

module ListSMSSandboxPhoneNumbers : sig ... end

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

module ListSubscriptions : sig ... end

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.

module ListSubscriptionsByTopic : sig ... end

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.

module ListTagsForResource : sig ... end

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.

module ListTopics : sig ... end

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.

module OptInPhoneNumber : sig ... end

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

module Publish : sig ... end

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

module PublishBatch : sig ... end

Publishes up to 10 messages to the specified topic in a single batch. This is a batch version of the Publish API. If you try to send more than 10 messages in a single batch request, you will receive a TooManyEntriesInBatchRequest exception.

module PutDataProtectionPolicy : sig ... end

Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.

module RemovePermission : sig ... end

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

module SetEndpointAttributes : sig ... end

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.

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.

module SetSMSAttributes : sig ... end

Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.

module SetSubscriptionAttributes : sig ... end

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

module SetTopicAttributes : sig ... end

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

module Subscribe : sig ... end

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.

module TagResource : sig ... end

Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

module Unsubscribe : sig ... end

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.

module UntagResource : sig ... end

Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

module VerifySMSSandboxPhoneNumber : sig ... end
module Query_serializers : sig ... end
module Query_deserializers : sig ... end