openapi: 3.2.0
info:
  title: Amazon SNS Amazon Simple Notification Service (SNS) API
  version: '2010-03-31'
  description: Amazon Simple Notification Service (SNS) is a fully managed pub/sub messaging service that enables application-to-application (A2A) and application-to-person (A2P) communication.
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/sns/
  termsOfService: https://aws.amazon.com/service-terms/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://sns.{region}.amazonaws.com
  description: Amazon SNS regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-north-1
      - ap-southeast-1
      - ap-southeast-2
      - ap-northeast-1
      - ap-northeast-2
      - ap-south-1
      - sa-east-1
      - ca-central-1
security:
- AWS_IAM: []
tags:
- name: Amazon SNS Amazon Simple Notification Service (SNS) API
paths:
  /?Action=TagResource:
    post:
      tags:
      - Amazon SNS Amazon Simple Notification Service (SNS) API
      operationId: tagResource
      summary: Amazon Sns Add Tags to an Sns Topic
      description: 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.
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - ResourceArn
              - Tags
              properties:
                ResourceArn:
                  type: string
                  description: The ARN of the topic to tag
                Tags:
                  type: array
                  description: The tags to add to the topic
                  items:
                    $ref: '#/components/schemas/Tag'
      responses:
        '200':
          description: Tags added successfully
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/TagResourceResponse'
        '400':
          $ref: '#/components/responses/InvalidParameter'
        '403':
          $ref: '#/components/responses/AuthorizationError'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=UntagResource:
    post:
      tags:
      - Amazon SNS Amazon Simple Notification Service (SNS) API
      operationId: untagResource
      summary: Amazon Sns Remove Tags From an Sns Topic
      description: Remove tags from the specified Amazon SNS topic.
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - ResourceArn
              - TagKeys
              properties:
                ResourceArn:
                  type: string
                  description: The ARN of the topic to remove tags from
                TagKeys:
                  type: array
                  description: The list of tag keys to remove
                  items:
                    type: string
      responses:
        '200':
          description: Tags removed successfully
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/UntagResourceResponse'
        '400':
          $ref: '#/components/responses/InvalidParameter'
        '403':
          $ref: '#/components/responses/AuthorizationError'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=ListTagsForResource:
    get:
      tags:
      - Amazon SNS Amazon Simple Notification Service (SNS) API
      operationId: listTagsForResource
      summary: Amazon Sns List Tags for an Sns Topic
      description: List all tags added to the specified Amazon SNS topic. Returns key-value pairs associated with the resource.
      parameters:
      - name: ResourceArn
        in: query
        required: true
        description: The ARN of the topic to list tags for
        schema:
          type: string
      responses:
        '200':
          description: Tags retrieved
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ListTagsForResourceResponse'
        '403':
          $ref: '#/components/responses/AuthorizationError'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    InvalidParameter:
      description: Invalid parameter in the request
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    AuthorizationError:
      description: Authorization error - insufficient permissions
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The requested resource does not exist
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal service error
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    TagResourceResponse:
      type: object
      properties:
        ResponseMetadata:
          $ref: '#/components/schemas/ResponseMetadata'
    ErrorResponse:
      type: object
      properties:
        Error:
          type: object
          properties:
            Type:
              type: string
              description: The error type (Sender or Receiver)
            Code:
              type: string
              description: The specific error code
            Message:
              type: string
              description: A human-readable description of the error
          example: example_value
        RequestId:
          type: string
          description: The unique request identifier
          example: '500123'
    ResponseMetadata:
      type: object
      properties:
        RequestId:
          type: string
          description: The unique request identifier
          example: '500123'
    Tag:
      type: object
      required:
      - Key
      - Value
      properties:
        Key:
          type: string
          description: The tag key
          minLength: 1
          maxLength: 128
          example: example_value
        Value:
          type: string
          description: The tag value
          maxLength: 256
          example: example_value
    ListTagsForResourceResponse:
      type: object
      properties:
        ListTagsForResourceResult:
          type: object
          properties:
            Tags:
              type: array
              items:
                $ref: '#/components/schemas/Tag'
          example: example_value
        ResponseMetadata:
          $ref: '#/components/schemas/ResponseMetadata'
    UntagResourceResponse:
      type: object
      properties:
        ResponseMetadata:
          $ref: '#/components/schemas/ResponseMetadata'
  securitySchemes:
    AWS_IAM:
      type: http
      scheme: bearer
      description: AWS Signature Version 4 authentication. Requests must be signed using IAM credentials with appropriate SNS permissions. See https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html
externalDocs:
  description: Amazon SNS API Reference
  url: https://docs.aws.amazon.com/sns/latest/api/welcome.html