'2.0', 'service' => 'Amazon Simple Notification Service

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.

For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer Guide.

We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.

', 'operations' => [ 'AddPermission' => '

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.

', 'CheckIfPhoneNumberIsOptedOut' => '

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.

', 'ConfirmSubscription' => '

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

', 'CreatePlatformApplication' => '

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.

You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.

', 'CreatePlatformEndpoint' => '

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.

', 'CreateSMSSandboxPhoneNumber' => '

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.

', 'CreateTopic' => '

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.

', 'DeleteEndpoint' => '

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.

', 'DeletePlatformApplication' => '

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.

', 'DeleteSMSSandboxPhoneNumber' => '

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.

', 'DeleteTopic' => '

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.

', 'GetDataProtectionPolicy' => '

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

', 'GetEndpointAttributes' => '

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.

', 'GetPlatformApplicationAttributes' => '

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.

', 'GetSMSAttributes' => '

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

These settings are set with the SetSMSAttributes action.

', 'GetSMSSandboxAccountStatus' => '

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.

', 'GetSubscriptionAttributes' => '

Returns all of the properties of a subscription.

', 'GetTopicAttributes' => '

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

', 'ListEndpointsByPlatformApplication' => '

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

', 'ListOriginationNumbers' => '

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.

', 'ListPhoneNumbersOptedOut' => '

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.

', 'ListPlatformApplications' => '

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

', 'ListSMSSandboxPhoneNumbers' => '

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.

', 'ListSubscriptions' => '

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

', 'ListSubscriptionsByTopic' => '

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

', 'ListTagsForResource' => '

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.

', 'ListTopics' => '

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

', 'OptInPhoneNumber' => '

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.

', 'Publish' => '

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.

', 'PublishBatch' => '

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.

', 'PutDataProtectionPolicy' => '

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

', 'RemovePermission' => '

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

To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

', 'SetEndpointAttributes' => '

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.

', 'SetPlatformApplicationAttributes' => '

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.

', 'SetSMSAttributes' => '

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.

To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action.

', 'SetSubscriptionAttributes' => '

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

', 'SetTopicAttributes' => '

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

To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

', 'Subscribe' => '

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 three days.

This action is throttled at 100 transactions per second (TPS).

', 'TagResource' => '

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:

', 'Unsubscribe' => '

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.

Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature.

This action is throttled at 100 transactions per second (TPS).

', 'UntagResource' => '

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

', 'VerifySMSSandboxPhoneNumber' => '

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.

', ], 'shapes' => [ 'ActionsList' => [ 'base' => NULL, 'refs' => [ 'AddPermissionInput$ActionName' => '

The action you want to allow for the specified principal(s).

Valid values: Any Amazon SNS action name, for example Publish.

', ], ], 'AddPermissionInput' => [ 'base' => NULL, 'refs' => [], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceArn' => '

The ARN of the topic for which to list tags.

', 'TagResourceRequest$ResourceArn' => '

The ARN of the topic to which to add tags.

', 'UntagResourceRequest$ResourceArn' => '

The ARN of the topic from which to remove tags.

', ], ], 'AuthorizationErrorException' => [ 'base' => '

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

', 'refs' => [], ], 'BatchEntryIdsNotDistinctException' => [ 'base' => '

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

', 'refs' => [], ], 'BatchRequestTooLongException' => [ 'base' => '

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

', 'refs' => [], ], 'BatchResultErrorEntry' => [ 'base' => '

Gives a detailed description of failed messages in the batch.

', 'refs' => [ 'BatchResultErrorEntryList$member' => NULL, ], ], 'BatchResultErrorEntryList' => [ 'base' => NULL, 'refs' => [ 'PublishBatchResponse$Failed' => '

A list of failed PublishBatch responses.

', ], ], 'Binary' => [ 'base' => NULL, 'refs' => [ 'MessageAttributeValue$BinaryValue' => '

Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

', ], ], 'CheckIfPhoneNumberIsOptedOutInput' => [ 'base' => '

The input for the CheckIfPhoneNumberIsOptedOut action.

', 'refs' => [], ], 'CheckIfPhoneNumberIsOptedOutResponse' => [ 'base' => '

The response from the CheckIfPhoneNumberIsOptedOut action.

', 'refs' => [], ], 'ConcurrentAccessException' => [ 'base' => '

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

', 'refs' => [], ], 'ConfirmSubscriptionInput' => [ 'base' => '

Input for ConfirmSubscription action.

', 'refs' => [], ], 'ConfirmSubscriptionResponse' => [ 'base' => '

Response for ConfirmSubscriptions action.

', 'refs' => [], ], 'CreateEndpointResponse' => [ 'base' => '

Response from CreateEndpoint action.

', 'refs' => [], ], 'CreatePlatformApplicationInput' => [ 'base' => '

Input for CreatePlatformApplication action.

', 'refs' => [], ], 'CreatePlatformApplicationResponse' => [ 'base' => '

