Module Awso_sns.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval xmlNamespace : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule Binary : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule MessageAttributeValue : sig ... end

The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish. Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Amazon SNS message attributes and Publishing to a mobile phone in the Amazon SNS Developer Guide.

Sourcemodule NumberCapability : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule Boolean : sig ... end
Sourcemodule MessageId : sig ... end
Sourcemodule MessageAttributeMap : sig ... end
Sourcemodule Message : sig ... end
Sourcemodule MessageStructure : sig ... end
Sourcemodule Subject : sig ... end
Sourcemodule TopicARN : sig ... end
Sourcemodule Account : sig ... end
Sourcemodule Protocol : sig ... end
Sourcemodule SubscriptionARN : sig ... end
Sourcemodule PhoneNumberString : sig ... end
Sourcemodule MapStringToString : sig ... end
Sourcemodule Iso2CountryCode : sig ... end

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. For example, GB or US.

Sourcemodule NumberCapabilityList : sig ... end
Sourcemodule PhoneNumber : sig ... end
Sourcemodule RouteType : sig ... end
Sourcemodule Timestamp : sig ... end
Sourcemodule Tag : sig ... end

The list of tags to be added to the specified topic.

Sourcemodule AttributeName : sig ... end
Sourcemodule AttributeValue : sig ... end
Sourcemodule BatchResultErrorEntry : sig ... end

Gives a detailed description of failed messages in the batch.

Sourcemodule PublishBatchResultEntry : sig ... end

Encloses data related to a successful message in a batch request for topic.

Sourcemodule PublishBatchRequestEntry : sig ... end

Contains the details of a single Amazon SNS message along with an Id that identifies a message within the batch.

Sourcemodule Topic : sig ... end

A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.

Sourcemodule Subscription : sig ... end

A wrapper type for the attributes of an Amazon SNS subscription.

Sourcemodule SMSSandboxPhoneNumber : sig ... end

A verified or pending destination phone number 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.

Sourcemodule PlatformApplication : sig ... end

Platform application object.

Sourcemodule PhoneNumberInformation : sig ... end

A list of phone numbers and their metadata.

Sourcemodule Endpoint : sig ... end

The endpoint for mobile app and device.

Sourcemodule Action : sig ... end
Sourcemodule Delegate : sig ... end

Indicates that the user has been denied access to the requested resource.

Sourcemodule InternalErrorException : sig ... end

Indicates an internal service error.

Sourcemodule InvalidParameterException : sig ... end

Indicates that a request parameter does not comply with the associated constraints.

Sourcemodule ResourceNotFoundException : sig ... end

Can’t perform the action on the specified resource. Make sure that the resource exists.

Sourcemodule ThrottledException : sig ... end

Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.

Sourcemodule VerificationException : sig ... end

Indicates that the one-time password (OTP) used for verification is invalid.

Sourcemodule OTPCode : sig ... end

String of Origination/Destination address including phone numbers and email addresses

Sourcemodule ConcurrentAccessException : sig ... end

Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.

Sourcemodule StaleTagException : sig ... end

A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.

Sourcemodule TagLimitExceededException : sig ... end

Can't add more than 50 tags to a topic.

Sourcemodule TagPolicyException : sig ... end

The request doesn't comply with the IAM tag policy. Correct your request and then retry it.

Sourcemodule AmazonResourceName : sig ... end
Sourcemodule TagKeyList : sig ... end
Sourcemodule TagList : sig ... end

Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web ServicesSupport Center.

Sourcemodule InvalidSecurityException : sig ... end

The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.

Sourcemodule NotFoundException : sig ... end

Indicates that the requested resource does not exist.

Indicates that the request parameter has exceeded the maximum number of concurrent message replays.

Indicates that the customer already owns the maximum allowed number of subscriptions.

Sourcemodule SubscriptionAttributesMap : sig ... end
Sourcemodule Label : sig ... end
Sourcemodule EndpointDisabledException : sig ... end

Exception error indicating endpoint disabled.

Indicates that a request parameter does not comply with the associated constraints.

Sourcemodule KMSAccessDeniedException : sig ... end

The ciphertext references a key that doesn't exist or that you don't have access to.

Sourcemodule KMSDisabledException : sig ... end

The request was rejected because the specified Amazon Web Services KMS key isn't enabled.

Sourcemodule KMSInvalidStateException : sig ... end

The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide.

Sourcemodule KMSNotFoundException : sig ... end

The request was rejected because the specified entity or resource can't be found.

Sourcemodule KMSOptInRequired : sig ... end

The Amazon Web Services access key ID needs a subscription for the service.

Sourcemodule KMSThrottlingException : sig ... end

The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide.

Exception error indicating platform application disabled.

Sourcemodule ValidationException : sig ... end

Indicates that a parameter in the request is invalid.

Two or more batch entries in the request have the same Id.

The length of all the batch messages put together is more than the limit.

Sourcemodule BatchResultErrorEntryList : sig ... end

The batch request doesn't contain any entries.

The Id of a batch entry in a batch request doesn't abide by the specification.

The batch request contains more entries than permissible (more than 10).

Sourcemodule TopicsList : sig ... end
Sourcemodule NextToken : sig ... end
Sourcemodule SubscriptionsList : sig ... end
Sourcemodule SMSSandboxPhoneNumberList : sig ... end
Sourcemodule MaxItems : sig ... end
Sourcemodule PhoneNumberList : sig ... end
Sourcemodule ListOfEndpoints : sig ... end
Sourcemodule TopicAttributesMap : sig ... end
Sourcemodule ListString : sig ... end
Sourcemodule UserErrorException : sig ... end

