Amazon SQS Permissions API

openapi: 3.1.0
info:
  title: Amazon Simple Queue Service Permissions API
  version: '2012-11-05'
  description: Generated from AWS's published Smithy model for Amazon Simple Queue Service. 2 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://sqs.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#AddPermission:
    post:
      operationId: AddPermission
      summary: Add Permission
      description: Adds a permission to a queue for a specific principal. This allows sharing access to the queue. When you
        create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or
        deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages
        to a Shared Queue in the Amazon SQS Developer Guide. AddPermission generates a policy for you. You can use SetQueueAttributes
        to upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language
        in the Amazon SQS Developer Guide. An Amazon SQS policy can have a maximum of seven actions per statement. To remove
        the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes
        actions in your IAM policy. Amazon SQS AddPermission does not support adding a non-account principal. Cross-account
        permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a
        username in the Amazon SQS Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                type: string
        '404':
          description: InvalidAddress
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidAddress'
        '403':
          description: InvalidSecurity; OverLimit; RequestThrottled
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidSecurity'
        '400':
          description: QueueDoesNotExist; UnsupportedOperation
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/QueueDoesNotExist'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSQS.AddPermission
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/AddPermissionRequest'
      tags:
      - Permissions
  /#RemovePermission:
    post:
      operationId: RemovePermission
      summary: Remove Permission
      description: Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner
        of a queue can remove permissions from it. Cross-account permissions don't apply to this action. For more information,
        see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. To remove the ability
        to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes
        actions in your IAM policy.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                type: string
        '404':
          description: InvalidAddress
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidAddress'
        '403':
          description: InvalidSecurity; RequestThrottled
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidSecurity'
        '400':
          description: QueueDoesNotExist; UnsupportedOperation
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/QueueDoesNotExist'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSQS.RemovePermission
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/RemovePermissionRequest'
      tags:
      - Permissions
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: sqs
  schemas:
    AddPermissionRequest:
      type: object
      properties:
        QueueUrl:
          type: string
          description: The URL of the Amazon SQS queue to which permissions are added. Queue URLs and names are case-sensitive.
        Label:
          type: string
          description: The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum
            80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).
        AWSAccountIds:
          type: array
          items:
            type: string
          description: The Amazon Web Services account numbers of the principals who are to receive permission. For information
            about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the
            Amazon SQS Developer Guide.
        Actions:
          type: array
          items:
            type: string
          description: 'The action the client wants to allow for the specified principal. Valid values: the name of any action
            or *. For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple
            Queue Service Resource in the Amazon SQS Developer Guide. Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility
            for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch,
            DeleteMessageBatch, and ChangeMessageVisibilityBatch.'
      required:
      - QueueUrl
      - Label
      - AWSAccountIds
      - Actions
    InvalidAddress:
      type: object
      properties:
        message:
          type: string
    InvalidSecurity:
      type: object
      properties:
        message:
          type: string
    QueueDoesNotExist:
      type: object
      properties:
        message:
          type: string
    RemovePermissionRequest:
      type: object
      properties:
        QueueUrl:
          type: string
          description: The URL of the Amazon SQS queue from which permissions are removed. Queue URLs and names are case-sensitive.
        Label:
          type: string
          description: The identification of the permission to remove. This is the label added using the AddPermission action.
      required:
      - QueueUrl
      - Label
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/sqs/service/2012-11-05/sqs-2012-11-05.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)