Response from CreatePlatformApplication action.

', 'refs' => [], ], 'CreatePlatformEndpointInput' => [ 'base' => '

Input for CreatePlatformEndpoint action.

', 'refs' => [], ], 'CreateSMSSandboxPhoneNumberInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateSMSSandboxPhoneNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateTopicInput' => [ 'base' => '

Input for CreateTopic action.

', 'refs' => [], ], 'CreateTopicResponse' => [ 'base' => '

Response from CreateTopic action.

', 'refs' => [], ], 'DelegatesList' => [ 'base' => NULL, 'refs' => [ 'AddPermissionInput$AWSAccountId' => '

The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service.

', ], ], 'DeleteEndpointInput' => [ 'base' => '

Input for DeleteEndpoint action.

', 'refs' => [], ], 'DeletePlatformApplicationInput' => [ 'base' => '

Input for DeletePlatformApplication action.

', 'refs' => [], ], 'DeleteSMSSandboxPhoneNumberInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSMSSandboxPhoneNumberResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteTopicInput' => [ 'base' => NULL, 'refs' => [], ], 'EmptyBatchRequestException' => [ 'base' => '

The batch request doesn\'t contain any entries.

', 'refs' => [], ], 'Endpoint' => [ 'base' => '

The endpoint for mobile app and device.

', 'refs' => [ 'ListOfEndpoints$member' => NULL, ], ], 'EndpointDisabledException' => [ 'base' => '

Exception error indicating endpoint disabled.

', 'refs' => [], ], 'FilterPolicyLimitExceededException' => [ 'base' => '

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 Services Support Center.

