Amazon Connect Queues API

openapi: 3.1.0
info:
  title: Amazon Connect Service Queues API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 5 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://connect.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /queues/{InstanceId}:
    put:
      operationId: CreateQueue
      summary: Create Queue
      description: Creates a new queue for the specified Connect Customer instance. If the phone number is claimed to a traffic
        distribution group that was created in the same Region as the Connect Customer instance where you are calling this
        API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number
        is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in
        another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full
        phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. Only use the
        phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid.
        This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. If you plan to use IAM policies
        to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or
        Deny queue API actions for phone numbers in a replica Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateQueueResponse'
        '409':
          description: DuplicateResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateResourceException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '429':
          description: LimitExceededException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateQueueRequest'
      tags:
      - Queues
  /queues/{InstanceId}/{QueueId}:
    delete:
      operationId: DeleteQueue
      summary: Delete Queue
      description: Deletes a queue.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '409':
          description: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteQueueRequest'
      tags:
      - Queues
    get:
      operationId: DescribeQueue
      summary: Describe Queue
      description: Describes the specified queue.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeQueueResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeQueueRequest'
      tags:
      - Queues
  /routing-profiles/{InstanceId}/{RoutingProfileId}/queues:
    get:
      operationId: ListRoutingProfileQueues
      summary: List Routing Profile Queues
      description: Lists the queues associated with a routing profile.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRoutingProfileQueuesResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListRoutingProfileQueuesRequest'
      tags:
      - Queues
    post:
      operationId: UpdateRoutingProfileQueues
      summary: Update Routing Profile Queues
      description: Updates the properties associated with a set of queues for a routing profile.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRoutingProfileQueuesRequest'
      tags:
      - Queues
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: connect
  schemas:
    CreateQueueRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        Name:
          type: string
          description: The name of the queue.
        Description:
          type: string
          description: The description of the queue.
        OutboundCallerConfig:
          $ref: '#/components/schemas/OutboundCallerConfig'
        OutboundEmailConfig:
          $ref: '#/components/schemas/OutboundEmailConfig'
        HoursOfOperationId:
          type: string
          description: The identifier for the hours of operation.
        MaxContacts:
          type: integer
          description: The maximum number of contacts that can be in the queue before it is considered full.
        QuickConnectIds:
          type: array
          items:
            type: string
          description: The quick connects available to agents who are working the queue.
        EmailAddressesConfig:
          type: array
          items:
            $ref: '#/components/schemas/EmailAddressConfig'
          description: Configuration list containing the email addresses to associate with the queue during creation. Each
            configuration specifies an email address ID that agents can select when handling email contacts in this queue.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
            "key2":"value2"} }.'
      required:
      - InstanceId
      - Name
      - HoursOfOperationId
    CreateQueueResponse:
      type: object
      properties:
        QueueArn:
          type: string
          description: The Amazon Resource Name (ARN) of the queue.
        QueueId:
          type: string
          description: The identifier for the queue.
    DeleteQueueRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        QueueId:
          type: string
          description: The identifier for the queue.
      required:
      - InstanceId
      - QueueId
    DescribeQueueRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        QueueId:
          type: string
          description: The identifier for the queue.
      required:
      - InstanceId
      - QueueId
    DescribeQueueResponse:
      type: object
      properties:
        Queue:
          $ref: '#/components/schemas/Queue'
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    EmailAddressConfig:
      type: object
      properties:
        EmailAddressId:
          type: string
          description: The identifier of the email address that should be associated with the queue. This email address must
            already exist in the Connect Customer instance and will be used to route incoming email contacts to the specified
            queue.
      required:
      - EmailAddressId
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the parameters.
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the limit.
    ListRoutingProfileQueuesRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        RoutingProfileId:
          type: string
          description: The identifier of the routing profile.
        NextToken:
          type: string
          description: The token for the next set of results. Use the value returned in the previous response in the next
            request to retrieve the next set of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return per page. The default MaxResult size is 100.
      required:
      - InstanceId
      - RoutingProfileId
    ListRoutingProfileQueuesResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
        RoutingProfileQueueConfigSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/RoutingProfileQueueConfigSummary'
          description: Information about the routing profiles.
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp when this resource was last modified.
        LastModifiedRegion:
          type: string
          description: The Amazon Web Services Region where this resource was last modified.
    OutboundCallerConfig:
      type: object
      properties:
        OutboundCallerIdName:
          type: string
          description: The caller ID name.
        OutboundCallerIdNumberId:
          type: string
          description: The caller ID number.
        OutboundFlowId:
          type: string
          description: The outbound whisper flow to be used during an outbound call.
    OutboundEmailConfig:
      type: object
      properties:
        OutboundEmailAddressId:
          type: string
          description: The identifier of the email address.
    Queue:
      type: object
      properties:
        Name:
          type: string
          description: The name of the queue.
        QueueArn:
          type: string
          description: The Amazon Resource Name (ARN) for the queue.
        QueueId:
          type: string
          description: The identifier for the queue.
        Description:
          type: string
          description: The description of the queue.
        OutboundCallerConfig:
          $ref: '#/components/schemas/OutboundCallerConfig'
        OutboundEmailConfig:
          $ref: '#/components/schemas/OutboundEmailConfig'
        HoursOfOperationId:
          type: string
          description: The identifier for the hours of operation.
        MaxContacts:
          type: integer
          description: The maximum number of contacts that can be in the queue before it is considered full.
        Status:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: The status of the queue.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
            "key2":"value2"} }.'
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp when this resource was last modified.
        LastModifiedRegion:
          type: string
          description: The Amazon Web Services Region where this resource was last modified.
    ResourceInUseException:
      type: object
      properties:
        Message:
          type: string
        ResourceType:
          type: string
          enum:
          - CONTACT
          - CONTACT_FLOW
          - INSTANCE
          - PARTICIPANT
          - HIERARCHY_LEVEL
          - HIERARCHY_GROUP
          - USER
          - PHONE_NUMBER
          description: The type of resource.
        ResourceId:
          type: string
          description: The identifier for the resource.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    RoutingProfileQueueConfig:
      type: object
      properties:
        QueueReference:
          $ref: '#/components/schemas/RoutingProfileQueueReference'
        Priority:
          type: integer
          description: 'The order in which contacts are to be handled for the queue. For more information, see Queues: priority
            and delay.'
        Delay:
          type: integer
          description: 'The delay, in seconds, a contact should be in the queue before they are routed to an available agent.
            For more information, see Queues: priority and delay in the Connect Customer Administrator Guide.'
      required:
      - QueueReference
      - Priority
      - Delay
    RoutingProfileQueueConfigSummary:
      type: object
      properties:
        QueueId:
          type: string
          description: The identifier for the queue.
        QueueArn:
          type: string
          description: The Amazon Resource Name (ARN) of the queue.
        QueueName:
          type: string
          description: The name of the queue.
        Priority:
          type: integer
          description: 'The order in which contacts are to be handled for the queue. For more information, see Queues: priority
            and delay.'
        Delay:
          type: integer
          description: 'The delay, in seconds, that a contact should be in the queue before they are routed to an available
            agent. For more information, see Queues: priority and delay in the Connect Customer Administrator Guide.'
        Channel:
          type: string
          enum:
          - VOICE
          - CHAT
          - TASK
          - EMAIL
          description: The channels this queue supports.
      required:
      - QueueId
      - QueueArn
      - QueueName
      - Priority
      - Delay
      - Channel
    RoutingProfileQueueReference:
      type: object
      properties:
        QueueId:
          type: string
          description: The identifier for the queue.
        Channel:
          type: string
          enum:
          - VOICE
          - CHAT
          - TASK
          - EMAIL
          description: The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
      required:
      - QueueId
      - Channel
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UpdateRoutingProfileQueuesRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        RoutingProfileId:
          type: string
          description: The identifier of the routing profile.
        QueueConfigs:
          type: array
          items:
            $ref: '#/components/schemas/RoutingProfileQueueConfig'
          description: The queues to be updated for this routing profile. Queues must first be associated to the routing profile.
            You can do this using AssociateRoutingProfileQueues.
      required:
      - InstanceId
      - RoutingProfileId
      - QueueConfigs
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/connect/service/2017-08-08/connect-2017-08-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)