Amazon Connect Connect Quick Connects API

openapi: 3.1.0
info:
  title: Amazon Connect Service Quick Connects 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:
  /quick-connects/{InstanceId}:
    put:
      operationId: CreateQuickConnect
      summary: Create Quick Connect
      description: Creates a quick connect for the specified Connect Customer instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateQuickConnectResponse'
        '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/CreateQuickConnectRequest'
      tags:
      - Quick Connects
    get:
      operationId: ListQuickConnects
      summary: List Quick Connects
      description: Provides information about the quick connects for the specified Connect Customer instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQuickConnectsResponse'
        '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/ListQuickConnectsRequest'
      tags:
      - Quick Connects
  /quick-connects/{InstanceId}/{QuickConnectId}:
    delete:
      operationId: DeleteQuickConnect
      summary: Delete Quick Connect
      description: 'Deletes a quick connect. After calling DeleteUser, it''s important to call DeleteQuickConnect to delete
        any records related to the deleted users. This will help you: Avoid dangling resources that impact your service quotas.
        Remove deleted users so they don''t appear to agents as transfer options. Avoid the disruption of other Connect Customer
        processes, such as instance replication and syncing if you''re using Connect Customer Global Resiliency.'
      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/DeleteQuickConnectRequest'
      tags:
      - Quick Connects
    get:
      operationId: DescribeQuickConnect
      summary: Describe Quick Connect
      description: Describes the quick connect.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeQuickConnectResponse'
        '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/DescribeQuickConnectRequest'
      tags:
      - Quick Connects
  /queues/{InstanceId}/{QueueId}/quick-connects:
    get:
      operationId: ListQueueQuickConnects
      summary: List Queue Quick Connects
      description: Lists the quick connects associated with a queue.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQueueQuickConnectsResponse'
        '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/ListQueueQuickConnectsRequest'
      tags:
      - Quick Connects
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:
    CreateQuickConnectRequest:
      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: A unique name of the quick connect.
        Description:
          type: string
          description: The description of the quick connect.
        QuickConnectConfig:
          $ref: '#/components/schemas/QuickConnectConfig'
        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
      - QuickConnectConfig
    CreateQuickConnectResponse:
      type: object
      properties:
        QuickConnectARN:
          type: string
          description: The Amazon Resource Name (ARN) for the quick connect.
        QuickConnectId:
          type: string
          description: The identifier for the quick connect.
    DeleteQuickConnectRequest:
      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.
        QuickConnectId:
          type: string
          description: The identifier for the quick connect.
      required:
      - InstanceId
      - QuickConnectId
    DescribeQuickConnectRequest:
      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.
        QuickConnectId:
          type: string
          description: The identifier for the quick connect.
      required:
      - InstanceId
      - QuickConnectId
    DescribeQuickConnectResponse:
      type: object
      properties:
        QuickConnect:
          $ref: '#/components/schemas/QuickConnect'
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    FlowQuickConnectConfig:
      type: object
      properties:
        ContactFlowId:
          type: string
          description: The contact flow ID for the quick connect configuration.
      required:
      - ContactFlowId
    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.
    ListQueueQuickConnectsRequest:
      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.
        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
      - QueueId
    ListQueueQuickConnectsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
        QuickConnectSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/QuickConnectSummary'
          description: Information about the quick connects.
        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.
    ListQuickConnectsRequest:
      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. Both Instance ID and Instance ARN are supported input formats.
        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.
        QuickConnectTypes:
          type: array
          items:
            type: string
            enum:
            - USER
            - QUEUE
            - PHONE_NUMBER
            - FLOW
          description: 'The type of quick connect. In the Connect Customer admin website, when you create a quick connect,
            you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).'
      required:
      - InstanceId
    ListQuickConnectsResponse:
      type: object
      properties:
        QuickConnectSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/QuickConnectSummary'
          description: Information about the quick connects.
        NextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
    PhoneNumberQuickConnectConfig:
      type: object
      properties:
        PhoneNumber:
          type: string
          description: The phone number in E.164 format.
      required:
      - PhoneNumber
    QueueQuickConnectConfig:
      type: object
      properties:
        QueueId:
          type: string
          description: The identifier for the queue.
        ContactFlowId:
          type: string
          description: The identifier of the flow.
      required:
      - QueueId
      - ContactFlowId
    QuickConnect:
      type: object
      properties:
        QuickConnectARN:
          type: string
          description: The Amazon Resource Name (ARN) of the quick connect.
        QuickConnectId:
          type: string
          description: The identifier for the quick connect.
        Name:
          type: string
          description: The name of the quick connect.
        Description:
          type: string
          description: The description.
        QuickConnectConfig:
          $ref: '#/components/schemas/QuickConnectConfig'
        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.
    QuickConnectConfig:
      type: object
      properties:
        QuickConnectType:
          type: string
          enum:
          - USER
          - QUEUE
          - PHONE_NUMBER
          - FLOW
          description: 'The type of quick connect. In the Connect Customer admin website, when you create a quick connect,
            you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).'
        UserConfig:
          $ref: '#/components/schemas/UserQuickConnectConfig'
        QueueConfig:
          $ref: '#/components/schemas/QueueQuickConnectConfig'
        PhoneConfig:
          $ref: '#/components/schemas/PhoneNumberQuickConnectConfig'
        FlowConfig:
          $ref: '#/components/schemas/FlowQuickConnectConfig'
      required:
      - QuickConnectType
    QuickConnectSummary:
      type: object
      properties:
        Id:
          type: string
          description: The identifier for the quick connect.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the quick connect.
        Name:
          type: string
          description: The name of the quick connect.
        QuickConnectType:
          type: string
          enum:
          - USER
          - QUEUE
          - PHONE_NUMBER
          - FLOW
          description: 'The type of quick connect. In the Connect Customer admin website, when you create a quick connect,
            you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).'
        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.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UserQuickConnectConfig:
      type: object
      properties:
        UserId:
          type: string
          description: The identifier of the user.
        ContactFlowId:
          type: string
          description: The identifier of the flow.
      required:
      - UserId
      - ContactFlowId
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)