', 'refs' => [], ], 'GetDataProtectionPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'GetDataProtectionPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetEndpointAttributesInput' => [ 'base' => '

Input for GetEndpointAttributes action.

', 'refs' => [], ], 'GetEndpointAttributesResponse' => [ 'base' => '

Response from GetEndpointAttributes of the EndpointArn.

', 'refs' => [], ], 'GetPlatformApplicationAttributesInput' => [ 'base' => '

Input for GetPlatformApplicationAttributes action.

', 'refs' => [], ], 'GetPlatformApplicationAttributesResponse' => [ 'base' => '

Response for GetPlatformApplicationAttributes action.

', 'refs' => [], ], 'GetSMSAttributesInput' => [ 'base' => '

The input for the GetSMSAttributes request.

', 'refs' => [], ], 'GetSMSAttributesResponse' => [ 'base' => '

The response from the GetSMSAttributes request.

', 'refs' => [], ], 'GetSMSSandboxAccountStatusInput' => [ 'base' => NULL, 'refs' => [], ], 'GetSMSSandboxAccountStatusResult' => [ 'base' => NULL, 'refs' => [], ], 'GetSubscriptionAttributesInput' => [ 'base' => '

Input for GetSubscriptionAttributes.

', 'refs' => [], ], 'GetSubscriptionAttributesResponse' => [ 'base' => '

Response for GetSubscriptionAttributes action.

', 'refs' => [], ], 'GetTopicAttributesInput' => [ 'base' => '

Input for GetTopicAttributes action.

', 'refs' => [], ], 'GetTopicAttributesResponse' => [ 'base' => '

Response for GetTopicAttributes action.

', 'refs' => [], ], 'InternalErrorException' => [ 'base' => '

Indicates an internal service error.

', 'refs' => [], ], 'InvalidBatchEntryIdException' => [ 'base' => '

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

', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => '

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

', 'refs' => [], ], 'InvalidParameterValueException' => [ 'base' => '

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

', 'refs' => [], ], 'InvalidSecurityException' => [ 'base' => '

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

', 'refs' => [], ], 'Iso2CountryCode' => [ 'base' => 'The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. For example, GB or US.', 'refs' => [ 'PhoneNumberInformation$Iso2CountryCode' => '

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

', ], ], 'KMSAccessDeniedException' => [ 'base' => '

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

', 'refs' => [], ], 'KMSDisabledException' => [ 'base' => '

The request was rejected because the specified customer master key (CMK) isn\'t enabled.

', 'refs' => [], ], 'KMSInvalidStateException' => [ 'base' => '

The request was rejected because the state of the specified resource isn\'t valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the Key Management Service Developer Guide.

', 'refs' => [], ], 'KMSNotFoundException' => [ 'base' => '

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

', 'refs' => [], ], 'KMSOptInRequired' => [ 'base' => '

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

', 'refs' => [], ], 'KMSThrottlingException' => [ 'base' => '

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

', 'refs' => [], ], 'LanguageCodeString' => [ 'base' => 'Supported language code for sending OTP message', 'refs' => [ 'CreateSMSSandboxPhoneNumberInput$LanguageCode' => '

The language to use for sending the OTP. The default value is en-US.

', ], ], 'ListEndpointsByPlatformApplicationInput' => [ 'base' => '

Input for ListEndpointsByPlatformApplication action.

', 'refs' => [], ], 'ListEndpointsByPlatformApplicationResponse' => [ 'base' => '

Response for ListEndpointsByPlatformApplication action.

', 'refs' => [], ], 'ListOfEndpoints' => [ 'base' => NULL, 'refs' => [ 'ListEndpointsByPlatformApplicationResponse$Endpoints' => '

Endpoints returned for ListEndpointsByPlatformApplication action.

', ], ], 'ListOfPlatformApplications' => [ 'base' => NULL, 'refs' => [ 'ListPlatformApplicationsResponse$PlatformApplications' => '

Platform applications returned when calling ListPlatformApplications action.

', ], ], 'ListOriginationNumbersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListOriginationNumbersResult' => [ 'base' => NULL, 'refs' => [], ], 'ListPhoneNumbersOptedOutInput' => [ 'base' => '

The input for the ListPhoneNumbersOptedOut action.

', 'refs' => [], ], 'ListPhoneNumbersOptedOutResponse' => [ 'base' => '

The response from the ListPhoneNumbersOptedOut action.

', 'refs' => [], ], 'ListPlatformApplicationsInput' => [ 'base' => '

Input for ListPlatformApplications action.

', 'refs' => [], ], 'ListPlatformApplicationsResponse' => [ 'base' => '

Response for ListPlatformApplications action.

', 'refs' => [], ], 'ListSMSSandboxPhoneNumbersInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSMSSandboxPhoneNumbersResult' => [ 'base' => NULL, 'refs' => [], ], 'ListString' => [ 'base' => NULL, 'refs' => [ 'GetSMSAttributesInput$attributes' => '

A list of the individual attribute names, such as MonthlySpendLimit, for which you want values.

For all attribute names, see SetSMSAttributes.

If you don\'t use this parameter, Amazon SNS returns all SMS attributes.

', ], ], 'ListSubscriptionsByTopicInput' => [ 'base' => '

Input for ListSubscriptionsByTopic action.

', 'refs' => [], ], 'ListSubscriptionsByTopicResponse' => [ 'base' => '

Response for ListSubscriptionsByTopic action.

', 'refs' => [], ], 'ListSubscriptionsInput' => [ 'base' => '

Input for ListSubscriptions action.

', 'refs' => [], ], 'ListSubscriptionsResponse' => [ 'base' => '

Response for ListSubscriptions action

', 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTopicsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTopicsResponse' => [ 'base' => '

Response for ListTopics action.

', 'refs' => [], ], 'MapStringToString' => [ 'base' => NULL, 'refs' => [ 'CreatePlatformApplicationInput$Attributes' => '

For a list of attributes, see SetPlatformApplicationAttributes.

', 'CreatePlatformEndpointInput$Attributes' => '

For a list of attributes, see SetEndpointAttributes.

', 'Endpoint$Attributes' => '

Attributes for endpoint.

', 'GetEndpointAttributesResponse$Attributes' => '

Attributes include the following:

', 'GetPlatformApplicationAttributesResponse$Attributes' => '

Attributes include the following:

', 'GetSMSAttributesResponse$attributes' => '

The SMS attribute names and their values.

', 'PlatformApplication$Attributes' => '

Attributes for platform application object.

', 'SetEndpointAttributesInput$Attributes' => '

A map of the endpoint attributes. Attributes in this map include the following:

', 'SetPlatformApplicationAttributesInput$Attributes' => '

A map of the platform application attributes. Attributes in this map include the following:

The following attributes only apply to APNs token-based authentication:

', 'SetSMSAttributesInput$attributes' => '

The default settings for sending SMS messages from your Amazon Web Services account. You can set values for the following attribute names:

MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.

Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.

By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.

DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.

DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.

DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.

DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:

UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your Amazon Web Services account:

To receive the report, the bucket must have a policy that allows the Amazon SNS service principal to perform the s3:PutObject and s3:GetBucketLocation actions.

For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.

', ], ], 'MaxItems' => [ 'base' => NULL, 'refs' => [ 'ListSMSSandboxPhoneNumbersInput$MaxResults' => '

The maximum number of phone numbers to return.

', ], ], 'MaxItemsListOriginationNumbers' => [ 'base' => NULL, 'refs' => [ 'ListOriginationNumbersRequest$MaxResults' => '

The maximum number of origination numbers to return.

', ], ], 'MessageAttributeMap' => [ 'base' => NULL, 'refs' => [ 'PublishBatchRequestEntry$MessageAttributes' => '

Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SNS message attributes in the Amazon SNS Developer Guide.

', 'PublishInput$MessageAttributes' => '

Message attributes for Publish action.

', ], ], 'MessageAttributeValue' => [ 'base' => '

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.

', 'refs' => [ 'MessageAttributeMap$value' => NULL, ], ], 'NotFoundException' => [ 'base' => '

Indicates that the requested resource does not exist.

', 'refs' => [], ], 'NumberCapability' => [ 'base' => 'Enum listing out all supported number capabilities.', 'refs' => [ 'NumberCapabilityList$member' => NULL, ], ], 'NumberCapabilityList' => [ 'base' => 'List of number capability (SMS,MMS,Voice).', 'refs' => [ 'PhoneNumberInformation$NumberCapabilities' => '

The capabilities of each phone number.

', ], ], 'OTPCode' => [ 'base' => 'String of Origination/Destination address including phone numbers and email addresses', 'refs' => [ 'VerifySMSSandboxPhoneNumberInput$OneTimePassword' => '

The OTP sent to the destination number from the CreateSMSSandBoxPhoneNumber call.

', ], ], 'OptInPhoneNumberInput' => [ 'base' => '

Input for the OptInPhoneNumber action.

', 'refs' => [], ], 'OptInPhoneNumberResponse' => [ 'base' => '

The response for the OptInPhoneNumber action.

', 'refs' => [], ], 'OptedOutException' => [ 'base' => '

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.

', 'refs' => [], ], 'PhoneNumber' => [ 'base' => NULL, 'refs' => [ 'CheckIfPhoneNumberIsOptedOutInput$phoneNumber' => '

The phone number for which you want to check the opt out status.

', 'OptInPhoneNumberInput$phoneNumber' => '

The phone number to opt in. Use E.164 format.

', 'PhoneNumberList$member' => NULL, ], ], 'PhoneNumberInformation' => [ 'base' => '

A list of phone numbers and their metadata.

', 'refs' => [ 'PhoneNumberInformationList$member' => NULL, ], ], 'PhoneNumberInformationList' => [ 'base' => 'List of customer owned phone numbers.', 'refs' => [ 'ListOriginationNumbersResult$PhoneNumbers' => '

A list of the calling account\'s verified and pending origination numbers.

', ], ], 'PhoneNumberList' => [ 'base' => NULL, 'refs' => [ 'ListPhoneNumbersOptedOutResponse$phoneNumbers' => '

A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.

', ], ], 'PhoneNumberString' => [ 'base' => NULL, 'refs' => [ 'CreateSMSSandboxPhoneNumberInput$PhoneNumber' => '

The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to.

', 'DeleteSMSSandboxPhoneNumberInput$PhoneNumber' => '

The destination phone number to delete.

', 'SMSSandboxPhoneNumber$PhoneNumber' => '

The destination phone number.

', 'VerifySMSSandboxPhoneNumberInput$PhoneNumber' => '

The destination phone number to verify.

', ], ], 'PlatformApplication' => [ 'base' => '

Platform application object.

', 'refs' => [ 'ListOfPlatformApplications$member' => NULL, ], ], 'PlatformApplicationDisabledException' => [ 'base' => '

Exception error indicating platform application disabled.

', 'refs' => [], ], 'PublishBatchInput' => [ 'base' => NULL, 'refs' => [], ], 'PublishBatchRequestEntry' => [ 'base' => '

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

', 'refs' => [ 'PublishBatchRequestEntryList$member' => NULL, ], ], 'PublishBatchRequestEntryList' => [ 'base' => NULL, 'refs' => [ 'PublishBatchInput$PublishBatchRequestEntries' => '

A list of PublishBatch request entries to be sent to the SNS topic.

', ], ], 'PublishBatchResponse' => [ 'base' => NULL, 'refs' => [], ], 'PublishBatchResultEntry' => [ 'base' => '

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

', 'refs' => [ 'PublishBatchResultEntryList$member' => NULL, ], ], 'PublishBatchResultEntryList' => [ 'base' => NULL, 'refs' => [ 'PublishBatchResponse$Successful' => '

A list of successful PublishBatch responses.

', ], ], 'PublishInput' => [ 'base' => '

Input for Publish action.

', 'refs' => [], ], 'PublishResponse' => [ 'base' => '

Response for Publish action.

', 'refs' => [], ], 'PutDataProtectionPolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'RemovePermissionInput' => [ 'base' => '

Input for RemovePermission action.

', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => '

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

', 'refs' => [], ], 'RouteType' => [ 'base' => 'Enum listing out all supported route types. The following enum values are supported. 1. Transactional : Non-marketing traffic 2. Promotional : Marketing 3. Premium : Premium routes for OTP delivery to the carriers', 'refs' => [ 'PhoneNumberInformation$RouteType' => '

The list of supported routes.

', ], ], 'SMSSandboxPhoneNumber' => [ 'base' => '

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.

', 'refs' => [ 'SMSSandboxPhoneNumberList$member' => NULL, ], ], 'SMSSandboxPhoneNumberList' => [ 'base' => NULL, 'refs' => [ 'ListSMSSandboxPhoneNumbersResult$PhoneNumbers' => '

A list of the calling account\'s pending and verified phone numbers.

', ], ], 'SMSSandboxPhoneNumberVerificationStatus' => [ 'base' => 'Enum listing out all supported destination phone number verification statuses. The following enum values are supported. 1. PENDING : The destination phone number is pending verification. 2. VERIFIED : The destination phone number is verified.', 'refs' => [ 'SMSSandboxPhoneNumber$Status' => '

The destination phone number\'s verification status.

', ], ], 'SetEndpointAttributesInput' => [ 'base' => '

Input for SetEndpointAttributes action.

', 'refs' => [], ], 'SetPlatformApplicationAttributesInput' => [ 'base' => '

Input for SetPlatformApplicationAttributes action.

', 'refs' => [], ], 'SetSMSAttributesInput' => [ 'base' => '

The input for the SetSMSAttributes action.

', 'refs' => [], ], 'SetSMSAttributesResponse' => [ 'base' => '

The response for the SetSMSAttributes action.

', 'refs' => [], ], 'SetSubscriptionAttributesInput' => [ 'base' => '

Input for SetSubscriptionAttributes action.

', 'refs' => [], ], 'SetTopicAttributesInput' => [ 'base' => '

Input for SetTopicAttributes action.

', 'refs' => [], ], 'StaleTagException' => [ 'base' => '

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.

', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'BatchResultErrorEntry$Id' => '

The Id of an entry in a batch request

', 'BatchResultErrorEntry$Code' => '

An error code representing why the action failed on this entry.

', 'BatchResultErrorEntry$Message' => '

A message explaining why the action failed on this entry.

', 'CreateEndpointResponse$EndpointArn' => '

EndpointArn returned from CreateEndpoint action.

', 'CreatePlatformApplicationInput$Name' => '

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

', 'CreatePlatformApplicationInput$Platform' => '

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

', 'CreatePlatformApplicationResponse$PlatformApplicationArn' => '

PlatformApplicationArn is returned.

', 'CreatePlatformEndpointInput$PlatformApplicationArn' => '

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

', 'CreatePlatformEndpointInput$Token' => '

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

', 'CreatePlatformEndpointInput$CustomUserData' => '

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

', 'DeleteEndpointInput$EndpointArn' => '

EndpointArn of endpoint to delete.

', 'DeletePlatformApplicationInput$PlatformApplicationArn' => '

PlatformApplicationArn of platform application object to delete.

', 'Endpoint$EndpointArn' => '

The EndpointArn for mobile app and device.

', 'GetEndpointAttributesInput$EndpointArn' => '

EndpointArn for GetEndpointAttributes input.

', 'GetPlatformApplicationAttributesInput$PlatformApplicationArn' => '

PlatformApplicationArn for GetPlatformApplicationAttributesInput.

', 'ListEndpointsByPlatformApplicationInput$PlatformApplicationArn' => '

PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

', 'ListEndpointsByPlatformApplicationInput$NextToken' => '

NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

', 'ListEndpointsByPlatformApplicationResponse$NextToken' => '

NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.

', 'ListPlatformApplicationsInput$NextToken' => '

NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.

', 'ListPlatformApplicationsResponse$NextToken' => '

NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.

', 'ListString$member' => NULL, 'MapStringToString$key' => NULL, 'MapStringToString$value' => NULL, 'MessageAttributeMap$key' => NULL, 'MessageAttributeValue$DataType' => '

Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types.

', 'MessageAttributeValue$StringValue' => '

Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.

', 'PhoneNumberInformation$PhoneNumber' => '

The phone number.

', 'PhoneNumberInformation$Status' => '

The status of the phone number.

', 'PlatformApplication$PlatformApplicationArn' => '

PlatformApplicationArn for platform application object.

', 'PublishBatchRequestEntry$Id' => '

An identifier for the message in this batch.

The Ids of a batch request must be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

', 'PublishBatchRequestEntry$MessageDeduplicationId' => '

This parameter applies only to FIFO (first-in-first-out) topics.

The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren\'t delivered.

The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).

If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SNS can\'t detect duplicate messages.

Amazon SNS continues to keep track of the message deduplication ID even after the message is received and deleted.

The length of MessageDeduplicationId is 128 characters.

MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~).

', 'PublishBatchRequestEntry$MessageGroupId' => '

This parameter applies only to FIFO (first-in-first-out) topics.

The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single topic, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the topic, but the session data of each user is processed in a FIFO fashion.

You must associate a non-empty MessageGroupId with a message. If you don\'t provide a MessageGroupId, the action fails.

The length of MessageGroupId is 128 characters.

MessageGroupId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~).

