{ "version":"2.0", "metadata":{ "uid":"sns-2010-03-31", "apiVersion":"2010-03-31", "endpointPrefix":"sns", "protocol":"query", "serviceAbbreviation":"Amazon SNS", "serviceFullName":"Amazon Simple Notification Service", "signatureVersion":"v4", "xmlNamespace":"http://sns.amazonaws.com/doc/2010-03-31/" }, "operations":{ "AddPermission":{ "name":"AddPermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddPermissionInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

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

" }, "CheckIfPhoneNumberIsOptedOut":{ "name":"CheckIfPhoneNumberIsOptedOut", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CheckIfPhoneNumberIsOptedOutInput"}, "output":{ "shape":"CheckIfPhoneNumberIsOptedOutResponse", "resultWrapper":"CheckIfPhoneNumberIsOptedOutResult" }, "errors":[ {"shape":"ThrottledException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your 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":{ "name":"ConfirmSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmSubscriptionInput"}, "output":{ "shape":"ConfirmSubscriptionResponse", "resultWrapper":"ConfirmSubscriptionResult" }, "errors":[ {"shape":"SubscriptionLimitExceededException"}, {"shape":"InvalidParameterException"}, {"shape":"NotFoundException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

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":{ "name":"CreatePlatformApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlatformApplicationInput"}, "output":{ "shape":"CreatePlatformApplicationResponse", "resultWrapper":"CreatePlatformApplicationResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is \"SSL certificate\". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is \"Package Security Identifier\". For MPNS, PlatformPrincipal is \"TLS certificate\". For Baidu, PlatformPrincipal is \"API key\".

For APNS/APNS_SANDBOX, PlatformCredential is \"private key\". For GCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\". For WNS, PlatformCredential is \"secret key\". For MPNS, PlatformCredential is \"private key\". For Baidu, PlatformCredential is \"secret key\". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS.

" }, "CreatePlatformEndpoint":{ "name":"CreatePlatformEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlatformEndpointInput"}, "output":{ "shape":"CreateEndpointResponse", "resultWrapper":"CreatePlatformEndpointResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action 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.

" }, "CreateTopic":{ "name":"CreateTopic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTopicInput"}, "output":{ "shape":"CreateTopicResponse", "resultWrapper":"CreateTopicResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"TopicLimitExceededException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see http://aws.amazon.com/sns. 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":{ "name":"DeleteEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteEndpointInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

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":{ "name":"DeletePlatformApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePlatformApplicationInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "DeleteTopic":{ "name":"DeleteTopic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTopicInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

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.

" }, "GetEndpointAttributes":{ "name":"GetEndpointAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetEndpointAttributesInput"}, "output":{ "shape":"GetEndpointAttributesResponse", "resultWrapper":"GetEndpointAttributesResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "GetPlatformApplicationAttributes":{ "name":"GetPlatformApplicationAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPlatformApplicationAttributesInput"}, "output":{ "shape":"GetPlatformApplicationAttributesResponse", "resultWrapper":"GetPlatformApplicationAttributesResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "GetSMSAttributes":{ "name":"GetSMSAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSMSAttributesInput"}, "output":{ "shape":"GetSMSAttributesResponse", "resultWrapper":"GetSMSAttributesResult" }, "errors":[ {"shape":"ThrottledException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Returns the settings for sending SMS messages from your account.

These settings are set with the SetSMSAttributes action.

" }, "GetSubscriptionAttributes":{ "name":"GetSubscriptionAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSubscriptionAttributesInput"}, "output":{ "shape":"GetSubscriptionAttributesResponse", "resultWrapper":"GetSubscriptionAttributesResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Returns all of the properties of a subscription.

" }, "GetTopicAttributes":{ "name":"GetTopicAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetTopicAttributesInput"}, "output":{ "shape":"GetTopicAttributesResponse", "resultWrapper":"GetTopicAttributesResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

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

" }, "ListEndpointsByPlatformApplication":{ "name":"ListEndpointsByPlatformApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEndpointsByPlatformApplicationInput"}, "output":{ "shape":"ListEndpointsByPlatformApplicationResponse", "resultWrapper":"ListEndpointsByPlatformApplicationResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM 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.

" }, "ListPhoneNumbersOptedOut":{ "name":"ListPhoneNumbersOptedOut", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPhoneNumbersOptedOutInput"}, "output":{ "shape":"ListPhoneNumbersOptedOutResponse", "resultWrapper":"ListPhoneNumbersOptedOutResult" }, "errors":[ {"shape":"ThrottledException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"} ], "documentation":"

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":{ "name":"ListPlatformApplications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPlatformApplicationsInput"}, "output":{ "shape":"ListPlatformApplicationsResponse", "resultWrapper":"ListPlatformApplicationsResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Lists the platform application objects for the supported push notification services, such as APNS and GCM. 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.

" }, "ListSubscriptions":{ "name":"ListSubscriptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSubscriptionsInput"}, "output":{ "shape":"ListSubscriptionsResponse", "resultWrapper":"ListSubscriptionsResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

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.

" }, "ListSubscriptionsByTopic":{ "name":"ListSubscriptionsByTopic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSubscriptionsByTopicInput"}, "output":{ "shape":"ListSubscriptionsByTopicResponse", "resultWrapper":"ListSubscriptionsByTopicResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

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.

" }, "ListTopics":{ "name":"ListTopics", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTopicsInput"}, "output":{ "shape":"ListTopicsResponse", "resultWrapper":"ListTopicsResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

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.

" }, "OptInPhoneNumber":{ "name":"OptInPhoneNumber", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"OptInPhoneNumberInput"}, "output":{ "shape":"OptInPhoneNumberResponse", "resultWrapper":"OptInPhoneNumberResult" }, "errors":[ {"shape":"ThrottledException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"} ], "documentation":"

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":{ "name":"Publish", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PublishInput"}, "output":{ "shape":"PublishResponse", "resultWrapper":"PublishResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"EndpointDisabledException"}, {"shape":"PlatformApplicationDisabledException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol.

To use the Publish action for sending 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.

" }, "RemovePermission":{ "name":"RemovePermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemovePermissionInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

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

" }, "SetEndpointAttributes":{ "name":"SetEndpointAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetEndpointAttributesInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "SetPlatformApplicationAttributes":{ "name":"SetPlatformApplicationAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetPlatformApplicationAttributesInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. 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":{ "name":"SetSMSAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetSMSAttributesInput"}, "output":{ "shape":"SetSMSAttributesResponse", "resultWrapper":"SetSMSAttributesResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ThrottledException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

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 Sending an SMS Message in the Amazon SNS Developer Guide.

" }, "SetSubscriptionAttributes":{ "name":"SetSubscriptionAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetSubscriptionAttributesInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

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

" }, "SetTopicAttributes":{ "name":"SetTopicAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetTopicAttributesInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

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

" }, "Subscribe":{ "name":"Subscribe", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SubscribeInput"}, "output":{ "shape":"SubscribeResponse", "resultWrapper":"SubscribeResult" }, "errors":[ {"shape":"SubscriptionLimitExceededException"}, {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.

" }, "Unsubscribe":{ "name":"Unsubscribe", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnsubscribeInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

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

" } }, "shapes":{ "ActionsList":{ "type":"list", "member":{"shape":"action"} }, "AddPermissionInput":{ "type":"structure", "required":[ "TopicArn", "Label", "AWSAccountId", "ActionName" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

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

" }, "Label":{ "shape":"label", "documentation":"

A unique identifier for the new policy statement.

" }, "AWSAccountId":{ "shape":"DelegatesList", "documentation":"

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

" }, "ActionName":{ "shape":"ActionsList", "documentation":"

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

Valid values: any Amazon SNS action name.

" } } }, "AuthorizationErrorException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"AuthorizationError", "httpStatusCode":403, "senderFault":true }, "exception":true }, "Binary":{"type":"blob"}, "CheckIfPhoneNumberIsOptedOutInput":{ "type":"structure", "required":["phoneNumber"], "members":{ "phoneNumber":{ "shape":"PhoneNumber", "documentation":"

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

" } }, "documentation":"

The input for the CheckIfPhoneNumberIsOptedOut action.

" }, "CheckIfPhoneNumberIsOptedOutResponse":{ "type":"structure", "members":{ "isOptedOut":{ "shape":"boolean", "documentation":"

Indicates whether the phone number is opted out:

" } }, "documentation":"

The response from the CheckIfPhoneNumberIsOptedOut action.

" }, "ConfirmSubscriptionInput":{ "type":"structure", "required":[ "TopicArn", "Token" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

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

" }, "Token":{ "shape":"token", "documentation":"

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

" }, "AuthenticateOnUnsubscribe":{ "shape":"authenticateOnUnsubscribe", "documentation":"

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

" } }, "documentation":"

Input for ConfirmSubscription action.

" }, "ConfirmSubscriptionResponse":{ "type":"structure", "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The ARN of the created subscription.

" } }, "documentation":"

Response for ConfirmSubscriptions action.

" }, "CreateEndpointResponse":{ "type":"structure", "members":{ "EndpointArn":{ "shape":"String", "documentation":"

EndpointArn returned from CreateEndpoint action.

" } }, "documentation":"

Response from CreateEndpoint action.

" }, "CreatePlatformApplicationInput":{ "type":"structure", "required":[ "Name", "Platform", "Attributes" ], "members":{ "Name":{ "shape":"String", "documentation":"

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.

" }, "Platform":{ "shape":"String", "documentation":"

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

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

For a list of attributes, see SetPlatformApplicationAttributes

" } }, "documentation":"

Input for CreatePlatformApplication action.

" }, "CreatePlatformApplicationResponse":{ "type":"structure", "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn is returned.

" } }, "documentation":"

Response from CreatePlatformApplication action.

" }, "CreatePlatformEndpointInput":{ "type":"structure", "required":[ "PlatformApplicationArn", "Token" ], "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

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

" }, "Token":{ "shape":"String", "documentation":"

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 or ADM, the device token equivalent is called the registration ID.

" }, "CustomUserData":{ "shape":"String", "documentation":"

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.

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

For a list of attributes, see SetEndpointAttributes.

" } }, "documentation":"

Input for CreatePlatformEndpoint action.

" }, "CreateTopicInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"topicName", "documentation":"

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.

" } }, "documentation":"

Input for CreateTopic action.

" }, "CreateTopicResponse":{ "type":"structure", "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

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

" } }, "documentation":"

Response from CreateTopic action.

" }, "DelegatesList":{ "type":"list", "member":{"shape":"delegate"} }, "DeleteEndpointInput":{ "type":"structure", "required":["EndpointArn"], "members":{ "EndpointArn":{ "shape":"String", "documentation":"

EndpointArn of endpoint to delete.

" } }, "documentation":"

Input for DeleteEndpoint action.

" }, "DeletePlatformApplicationInput":{ "type":"structure", "required":["PlatformApplicationArn"], "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn of platform application object to delete.

" } }, "documentation":"

Input for DeletePlatformApplication action.

" }, "DeleteTopicInput":{ "type":"structure", "required":["TopicArn"], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic you want to delete.

" } } }, "Endpoint":{ "type":"structure", "members":{ "EndpointArn":{ "shape":"String", "documentation":"

EndpointArn for mobile app and device.

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

Attributes for endpoint.

" } }, "documentation":"

Endpoint for mobile app and device.

" }, "EndpointDisabledException":{ "type":"structure", "members":{ "message":{ "shape":"string", "documentation":"

Message for endpoint disabled.

" } }, "documentation":"

Exception error indicating endpoint disabled.

", "error":{ "code":"EndpointDisabled", "httpStatusCode":400, "senderFault":true }, "exception":true }, "GetEndpointAttributesInput":{ "type":"structure", "required":["EndpointArn"], "members":{ "EndpointArn":{ "shape":"String", "documentation":"

EndpointArn for GetEndpointAttributes input.

" } }, "documentation":"

Input for GetEndpointAttributes action.

" }, "GetEndpointAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"MapStringToString", "documentation":"

Attributes include the following:

" } }, "documentation":"

Response from GetEndpointAttributes of the EndpointArn.

" }, "GetPlatformApplicationAttributesInput":{ "type":"structure", "required":["PlatformApplicationArn"], "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn for GetPlatformApplicationAttributesInput.

" } }, "documentation":"

Input for GetPlatformApplicationAttributes action.

" }, "GetPlatformApplicationAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"MapStringToString", "documentation":"

Attributes include the following:

" } }, "documentation":"

Response for GetPlatformApplicationAttributes action.

" }, "GetSMSAttributesInput":{ "type":"structure", "members":{ "attributes":{ "shape":"ListString", "documentation":"

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.

" } }, "documentation":"

The input for the GetSMSAttributes request.

" }, "GetSMSAttributesResponse":{ "type":"structure", "members":{ "attributes":{ "shape":"MapStringToString", "documentation":"

The SMS attribute names and their values.

" } }, "documentation":"

The response from the GetSMSAttributes request.

" }, "GetSubscriptionAttributesInput":{ "type":"structure", "required":["SubscriptionArn"], "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

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

" } }, "documentation":"

Input for GetSubscriptionAttributes.

" }, "GetSubscriptionAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"SubscriptionAttributesMap", "documentation":"

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

" } }, "documentation":"

Response for GetSubscriptionAttributes action.

" }, "GetTopicAttributesInput":{ "type":"structure", "required":["TopicArn"], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

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

" } }, "documentation":"

Input for GetTopicAttributes action.

" }, "GetTopicAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"TopicAttributesMap", "documentation":"

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

" } }, "documentation":"

Response for GetTopicAttributes action.

" }, "InternalErrorException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

Indicates an internal service error.

", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true }, "InvalidParameterException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidParameterValueException":{ "type":"structure", "members":{ "message":{ "shape":"string", "documentation":"

The parameter value is invalid.

" } }, "documentation":"

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

", "error":{ "code":"ParameterValueInvalid", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ListEndpointsByPlatformApplicationInput":{ "type":"structure", "required":["PlatformApplicationArn"], "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

" }, "NextToken":{ "shape":"String", "documentation":"

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

" } }, "documentation":"

Input for ListEndpointsByPlatformApplication action.

" }, "ListEndpointsByPlatformApplicationResponse":{ "type":"structure", "members":{ "Endpoints":{ "shape":"ListOfEndpoints", "documentation":"

Endpoints returned for ListEndpointsByPlatformApplication action.

" }, "NextToken":{ "shape":"String", "documentation":"

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

" } }, "documentation":"

Response for ListEndpointsByPlatformApplication action.

" }, "ListOfEndpoints":{ "type":"list", "member":{"shape":"Endpoint"} }, "ListOfPlatformApplications":{ "type":"list", "member":{"shape":"PlatformApplication"} }, "ListPhoneNumbersOptedOutInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"string", "documentation":"

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

" } }, "documentation":"

The input for the ListPhoneNumbersOptedOut action.

" }, "ListPhoneNumbersOptedOutResponse":{ "type":"structure", "members":{ "phoneNumbers":{ "shape":"PhoneNumberList", "documentation":"

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.

" }, "nextToken":{ "shape":"string", "documentation":"

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

" } }, "documentation":"

The response from the ListPhoneNumbersOptedOut action.

" }, "ListPlatformApplicationsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

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

" } }, "documentation":"

Input for ListPlatformApplications action.

" }, "ListPlatformApplicationsResponse":{ "type":"structure", "members":{ "PlatformApplications":{ "shape":"ListOfPlatformApplications", "documentation":"

Platform applications returned when calling ListPlatformApplications action.

" }, "NextToken":{ "shape":"String", "documentation":"

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

" } }, "documentation":"

Response for ListPlatformApplications action.

" }, "ListString":{ "type":"list", "member":{"shape":"String"} }, "ListSubscriptionsByTopicInput":{ "type":"structure", "required":["TopicArn"], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

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

" }, "NextToken":{ "shape":"nextToken", "documentation":"

Token returned by the previous ListSubscriptionsByTopic request.

" } }, "documentation":"

Input for ListSubscriptionsByTopic action.

" }, "ListSubscriptionsByTopicResponse":{ "type":"structure", "members":{ "Subscriptions":{ "shape":"SubscriptionsList", "documentation":"

A list of subscriptions.

" }, "NextToken":{ "shape":"nextToken", "documentation":"

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

" } }, "documentation":"

Response for ListSubscriptionsByTopic action.

" }, "ListSubscriptionsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"nextToken", "documentation":"

Token returned by the previous ListSubscriptions request.

" } }, "documentation":"

Input for ListSubscriptions action.

" }, "ListSubscriptionsResponse":{ "type":"structure", "members":{ "Subscriptions":{ "shape":"SubscriptionsList", "documentation":"

A list of subscriptions.

" }, "NextToken":{ "shape":"nextToken", "documentation":"

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

" } }, "documentation":"

Response for ListSubscriptions action

" }, "ListTopicsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"nextToken", "documentation":"

Token returned by the previous ListTopics request.

" } } }, "ListTopicsResponse":{ "type":"structure", "members":{ "Topics":{ "shape":"TopicsList", "documentation":"

A list of topic ARNs.

" }, "NextToken":{ "shape":"nextToken", "documentation":"

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

" } }, "documentation":"

Response for ListTopics action.

" }, "MapStringToString":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "MessageAttributeMap":{ "type":"map", "key":{ "shape":"String", "locationName":"Name" }, "value":{ "shape":"MessageAttributeValue", "locationName":"Value" } }, "MessageAttributeValue":{ "type":"structure", "required":["DataType"], "members":{ "DataType":{ "shape":"String", "documentation":"

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

" }, "StringValue":{ "shape":"String", "documentation":"

Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

" }, "BinaryValue":{ "shape":"Binary", "documentation":"

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

" } }, "documentation":"

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 Using Amazon SNS Message Attributes.

" }, "NotFoundException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

Indicates that the requested resource does not exist.

", "error":{ "code":"NotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "OptInPhoneNumberInput":{ "type":"structure", "required":["phoneNumber"], "members":{ "phoneNumber":{ "shape":"PhoneNumber", "documentation":"

The phone number to opt in.

" } }, "documentation":"

Input for the OptInPhoneNumber action.

" }, "OptInPhoneNumberResponse":{ "type":"structure", "members":{ }, "documentation":"

The response for the OptInPhoneNumber action.

" }, "PhoneNumber":{"type":"string"}, "PhoneNumberList":{ "type":"list", "member":{"shape":"PhoneNumber"} }, "PlatformApplication":{ "type":"structure", "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn for platform application object.

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

Attributes for platform application object.

" } }, "documentation":"

Platform application object.

" }, "PlatformApplicationDisabledException":{ "type":"structure", "members":{ "message":{ "shape":"string", "documentation":"

Message for platform application disabled.

" } }, "documentation":"

Exception error indicating platform application disabled.

", "error":{ "code":"PlatformApplicationDisabled", "httpStatusCode":400, "senderFault":true }, "exception":true }, "PublishInput":{ "type":"structure", "required":["Message"], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

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.

" }, "TargetArn":{ "shape":"String", "documentation":"

Either TopicArn or EndpointArn, but not both.

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

" }, "PhoneNumber":{ "shape":"String", "documentation":"

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.

" }, "Message":{ "shape":"message", "documentation":"

The message you want to send to the topic.

If 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: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).

JSON-specific constraints:

" }, "Subject":{ "shape":"subject", "documentation":"

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.

" }, "MessageStructure":{ "shape":"messageStructure", "documentation":"

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

For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.

Valid value: json

" }, "MessageAttributes":{ "shape":"MessageAttributeMap", "documentation":"

Message attributes for Publish action.

" } }, "documentation":"

Input for Publish action.

" }, "PublishResponse":{ "type":"structure", "members":{ "MessageId":{ "shape":"messageId", "documentation":"

Unique identifier assigned to the published message.

Length Constraint: Maximum 100 characters

" } }, "documentation":"

Response for Publish action.

" }, "RemovePermissionInput":{ "type":"structure", "required":[ "TopicArn", "Label" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

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

" }, "Label":{ "shape":"label", "documentation":"

The unique label of the statement you want to remove.

" } }, "documentation":"

Input for RemovePermission action.

" }, "SetEndpointAttributesInput":{ "type":"structure", "required":[ "EndpointArn", "Attributes" ], "members":{ "EndpointArn":{ "shape":"String", "documentation":"

EndpointArn used for SetEndpointAttributes action.

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

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

" } }, "documentation":"

Input for SetEndpointAttributes action.

" }, "SetPlatformApplicationAttributesInput":{ "type":"structure", "required":[ "PlatformApplicationArn", "Attributes" ], "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn for SetPlatformApplicationAttributes action.

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

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

" } }, "documentation":"

Input for SetPlatformApplicationAttributes action.

" }, "SetSMSAttributesInput":{ "type":"structure", "required":["attributes"], "members":{ "attributes":{ "shape":"MapStringToString", "documentation":"

The default settings for sending SMS messages from your 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 exceed the maximum, contact AWS Support or your AWS sales representative for a service 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 account:

To receive the report, the bucket must have a policy that allows the Amazon SNS service principle 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.

" } }, "documentation":"

The input for the SetSMSAttributes action.

" }, "SetSMSAttributesResponse":{ "type":"structure", "members":{ }, "documentation":"

The response for the SetSMSAttributes action.

" }, "SetSubscriptionAttributesInput":{ "type":"structure", "required":[ "SubscriptionArn", "AttributeName" ], "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The ARN of the subscription to modify.

" }, "AttributeName":{ "shape":"attributeName", "documentation":"

The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.

Valid values: DeliveryPolicy | RawMessageDelivery

" }, "AttributeValue":{ "shape":"attributeValue", "documentation":"

The new value for the attribute in JSON format.

" } }, "documentation":"

Input for SetSubscriptionAttributes action.

" }, "SetTopicAttributesInput":{ "type":"structure", "required":[ "TopicArn", "AttributeName" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic to modify.

" }, "AttributeName":{ "shape":"attributeName", "documentation":"

The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.

Valid values: Policy | DisplayName | DeliveryPolicy

" }, "AttributeValue":{ "shape":"attributeValue", "documentation":"

The new value for the attribute.

" } }, "documentation":"

Input for SetTopicAttributes action.

" }, "String":{"type":"string"}, "SubscribeInput":{ "type":"structure", "required":[ "TopicArn", "Protocol" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic you want to subscribe to.

" }, "Protocol":{ "shape":"protocol", "documentation":"

The protocol you want to use. Supported protocols include:

" }, "Endpoint":{ "shape":"endpoint", "documentation":"

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

" } }, "documentation":"

Input for Subscribe action.

" }, "SubscribeResponse":{ "type":"structure", "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).

" } }, "documentation":"

Response for Subscribe action.

" }, "Subscription":{ "type":"structure", "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The subscription's ARN.

" }, "Owner":{ "shape":"account", "documentation":"

The subscription's owner.

" }, "Protocol":{ "shape":"protocol", "documentation":"

The subscription's protocol.

" }, "Endpoint":{ "shape":"endpoint", "documentation":"

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

" }, "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the subscription's topic.

" } }, "documentation":"

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

" }, "SubscriptionAttributesMap":{ "type":"map", "key":{"shape":"attributeName"}, "value":{"shape":"attributeValue"} }, "SubscriptionLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"SubscriptionLimitExceeded", "httpStatusCode":403, "senderFault":true }, "exception":true }, "SubscriptionsList":{ "type":"list", "member":{"shape":"Subscription"} }, "ThrottledException":{ "type":"structure", "members":{ "message":{ "shape":"string", "documentation":"

Throttled request.

" } }, "documentation":"

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

", "error":{ "code":"Throttled", "httpStatusCode":429, "senderFault":true }, "exception":true }, "Topic":{ "type":"structure", "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The topic's ARN.

" } }, "documentation":"

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

" }, "TopicAttributesMap":{ "type":"map", "key":{"shape":"attributeName"}, "value":{"shape":"attributeValue"} }, "TopicLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

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

", "error":{ "code":"TopicLimitExceeded", "httpStatusCode":403, "senderFault":true }, "exception":true }, "TopicsList":{ "type":"list", "member":{"shape":"Topic"} }, "UnsubscribeInput":{ "type":"structure", "required":["SubscriptionArn"], "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The ARN of the subscription to be deleted.

" } }, "documentation":"

Input for Unsubscribe action.

" }, "account":{"type":"string"}, "action":{"type":"string"}, "attributeName":{"type":"string"}, "attributeValue":{"type":"string"}, "authenticateOnUnsubscribe":{"type":"string"}, "boolean":{"type":"boolean"}, "delegate":{"type":"string"}, "endpoint":{"type":"string"}, "label":{"type":"string"}, "message":{"type":"string"}, "messageId":{"type":"string"}, "messageStructure":{"type":"string"}, "nextToken":{"type":"string"}, "protocol":{"type":"string"}, "string":{"type":"string"}, "subject":{"type":"string"}, "subscriptionARN":{"type":"string"}, "token":{"type":"string"}, "topicARN":{"type":"string"}, "topicName":{"type":"string"} }, "documentation":"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 http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see 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.

" }