Indicates that a request parameter does not comply with the associated constraints.

Indicates that the customer already owns the maximum allowed number of topics.

Sourcemodule TopicName : sig ... end
Sourcemodule OptedOutException : sig ... end

Indicates that the specified phone number opted out of receiving SMS messages from your Amazon Web Services account. You can't send SMS messages to phone numbers that opt out.

Sourcemodule LanguageCodeString : sig ... end
Sourcemodule AuthenticateOnUnsubscribe : sig ... end
Sourcemodule Token : sig ... end
Sourcemodule ActionsList : sig ... end
Sourcemodule DelegatesList : sig ... end

The destination phone number's verification status.

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.

Sourcemodule UntagResourceResponse : sig ... end

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

Sourcemodule UntagResourceRequest : sig ... end

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

Sourcemodule UnsubscribeInput : sig ... end

Input for Unsubscribe action.

Sourcemodule TagResourceResponse : sig ... end

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.

Sourcemodule TagResourceRequest : sig ... end

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.

Sourcemodule SubscribeResponse : sig ... end

Response for Subscribe action.

Sourcemodule SubscribeInput : sig ... end

Input for Subscribe action.

Sourcemodule SetTopicAttributesInput : sig ... end

Input for SetTopicAttributes action.

Input for SetSubscriptionAttributes action.

Sourcemodule SetSMSAttributesResponse : sig ... end

The response for the SetSMSAttributes action.

Sourcemodule SetSMSAttributesInput : sig ... end

The input for the SetSMSAttributes action.

Input for SetPlatformApplicationAttributes action.

Input for SetEndpointAttributes action.

Sourcemodule RemovePermissionInput : sig ... end

Input for RemovePermission action.

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

Sourcemodule PublishResponse : sig ... end

Response for Publish action.

Sourcemodule PublishInput : sig ... end

Input for Publish action.

Sourcemodule PublishBatchResponse : 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. 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 five 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). The PublishBatch API can send up to 10 messages at a time. If you attempt to send more than 10 messages in one request, you will encounter a TooManyEntriesInBatchRequest exception. In such cases, split your messages into multiple requests, each containing no more than 10 messages. 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.

Sourcemodule PublishBatchInput : 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. 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 five 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). The PublishBatch API can send up to 10 messages at a time. If you attempt to send more than 10 messages in one request, you will encounter a TooManyEntriesInBatchRequest exception. In such cases, split your messages into multiple requests, each containing no more than 10 messages. 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.

Sourcemodule OptInPhoneNumberResponse : sig ... end

The response for the OptInPhoneNumber action.

Sourcemodule OptInPhoneNumberInput : sig ... end

Input for the OptInPhoneNumber action.

Sourcemodule ListTopicsResponse : sig ... end

Response for ListTopics action.

Sourcemodule ListTopicsInput : 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. This action is throttled at 30 transactions per second (TPS).

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.

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.

Sourcemodule ListSubscriptionsResponse : sig ... end

Response for ListSubscriptions action

Sourcemodule ListSubscriptionsInput : sig ... end

Input for ListSubscriptions action.

Response for ListSubscriptionsByTopic action.

Input for ListSubscriptionsByTopic action.

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.

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.

Response for ListPlatformApplications action.

Input for ListPlatformApplications action.

The response from the ListPhoneNumbersOptedOut action.

The input for the ListPhoneNumbersOptedOut action.

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.

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.

Response for ListEndpointsByPlatformApplication action.

Input for ListEndpointsByPlatformApplication action.

Sourcemodule InvalidStateException : sig ... end

Indicates that the specified state is not a valid state for an event source.

Response for GetTopicAttributes action.

Sourcemodule GetTopicAttributesInput : sig ... end

Input for GetTopicAttributes action.

Response for GetSubscriptionAttributes action.

Input for GetSubscriptionAttributes.

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.

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.

Sourcemodule GetSMSAttributesResponse : sig ... end

The response from the GetSMSAttributes request.

Sourcemodule GetSMSAttributesInput : sig ... end

The input for the GetSMSAttributes request.

Response for GetPlatformApplicationAttributes action.

Input for GetPlatformApplicationAttributes action.

Response from GetEndpointAttributes of the EndpointArn.

Input for GetEndpointAttributes action.

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

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

Sourcemodule DeleteTopicInput : 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.

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.

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.

Input for DeletePlatformApplication action.

Sourcemodule DeleteEndpointInput : sig ... end

Input for DeleteEndpoint action.

Sourcemodule CreateTopicResponse : sig ... end

Response from CreateTopic action.

Sourcemodule CreateTopicInput : sig ... end

Input for CreateTopic action.

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.

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.

Input for CreatePlatformEndpoint action.

Response from CreatePlatformApplication action.

Input for CreatePlatformApplication action.

Sourcemodule CreateEndpointResponse : sig ... end

Response from CreateEndpoint action.

Response for ConfirmSubscriptions action.

Sourcemodule ConfirmSubscriptionInput : sig ... end

Input for ConfirmSubscription action.

The response from the CheckIfPhoneNumberIsOptedOut action.

The input for the CheckIfPhoneNumberIsOptedOut action.

Sourcemodule AddPermissionInput : 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. To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.