MessageGroupId is required for FIFO topics. You can\'t use it for standard topics.

', 'PublishBatchResultEntry$Id' => '

The Id of an entry in a batch request.

', 'PublishBatchResultEntry$SequenceNumber' => '

This parameter applies only to FIFO (first-in-first-out) topics.

The large, non-consecutive number that Amazon SNS assigns to each message.

The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.

', 'PublishInput$TargetArn' => '

If you don\'t specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.

', 'PublishInput$PhoneNumber' => '

The phone number to which you want to deliver an SMS message. Use E.164 format.

If you don\'t specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters.

', 'PublishInput$MessageDeduplicationId' => '

This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~).

Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.

If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.

', 'PublishInput$MessageGroupId' => '

This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~).

The MessageGroupId is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId.

', 'PublishResponse$SequenceNumber' => '

This response element applies only to FIFO (first-in-first-out) topics.

The sequence number is a large, non-consecutive number that Amazon SNS assigns to each message. The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for each MessageGroupId.

', 'SetEndpointAttributesInput$EndpointArn' => '

EndpointArn used for SetEndpointAttributes action.

', 'SetPlatformApplicationAttributesInput$PlatformApplicationArn' => '

PlatformApplicationArn for SetPlatformApplicationAttributes action.

', ], ], 'SubscribeInput' => [ 'base' => '

