Amazon SQS Tags API

openapi: 3.1.0
info:
  title: Amazon SQS Amazon Simple Queue Service (SQS) Messages Tags API
  description: 'Amazon Simple Queue Service (SQS) is a fully managed message queuing service that enables you to decouple and scale microservices, distributed systems, and serverless applications. SQS eliminates the complexity and overhead associated with managing and operating message-oriented middleware, and empowers developers to focus on differentiating work. Using SQS, you can send, store, and receive messages between software components at any volume, without losing messages or requiring other services to be available. SQS offers two types of message queues: Standard queues offer maximum throughput, best-effort ordering, and at-least-once delivery. FIFO queues are designed to guarantee that messages are processed exactly once, in the exact order that they are sent.'
  version: '2012-11-05'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
servers:
- url: https://sqs.{region}.amazonaws.com
  description: Amazon SQS Regional Endpoint
  variables:
    region:
      default: us-east-1
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - af-south-1
      - ap-east-1
      - ap-south-1
      - ap-south-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-southeast-3
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ca-central-1
      - eu-central-1
      - eu-central-2
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-south-1
      - eu-south-2
      - eu-north-1
      - me-south-1
      - me-central-1
      - sa-east-1
security:
- aws_sig_v4: []
tags:
- name: Tags
paths:
  /{accountId}/{queueName}/tags:
    parameters:
    - $ref: '#/components/parameters/AccountId'
    - $ref: '#/components/parameters/QueueName'
    get:
      operationId: ListQueueTags
      summary: Amazon Sqs List All Tags for a Queue
      description: List all cost allocation tags added to the specified Amazon SQS queue.
      tags:
      - Tags
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - ListQueueTags
      responses:
        '200':
          description: Tags retrieved successfully
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ListQueueTagsResponse'
        '400':
          description: Bad request
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: TagQueue
      summary: Amazon Sqs Add Tags to a Queue
      description: Add cost allocation tags to the specified Amazon SQS queue. Tags are key-value pairs. For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide. When you use queue tags, keep in mind that SQS supports a maximum of 50 tags per queue.
      tags:
      - Tags
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - Action
              - Tag.1.Key
              - Tag.1.Value
              properties:
                Action:
                  type: string
                  enum:
                  - TagQueue
                Tag.1.Key:
                  type: string
                  description: The key of the first tag
                Tag.1.Value:
                  type: string
                  description: The value of the first tag
      responses:
        '200':
          description: Tags added successfully
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/GenericResponse'
        '400':
          description: Bad request
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: UntagQueue
      summary: Amazon Sqs Remove Tags From a Queue
      description: Remove cost allocation tags from the specified Amazon SQS queue.
      tags:
      - Tags
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - UntagQueue
      - name: TagKey.1
        in: query
        required: true
        description: The tag key to remove
        schema:
          type: string
      responses:
        '200':
          description: Tags removed successfully
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/GenericResponse'
        '400':
          description: Bad request
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ListQueueTagsResponse:
      type: object
      properties:
        ListQueueTagsResult:
          type: object
          properties:
            Tag:
              type: array
              items:
                type: object
                properties:
                  Key:
                    type: string
                  Value:
                    type: string
          example: example_value
        ResponseMetadata:
          $ref: '#/components/schemas/ResponseMetadata'
    ErrorResponse:
      type: object
      properties:
        Error:
          type: object
          properties:
            Type:
              type: string
              description: The error type (Sender or Receiver)
              enum:
              - Sender
              - Receiver
            Code:
              type: string
              description: The error code
              examples:
              - AWS.SimpleQueueService.NonExistentQueue
              - AWS.SimpleQueueService.QueueDeletedRecently
              - InvalidParameterValue
              - MissingParameter
              - QueueAlreadyExists
              - OverLimit
              - AccessDenied
              - InvalidAddress
              - InvalidAction
              - InvalidAttributeName
              - InvalidAttributeValue
              - InvalidBatchEntryId
              - TooManyEntriesInBatchRequest
              - BatchEntryIdsNotDistinct
              - EmptyBatchRequest
              - BatchRequestTooLong
              - UnsupportedOperation
              - PurgeQueueInProgress
              - MessageNotInflight
              - ReceiptHandleIsInvalid
              - ResourceNotFoundException
            Message:
              type: string
              description: A human-readable description of the error
          example: example_value
        RequestId:
          type: string
          description: The unique request identifier
          example: '500123'
    GenericResponse:
      type: object
      properties:
        ResponseMetadata:
          $ref: '#/components/schemas/ResponseMetadata'
    ResponseMetadata:
      type: object
      properties:
        RequestId:
          type: string
          description: A unique identifier for the request
          example: '500123'
  parameters:
    QueueName:
      name: queueName
      in: path
      required: true
      description: The name of the queue. For FIFO queues, the name must end with the .fifo suffix.
      schema:
        type: string
        maxLength: 80
    AccountId:
      name: accountId
      in: path
      required: true
      description: The AWS account ID of the queue owner
      schema:
        type: string
        pattern: ^\d{12}$
  securitySchemes:
    aws_sig_v4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication. All SQS API requests must be signed using AWS credentials (Access Key ID and Secret Access Key). The signature is included in the Authorization header.
externalDocs:
  description: Amazon SQS API Reference
  url: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/