Amazon SNS

opencollection: 1.0.0
info:
  name: Amazon SNS Amazon Simple Notification Service (SNS) API
  version: '2010-03-31'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Topics
    type: folder
  items:
  - info:
      name: Amazon Sns Create a New Sns Topic
      type: http
    http:
      method: POST
      url: https://sns.{region}.amazonaws.com/?Action=CreateTopic
      headers:
      - name: Content-Type
        value: ''
      body:
        type: form-urlencoded
        data:
        - name: Name
          value: ''
        - name: Attributes
          value: ''
        - name: Tags
          value: ''
        - name: DataProtectionPolicy
          value: ''
    docs: Creates a new SNS topic to which notifications can be published. Topics can be standard or FIFO. Returns the TopicArn
      of the newly created topic. If a topic with the same name already exists, this action returns the TopicArn of the existing
      topic.
  - info:
      name: Amazon Sns Delete an Sns Topic
      type: http
    http:
      method: POST
      url: https://sns.{region}.amazonaws.com/?Action=DeleteTopic
      body:
        type: form-urlencoded
        data:
        - name: TopicArn
          value: ''
    docs: 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.
  - info:
      name: Amazon Sns List All Sns Topics
      type: http
    http:
      method: GET
      url: https://sns.{region}.amazonaws.com/?Action=ListTopics
      params:
      - name: NextToken
        value: ''
        type: query
        description: Token returned by the previous ListTopics request for pagination
    docs: 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.
  - info:
      name: Amazon Sns Get Attributes of an Sns Topic
      type: http
    http:
      method: GET
      url: https://sns.{region}.amazonaws.com/?Action=GetTopicAttributes
      params:
      - name: TopicArn
        value: ''
        type: query
        description: The ARN of the topic whose properties you want to get
    docs: Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the
      user.
  - info:
      name: Amazon Sns Set Attributes on an Sns Topic
      type: http
    http:
      method: POST
      url: https://sns.{region}.amazonaws.com/?Action=SetTopicAttributes
      body:
        type: form-urlencoded
        data:
        - name: TopicArn
          value: ''
        - name: AttributeName
          value: ''
        - name: AttributeValue
          value: ''
    docs: Allows a topic owner to set an attribute of the topic to a new value. Only one attribute can be changed per call.
- info:
    name: Subscriptions
    type: folder
  items:
  - info:
      name: Amazon Sns Subscribe an Endpoint to an Sns Topic
      type: http
    http:
      method: POST
      url: https://sns.{region}.amazonaws.com/?Action=Subscribe
      body:
        type: form-urlencoded
        data:
        - name: TopicArn
          value: ''
        - name: Protocol
          value: ''
        - name: Endpoint
          value: ''
        - name: Attributes
          value: ''
        - name: ReturnSubscriptionArn
          value: ''
    docs: 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 AWS account, the endpoint owner must run the ConfirmSubscription action to confirm the subscription.
      The subscription request is returned with a pending confirmation status.
  - info:
      name: Amazon Sns Confirm a Pending Subscription
      type: http
    http:
      method: POST
      url: https://sns.{region}.amazonaws.com/?Action=ConfirmSubscription
      body:
        type: form-urlencoded
        data:
        - name: TopicArn
          value: ''
        - name: Token
          value: ''
        - name: AuthenticateOnUnsubscribe
          value: ''
    docs: 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).
  - info:
      name: Amazon Sns Unsubscribe From an Sns Topic
      type: http
    http:
      method: POST
      url: https://sns.{region}.amazonaws.com/?Action=Unsubscribe
      body:
        type: form-urlencoded
        data:
        - name: SubscriptionArn
          value: ''
    docs: 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.
  - info:
      name: Amazon Sns List All Subscriptions
      type: http
    http:
      method: GET
      url: https://sns.{region}.amazonaws.com/?Action=ListSubscriptions
      params:
      - name: NextToken
        value: ''
        type: query
        description: Token returned by the previous request for pagination
    docs: 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.
  - info:
      name: Amazon Sns List Subscriptions for a Specific Topic
      type: http
    http:
      method: GET
      url: https://sns.{region}.amazonaws.com/?Action=ListSubscriptionsByTopic
      params:
      - name: TopicArn
        value: ''
        type: query
        description: The ARN of the topic for which you wish to list subscriptions
      - name: NextToken
        value: ''
        type: query
        description: Token returned by the previous request for pagination
    docs: 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.
  - info:
      name: Amazon Sns Get Attributes of a Subscription
      type: http
    http:
      method: GET
      url: https://sns.{region}.amazonaws.com/?Action=GetSubscriptionAttributes
      params:
      - name: SubscriptionArn
        value: ''
        type: query
        description: The ARN of the subscription whose properties you want to get
    docs: Returns all of the properties of a subscription.
  - info:
      name: Amazon Sns Set Attributes on a Subscription
      type: http
    http:
      method: POST
      url: https://sns.{region}.amazonaws.com/?Action=SetSubscriptionAttributes
      body:
        type: form-urlencoded
        data:
        - name: SubscriptionArn
          value: ''
        - name: AttributeName
          value: ''
        - name: AttributeValue
          value: ''
    docs: Allows a subscription owner to set an attribute of the subscription to a new value.