Input for Subscribe action.

', 'refs' => [], ], 'SubscribeResponse' => [ 'base' => '

Response for Subscribe action.

', 'refs' => [], ], 'Subscription' => [ 'base' => '

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

', 'refs' => [ 'SubscriptionsList$member' => NULL, ], ], 'SubscriptionAttributesMap' => [ 'base' => NULL, 'refs' => [ 'GetSubscriptionAttributesResponse$Attributes' => '

A map of the subscription\'s attributes. Attributes in this map include the following:

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

', 'SubscribeInput$Attributes' => '

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the Subscribe action uses:

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

', ], ], 'SubscriptionLimitExceededException' => [ 'base' => '

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

', 'refs' => [], ], 'SubscriptionsList' => [ 'base' => NULL, 'refs' => [ 'ListSubscriptionsByTopicResponse$Subscriptions' => '

A list of subscriptions.

', 'ListSubscriptionsResponse$Subscriptions' => '

A list of subscriptions.

', ], ], 'Tag' => [ 'base' => '

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

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The required key portion of the tag.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

The list of tag keys to remove from the specified topic.

', ], ], 'TagLimitExceededException' => [ 'base' => '

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

', 'refs' => [], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateTopicInput$Tags' => '

The list of tags to add to a new topic.

To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.

