# Amazon Simple Notification Service API

> Amazon Simple Notification Service API on Apizie: 42 endpoints (Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services…, Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from…, Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an…, Creates a platform application object for one of the supported push notification services, such as APNS and…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-sns/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-sns`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-sns
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-sns/openapi.json

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…

## Endpoints

### Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-add-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| TopicArn | string | yes | The ARN of the topic whose access control policy you wish to modify. |
| Label | string | yes | A unique identifier for the new policy statement. |
| AWSAccountId | array | yes | The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have… |
| ActionName | array | yes | The action you want to allow for the specified principal(s). Valid values: Any Amazon SNS action name, for example Publish . |

### Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-check-if-phone-number-is-opted-out` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| phoneNumber | string | yes | The phone number for which you want to check the opt out status. |

### Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-confirm-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| TopicArn | string | yes | The ARN of the topic for which you wish to confirm a subscription. |
| Token | string | yes | Short-lived token sent to an endpoint during the Subscribe action. |
| AuthenticateOnUnsubscribe | string | no | Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web… |

### Creates a platform application object for one of the supported push notification services, such as APNS and…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-create-platform-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Name | string | yes | Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be… |
| Platform | string | yes | The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM… |
| Attributes | object | yes | For a list of attributes, see SetPlatformApplicationAttributes . |

### Creates an endpoint for a device and mobile app on one of the supported push notification services, such as…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-create-platform-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PlatformApplicationArn | string | yes | PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint. |
| Token | string | yes | Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which… |
| CustomUserData | string | no | 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 | object | no | For a list of attributes, see SetEndpointAttributes . |

### Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-create-smssandbox-phone-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PhoneNumber | string | yes | The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you… |
| LanguageCode | string | no | The language to use for sending the OTP. The default value is en-US . |

### Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-create-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Name | string | yes | The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers,… |
| Attributes | object | no | A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request… |
| Tags | array | no | 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… |
| DataProtectionPolicy | string | no | 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… |

### Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-delete-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| EndpointArn | string | yes | EndpointArn of endpoint to delete. |

### Deletes a platform application object for one of the supported push notification services, such as APNS and…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-delete-platform-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PlatformApplicationArn | string | yes | PlatformApplicationArn of platform application object to delete. |

### Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox. When you…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-delete-smssandbox-phone-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PhoneNumber | string | yes | The destination phone number to delete. |

### Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-delete-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| TopicArn | string | yes | The ARN of the topic you want to delete. |

### Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-get-data-protection-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ResourceArn | string | yes | The ARN of the topic whose DataProtectionPolicy you want to get. For more information about ARNs, see Amazon Resource Names (ARNs) in the… |

### Retrieves the endpoint attributes for a device on one of the supported push notification services, such as…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-get-endpoint-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| EndpointArn | string | yes | EndpointArn for GetEndpointAttributes input. |

### Retrieves the attributes of the platform application object for the supported push notification services,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-get-platform-application-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PlatformApplicationArn | string | yes | PlatformApplicationArn for GetPlatformApplicationAttributesInput. |

### Returns the settings for sending SMS messages from your Amazon Web Services account. These settings are set…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-get-smsattributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| attributes | array | no | A list of the individual attribute names, such as MonthlySpendLimit , for which you want values. For all attribute names, see… |

### Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-get-smssandbox-account-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |

### Returns all of the properties of a subscription.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-get-subscription-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| SubscriptionArn | string | yes | The ARN of the subscription whose properties you want to get. |

### Returns all of the properties of a topic. Topic properties returned might differ based on the authorization…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-get-topic-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| TopicArn | string | yes | The ARN of the topic whose properties you want to get. |

### Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-list-endpoints-by-platform-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PlatformApplicationArn | string | yes | PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action. |
| NextToken | string | no | NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after… |

### Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-list-origination-numbers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| NextToken | string | no | Token that the previous ListOriginationNumbers request returns. |
| MaxResults | integer | no | The maximum number of origination numbers to return. |

### Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them. The…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-list-phone-numbers-opted-out` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the… |

### Lists the platform application objects for the supported push notification services, such as APNS and GCM…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-list-platform-applications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| NextToken | string | no | NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first… |

### Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-list-smssandbox-phone-numbers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| NextToken | string | no | Token that the previous ListSMSSandboxPhoneNumbersInput request returns. |
| MaxResults | integer | no | The maximum number of phone numbers to return. |

### Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-list-subscriptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| NextToken | string | no | Token returned by the previous ListSubscriptions request. |

### Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-list-subscriptions-by-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| TopicArn | string | yes | The ARN of the topic for which you wish to find subscriptions. |
| NextToken | string | no | Token returned by the previous ListSubscriptionsByTopic request. |

### List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ResourceArn | string | yes | The ARN of the topic for which to list tags. |

### Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-list-topics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| NextToken | string | no | Token returned by the previous ListTopics request. |

### Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-opt-in-phone-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| phoneNumber | string | yes | The phone number to opt in. Use E.164 format. |

### Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-publish` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| TopicArn | string | no | 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 | string | no | If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters. |
| PhoneNumber | string | no | 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… |
| Message | string | yes | 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… |
| Subject | string | no | Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if… |
| MessageStructure | string | no | Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can… |
| MessageAttributes | object | no | Message attributes for Publish action. |
| MessageDeduplicationId | string | no | This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can contain up to 128 alphanumeric characters… |
| MessageGroupId | string | no | This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z,… |

### Publishes up to ten messages to the specified topic. This is a batch version of Publish . For FIFO topics,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-publish-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| TopicArn | string | yes | The Amazon resource name (ARN) of the topic you want to batch publish to. |
| PublishBatchRequestEntries | array | yes | A list of PublishBatch request entries to be sent to the SNS topic. |

### Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-put-data-protection-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ResourceArn | string | yes | The ARN of the topic whose DataProtectionPolicy you want to add or update. For more information about ARNs, see Amazon Resource Names… |
| DataProtectionPolicy | string | yes | The JSON serialization of the topic's DataProtectionPolicy . The DataProtectionPolicy must be in JSON string format. Length Constraints:… |

### Removes a statement from a topic's access control policy. To remove the ability to change topic permissions,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-remove-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| TopicArn | string | yes | The ARN of the topic whose access control policy you wish to modify. |
| Label | string | yes | The unique label of the statement you want to remove. |

### Sets the attributes for an endpoint for a device on one of the supported push notification services, such as…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-set-endpoint-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| EndpointArn | string | yes | EndpointArn used for SetEndpointAttributes action. |
| Attributes | object | yes | A map of the endpoint attributes. Attributes in this map include the following: CustomUserData – arbitrary user data to associate with the… |

### Sets the attributes of the platform application object for the supported push notification services, such as…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-set-platform-application-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PlatformApplicationArn | string | yes | PlatformApplicationArn for SetPlatformApplicationAttributes action. |
| Attributes | object | yes | A map of the platform application attributes. Attributes in this map include the following: PlatformCredential – The credential received… |

### Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-set-smsattributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| attributes | object | yes | The default settings for sending SMS messages from your Amazon Web Services account. You can set values for the following attribute names:… |

### Allows a subscription owner to set an attribute of the subscription to a new value.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-set-subscription-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| SubscriptionArn | string | yes | The ARN of the subscription to modify. |
| AttributeName | string | yes | A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request… |
| AttributeValue | string | no | The new value for the attribute in JSON format. |

### Allows a topic owner to set an attribute of the topic to a new value. To remove the ability to change topic…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-set-topic-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| TopicArn | string | yes | The ARN of the topic to modify. |
| AttributeName | string | yes | A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request… |
| AttributeValue | string | no | The new value for the attribute. |

### Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-subscribe` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| TopicArn | string | yes | The ARN of the topic you want to subscribe to. |
| Protocol | string | yes | The protocol that you want to use. Supported protocols include: http – delivery of JSON-encoded message via HTTP POST https – delivery of… |
| Endpoint | string | no | The endpoint that you want to receive notifications. Endpoints vary by protocol: For the http protocol, the (public) endpoint is a URL… |
| Attributes | object | no | A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request… |
| ReturnSubscriptionArn | boolean | no | Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed. If you… |

### Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ResourceArn | string | yes | The ARN of the topic to which to add tags. |
| Tags | array | yes | The tags to be added to the specified topic. A tag consists of a required key and an optional value. |

### Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-unsubscribe` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| SubscriptionArn | string | yes | The ARN of the subscription to be deleted. |

### Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ResourceArn | string | yes | The ARN of the topic from which to remove tags. |
| TagKeys | array | yes | The list of tag keys to remove from the specified topic. |

### Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-verify-smssandbox-phone-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PhoneNumber | string | yes | The destination phone number to verify. |
| OneTimePassword | string | yes | The OTP sent to the destination number from the CreateSMSSandBoxPhoneNumber call. |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-add-permission" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Amazon Simple Notification Service API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:amazonaws-sns/get-add-permission with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Amazon Simple Notification Service API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon Simple Notification Service itself also needs your own key from amazonaws.com.

### Can AI agents use the Amazon Simple Notification Service API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-sns.

### What is the status of the Amazon Simple Notification Service API?
Needs your own provider key (bring your own key)