- info:
    name: Publishing
    type: folder
  items:
  - info:
      name: Amazon Sns Publish a Message to an Sns Topic or Endpoint
      type: http
    http:
      method: POST
      url: https://sns.{region}.amazonaws.com/?Action=Publish
      body:
        type: form-urlencoded
        data:
        - name: TopicArn
          value: ''
        - name: TargetArn
          value: ''
        - name: PhoneNumber
          value: ''
        - name: Message
          value: ''
        - name: Subject
          value: ''
        - name: MessageStructure
          value: ''
        - name: MessageAttributes
          value: ''
        - name: MessageDeduplicationId
          value: ''
        - name: MessageGroupId
          value: ''
    docs: Sends a message to an Amazon SNS topic, a text message (SMS) directly to a phone number, or a message to a platform
      application endpoint. When you publish to a topic, SNS delivers the message to each subscribing endpoint. You can send
      different messages for each transport protocol by using the MessageStructure parameter.
  - info:
      name: Amazon Sns Publish up to 10 Messages to an Sns Topic in a Single Request
      type: http
    http:
      method: POST
      url: https://sns.{region}.amazonaws.com/?Action=PublishBatch
      body:
        type: form-urlencoded
        data:
        - name: TopicArn
          value: ''
        - name: PublishBatchRequestEntries
          value: ''
    docs: Publishes up to ten messages to the specified topic in a single API call. This action is useful for reducing the
      cost of publishing messages. The total aggregate size of all messages in a single PublishBatch call cannot exceed 262,144
      bytes.
- info:
    name: Default
    type: folder
  items:
  - info:
      name: Amazon Sns Add Tags to an Sns Topic
      type: http
    http:
      method: POST
      url: https://sns.{region}.amazonaws.com/?Action=TagResource
      body:
        type: form-urlencoded
        data:
        - name: ResourceArn
          value: ''
        - name: Tags
          value: ''
    docs: Add tags to the specified Amazon SNS topic. Tags are key-value pairs that can be used to organize and categorize
      resources. When a topic is tagged, existing tags with the same key are overwritten with the new value.
  - info:
      name: Amazon Sns Remove Tags From an Sns Topic
      type: http
    http:
      method: POST
      url: https://sns.{region}.amazonaws.com/?Action=UntagResource
      body:
        type: form-urlencoded
        data:
        - name: ResourceArn
          value: ''
        - name: TagKeys
          value: ''
    docs: Remove tags from the specified Amazon SNS topic.
  - info:
      name: Amazon Sns List Tags for an Sns Topic
      type: http
    http:
      method: GET
      url: https://sns.{region}.amazonaws.com/?Action=ListTagsForResource
      params:
      - name: ResourceArn
        value: ''
        type: query
        description: The ARN of the topic to list tags for
    docs: List all tags added to the specified Amazon SNS topic. Returns key-value pairs associated with the resource.
- info:
    name: Platform Applications
    type: folder
  items:
  - info:
      name: Amazon Sns Create a Platform Application for Push Notifications
      type: http
    http:
      method: POST
      url: https://sns.{region}.amazonaws.com/?Action=CreatePlatformApplication
      body:
        type: form-urlencoded
        data:
        - name: Name
          value: ''
        - name: Platform
          value: ''
        - name: Attributes
          value: ''
    docs: Creates a platform application object for one of the supported push notification services, such as APNs and FCM
      (Firebase Cloud Messaging), to which devices and mobile apps may register.
- info:
    name: SMS
    type: folder
  items:
  - info:
      name: Amazon Sns Get Sms Messaging Attributes
      type: http
    http:
      method: GET
      url: https://sns.{region}.amazonaws.com/?Action=GetSMSAttributes
      params:
      - name: attributes
        value: ''
        type: query
        description: A list of attribute names to return. If omitted, all attributes are returned.
    docs: Returns the settings for sending SMS messages from your AWS account. These attributes include the default sender
      ID, monthly spending limit, and delivery status logging settings.
  - info:
      name: Amazon Sns Check if a Phone Number Has Opted Out of Sms
      type: http
    http:
      method: GET
      url: https://sns.{region}.amazonaws.com/?Action=CheckIfPhoneNumberIsOptedOut
      params:
      - name: phoneNumber
        value: ''
        type: query
        description: The phone number to check in E.164 format
    docs: Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your
      AWS account. You cannot send SMS messages to a number that is opted out.
bundled: true