', 'ListTagsForResourceResponse$Tags' => '

The tags associated with the specified topic.

', 'TagResourceRequest$Tags' => '

The tags to be added to the specified topic. A tag consists of a required key and an optional value.

', ], ], 'TagPolicyException' => [ 'base' => '

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

', 'refs' => [], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The optional value portion of the tag.

', ], ], 'ThrottledException' => [ 'base' => '

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

', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'PhoneNumberInformation$CreatedAt' => '

The date and time when the phone number was created.

', ], ], 'TooManyEntriesInBatchRequestException' => [ 'base' => '

The batch request contains more entries than permissible.

', 'refs' => [], ], 'Topic' => [ 'base' => '

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

', 'refs' => [ 'TopicsList$member' => NULL, ], ], 'TopicAttributesMap' => [ 'base' => NULL, 'refs' => [ 'CreateTopicInput$Attributes' => '

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:

The following attribute applies only to server-side encryption:

The following attributes apply only to FIFO topics:

', 'GetTopicAttributesResponse$Attributes' => '

A map of the topic\'s attributes. Attributes in this map include the following:

The following attribute applies only to server-side-encryption:

The following attributes apply only to FIFO topics:

', ], ], 'TopicLimitExceededException' => [ 'base' => '

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

', 'refs' => [], ], 'TopicsList' => [ 'base' => NULL, 'refs' => [ 'ListTopicsResponse$Topics' => '

A list of topic ARNs.

', ], ], 'UnsubscribeInput' => [ 'base' => '

Input for Unsubscribe action.

', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UserErrorException' => [ 'base' => '

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

', 'refs' => [], ], 'ValidationException' => [ 'base' => '

Indicates that a parameter in the request is invalid.

', 'refs' => [], ], 'VerificationException' => [ 'base' => '

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

', 'refs' => [], ], 'VerifySMSSandboxPhoneNumberInput' => [ 'base' => NULL, 'refs' => [], ], 'VerifySMSSandboxPhoneNumberResult' => [ 'base' => '

The destination phone number\'s verification status.

', 'refs' => [], ], 'account' => [ 'base' => NULL, 'refs' => [ 'Subscription$Owner' => '

The subscription\'s owner.

', ], ], 'action' => [ 'base' => NULL, 'refs' => [ 'ActionsList$member' => NULL, ], ], 'attributeName' => [ 'base' => NULL, 'refs' => [ 'SetSubscriptionAttributesInput$AttributeName' => '

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that this action uses:

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

', 'SetTopicAttributesInput$AttributeName' => '

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs.

The following attribute applies only to server-side-encryption:

The following attribute applies only to FIFO topics:

', 'SubscriptionAttributesMap$key' => NULL, 'TopicAttributesMap$key' => NULL, ], ], 'attributeValue' => [ 'base' => NULL, 'refs' => [ 'CreateTopicInput$DataProtectionPolicy' => '

The body of the policy document you want to use for this topic.

You can only add one policy per topic.

The policy must be in JSON string format.

Length Constraints: Maximum length of 30,720.

', 'GetDataProtectionPolicyResponse$DataProtectionPolicy' => '

Retrieves the DataProtectionPolicy in JSON string format.

', 'PutDataProtectionPolicyInput$DataProtectionPolicy' => '

The JSON serialization of the topic\'s DataProtectionPolicy.

The DataProtectionPolicy must be in JSON string format.

Length Constraints: Maximum length of 30,720.

', 'SetSubscriptionAttributesInput$AttributeValue' => '

The new value for the attribute in JSON format.

', 'SetTopicAttributesInput$AttributeValue' => '

The new value for the attribute.

', 'SubscriptionAttributesMap$value' => NULL, 'TopicAttributesMap$value' => NULL, ], ], 'authenticateOnUnsubscribe' => [ 'base' => NULL, 'refs' => [ 'ConfirmSubscriptionInput$AuthenticateOnUnsubscribe' => '

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.

', ], ], 'boolean' => [ 'base' => NULL, 'refs' => [ 'BatchResultErrorEntry$SenderFault' => '

Specifies whether the error happened due to the caller of the batch API action.

', 'CheckIfPhoneNumberIsOptedOutResponse$isOptedOut' => '

Indicates whether the phone number is opted out:

', 'GetSMSSandboxAccountStatusResult$IsInSandbox' => '

Indicates whether the calling Amazon Web Services account is in the SMS sandbox.

', 'SubscribeInput$ReturnSubscriptionArn' => '

Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.

If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes the pending subscription ARN value for subscriptions that aren\'t yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.

The default value is false.

', ], ], 'delegate' => [ 'base' => NULL, 'refs' => [ 'DelegatesList$member' => NULL, ], ], 'endpoint' => [ 'base' => NULL, 'refs' => [ 'SubscribeInput$Endpoint' => '

The endpoint that you want to receive notifications. Endpoints vary by protocol:

', 'Subscription$Endpoint' => '

The subscription\'s endpoint (format depends on the protocol).

', ], ], 'label' => [ 'base' => NULL, 'refs' => [ 'AddPermissionInput$Label' => '

A unique identifier for the new policy statement.

', 'RemovePermissionInput$Label' => '

The unique label of the statement you want to remove.

', ], ], 'message' => [ 'base' => NULL, 'refs' => [ 'PublishBatchRequestEntry$Message' => '

The body of the message.

', 'PublishInput$Message' => '

The message you want to send.

If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

Constraints:

JSON-specific constraints:

', ], ], 'messageId' => [ 'base' => NULL, 'refs' => [ 'PublishBatchResultEntry$MessageId' => '

An identifier for the message.

', 'PublishResponse$MessageId' => '

Unique identifier assigned to the published message.

Length Constraint: Maximum 100 characters

', ], ], 'messageStructure' => [ 'base' => NULL, 'refs' => [ 'PublishBatchRequestEntry$MessageStructure' => '

Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:

You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g. http).

', 'PublishInput$MessageStructure' => '

Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:

You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").

Valid value: json

', ], ], 'nextToken' => [ 'base' => NULL, 'refs' => [ 'ListOriginationNumbersRequest$NextToken' => '

Token that the previous ListOriginationNumbers request returns.

', 'ListOriginationNumbersResult$NextToken' => '

A NextToken string is returned when you call the ListOriginationNumbers operation if additional pages of records are available.

', 'ListSMSSandboxPhoneNumbersInput$NextToken' => '

Token that the previous ListSMSSandboxPhoneNumbersInput request returns.

', 'ListSubscriptionsByTopicInput$NextToken' => '

Token returned by the previous ListSubscriptionsByTopic request.

', 'ListSubscriptionsByTopicResponse$NextToken' => '

Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.

', 'ListSubscriptionsInput$NextToken' => '

Token returned by the previous ListSubscriptions request.

', 'ListSubscriptionsResponse$NextToken' => '

Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.

', 'ListTopicsInput$NextToken' => '

Token returned by the previous ListTopics request.

', 'ListTopicsResponse$NextToken' => '

Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.

', ], ], 'protocol' => [ 'base' => NULL, 'refs' => [ 'SubscribeInput$Protocol' => '

The protocol that you want to use. Supported protocols include:

', 'Subscription$Protocol' => '

The subscription\'s protocol.

', ], ], 'string' => [ 'base' => NULL, 'refs' => [ 'AuthorizationErrorException$message' => NULL, 'BatchEntryIdsNotDistinctException$message' => NULL, 'BatchRequestTooLongException$message' => NULL, 'ConcurrentAccessException$message' => NULL, 'EmptyBatchRequestException$message' => NULL, 'EndpointDisabledException$message' => '

Message for endpoint disabled.

', 'FilterPolicyLimitExceededException$message' => NULL, 'InternalErrorException$message' => NULL, 'InvalidBatchEntryIdException$message' => NULL, 'InvalidParameterException$message' => NULL, 'InvalidParameterValueException$message' => '

The parameter of an entry in a request doesn\'t abide by the specification.

', 'InvalidSecurityException$message' => NULL, 'KMSAccessDeniedException$message' => NULL, 'KMSDisabledException$message' => NULL, 'KMSInvalidStateException$message' => NULL, 'KMSNotFoundException$message' => NULL, 'KMSOptInRequired$message' => NULL, 'KMSThrottlingException$message' => NULL, 'ListPhoneNumbersOptedOutInput$nextToken' => '

A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.

', 'ListPhoneNumbersOptedOutResponse$nextToken' => '

A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.

', 'ListSMSSandboxPhoneNumbersResult$NextToken' => '

A NextToken string is returned when you call the ListSMSSandboxPhoneNumbersInput operation if additional pages of records are available.

', 'NotFoundException$message' => NULL, 'OptedOutException$message' => NULL, 'PlatformApplicationDisabledException$message' => '

Message for platform application disabled.

', 'ResourceNotFoundException$message' => NULL, 'StaleTagException$message' => NULL, 'SubscriptionLimitExceededException$message' => NULL, 'TagLimitExceededException$message' => NULL, 'TagPolicyException$message' => NULL, 'ThrottledException$message' => '

Throttled request.

', 'TooManyEntriesInBatchRequestException$message' => NULL, 'TopicLimitExceededException$message' => NULL, 'UserErrorException$message' => NULL, 'ValidationException$Message' => NULL, 'VerificationException$Message' => NULL, 'VerificationException$Status' => '

The status of the verification error.

', ], ], 'subject' => [ 'base' => NULL, 'refs' => [ 'PublishBatchRequestEntry$Subject' => '

The subject of the batch message.

', 'PublishInput$Subject' => '

Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

', ], ], 'subscriptionARN' => [ 'base' => NULL, 'refs' => [ 'ConfirmSubscriptionResponse$SubscriptionArn' => '

The ARN of the created subscription.

', 'GetSubscriptionAttributesInput$SubscriptionArn' => '

The ARN of the subscription whose properties you want to get.

', 'SetSubscriptionAttributesInput$SubscriptionArn' => '

The ARN of the subscription to modify.

', 'SubscribeResponse$SubscriptionArn' => '

The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires confirmation. However, if the API request parameter ReturnSubscriptionArn is true, then the value is always the subscription ARN, even if the subscription requires confirmation.

', 'Subscription$SubscriptionArn' => '

The subscription\'s ARN.

', 'UnsubscribeInput$SubscriptionArn' => '

The ARN of the subscription to be deleted.

', ], ], 'token' => [ 'base' => NULL, 'refs' => [ 'ConfirmSubscriptionInput$Token' => '

Short-lived token sent to an endpoint during the Subscribe action.

', ], ], 'topicARN' => [ 'base' => NULL, 'refs' => [ 'AddPermissionInput$TopicArn' => '

The ARN of the topic whose access control policy you wish to modify.

', 'ConfirmSubscriptionInput$TopicArn' => '

The ARN of the topic for which you wish to confirm a subscription.

', 'CreateTopicResponse$TopicArn' => '

The Amazon Resource Name (ARN) assigned to the created topic.

', 'DeleteTopicInput$TopicArn' => '

The ARN of the topic you want to delete.

', 'GetDataProtectionPolicyInput$ResourceArn' => '

The ARN of the topic whose DataProtectionPolicy you want to get.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

', 'GetTopicAttributesInput$TopicArn' => '

The ARN of the topic whose properties you want to get.

', 'ListSubscriptionsByTopicInput$TopicArn' => '

The ARN of the topic for which you wish to find subscriptions.

', 'PublishBatchInput$TopicArn' => '

The Amazon resource name (ARN) of the topic you want to batch publish to.

', 'PublishInput$TopicArn' => '

The topic you want to publish to.

If you don\'t specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.

', 'PutDataProtectionPolicyInput$ResourceArn' => '

The ARN of the topic whose DataProtectionPolicy you want to add or update.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

', 'RemovePermissionInput$TopicArn' => '

The ARN of the topic whose access control policy you wish to modify.

', 'SetTopicAttributesInput$TopicArn' => '

The ARN of the topic to modify.

', 'SubscribeInput$TopicArn' => '

The ARN of the topic you want to subscribe to.

', 'Subscription$TopicArn' => '

The ARN of the subscription\'s topic.

', 'Topic$TopicArn' => '

The topic\'s ARN.

', ], ], 'topicName' => [ 'base' => NULL, 'refs' => [ 'CreateTopicInput$Name' => '

The name of the topic you want to create.

Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.

', ], ], ],];