Amazon Connect Instances API

openapi: 3.1.0
info:
  title: Amazon Connect Service Instances API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 4 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:
  /instance:
    put:
      operationId: CreateInstance
      summary: Create Instance
      description: This API is in preview release for Connect Customer and is subject to change. Initiates an Connect Customer
        instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service
        (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for
        Connect Customer. For more information, see Create an Connect Customer instance in the Connect Customer Administrator
        Guide. Connect Customer enforces a limit on the total number of instances that you can create or delete in 30 days.
        If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts
        at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in
        your account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateInstanceResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInstanceRequest'
      tags:
      - Instances
    get:
      operationId: ListInstances
      summary: List Instances
      description: This API is in preview release for Connect Customer and is subject to change. Return a list of instances
        which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created
        (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInstancesResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListInstancesRequest'
      tags:
      - Instances
  /instance/{InstanceId}:
    delete:
      operationId: DeleteInstance
      summary: Delete Instance
      description: This API is in preview release for Connect Customer and is subject to change. Deletes the Connect Customer
        instance. For more information, see Delete your Connect Customer instance in the Connect Customer Administrator Guide.
        Connect Customer enforces a limit on the total number of instances that you can create or delete in 30 days. If you
        exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating
        or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteInstanceRequest'
      tags:
      - Instances
    get:
      operationId: DescribeInstance
      summary: Describe Instance
      description: This API is in preview release for Connect Customer and is subject to change. Returns the current state
        of the specified instance identifier. It tracks the instance while it is being created and returns an error status,
        if applicable. If an instance is not created successfully, the instance status reason field returns details relevant
        to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeInstanceResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeInstanceRequest'
      tags:
      - Instances
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:
    CreateInstanceRequest:
      type: object
      properties:
        ClientToken:
          type: string
          description: The idempotency token.
        IdentityManagementType:
          type: string
          enum:
          - SAML
          - CONNECT_MANAGED
          - EXISTING_DIRECTORY
          description: The type of identity management for your Connect Customer users.
        InstanceAlias:
          type: string
          description: The name for your instance.
        DirectoryId:
          type: string
          description: The identifier for the directory.
        InboundCallsEnabled:
          type: boolean
          description: Your contact center handles incoming contacts.
        OutboundCallsEnabled:
          type: boolean
          description: Your contact center allows outbound calls.
        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:
      - IdentityManagementType
      - InboundCallsEnabled
      - OutboundCallsEnabled
    CreateInstanceResponse:
      type: object
      properties:
        Id:
          type: string
          description: The identifier for the instance.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the instance.
    DeleteInstanceRequest:
      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.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
            provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making
            retries safe with idempotent APIs.
      required:
      - InstanceId
    DescribeInstanceRequest:
      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.
      required:
      - InstanceId
    DescribeInstanceResponse:
      type: object
      properties:
        Instance:
          $ref: '#/components/schemas/Instance'
        ReplicationConfiguration:
          $ref: '#/components/schemas/ReplicationConfiguration'
    Instance:
      type: object
      properties:
        Id:
          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.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the instance.
        IdentityManagementType:
          type: string
          enum:
          - SAML
          - CONNECT_MANAGED
          - EXISTING_DIRECTORY
          description: The identity management type.
        InstanceAlias:
          type: string
          description: The alias of instance.
        CreatedTime:
          type: string
          format: date-time
          description: When the instance was created.
        ServiceRole:
          type: string
          description: The service role of the instance.
        InstanceStatus:
          type: string
          enum:
          - CREATION_IN_PROGRESS
          - ACTIVE
          - CREATION_FAILED
          description: The state of the instance.
        StatusReason:
          $ref: '#/components/schemas/InstanceStatusReason'
        InboundCallsEnabled:
          type: boolean
          description: Whether inbound calls are enabled.
        OutboundCallsEnabled:
          type: boolean
          description: Whether outbound calls are enabled.
        InstanceAccessUrl:
          type: string
          description: This URL allows contact center users to access the Connect Customer admin website.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags of an instance.
    InstanceStatusReason:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InstanceSummary:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the instance.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the instance.
        IdentityManagementType:
          type: string
          enum:
          - SAML
          - CONNECT_MANAGED
          - EXISTING_DIRECTORY
          description: The identity management type of the instance.
        InstanceAlias:
          type: string
          description: The alias of the instance.
        CreatedTime:
          type: string
          format: date-time
          description: When the instance was created.
        ServiceRole:
          type: string
          description: The service role of the instance.
        InstanceStatus:
          type: string
          enum:
          - CREATION_IN_PROGRESS
          - ACTIVE
          - CREATION_FAILED
          description: The state of the instance.
        InboundCallsEnabled:
          type: boolean
          description: Whether inbound calls are enabled.
        OutboundCallsEnabled:
          type: boolean
          description: Whether outbound calls are enabled.
        InstanceAccessUrl:
          type: string
          description: This URL allows contact center users to access the Connect Customer admin website.
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidRequestException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the request.
        Reason:
          $ref: '#/components/schemas/InvalidRequestExceptionReason'
    InvalidRequestExceptionReason:
      type: object
      properties:
        AttachedFileInvalidRequestExceptionReason:
          type: string
          enum:
          - INVALID_FILE_SIZE
          - INVALID_FILE_TYPE
          - INVALID_FILE_NAME
          description: Reason why the StartAttachedFiledUpload request was invalid.
      description: Exactly one member is set.
    ListInstancesRequest:
      type: object
      properties:
        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.
    ListInstancesResponse:
      type: object
      properties:
        InstanceSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/InstanceSummary'
          description: Information about the instances.
        NextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
    ReplicationConfiguration:
      type: object
      properties:
        ReplicationStatusSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/ReplicationStatusSummary'
          description: A list of replication status summaries. The summaries contain details about the replication of configuration
            information for Connect Customer resources, for each Amazon Web Services Region.
        SourceRegion:
          type: string
          description: The Amazon Web Services Region where the source Connect Customer instance was created. This is the
            Region where the ReplicateInstance API was called to start the replication process.
        GlobalSignInEndpoint:
          type: string
          description: The URL that is used to sign-in to your Connect Customer instance according to your traffic distribution
            group configuration. For more information about sign-in and traffic distribution groups, see Important things
            to know in the Create traffic distribution groups topic in the Connect Customer Administrator Guide.
    ReplicationStatusSummary:
      type: object
      properties:
        Region:
          type: string
          description: The Amazon Web Services Region. This can be either the source or the replica Region, depending where
            it appears in the summary list.
        ReplicationStatus:
          type: string
          enum:
          - INSTANCE_REPLICATION_COMPLETE
          - INSTANCE_REPLICATION_IN_PROGRESS
          - INSTANCE_REPLICATION_FAILED
          - INSTANCE_REPLICA_DELETING
          - INSTANCE_REPLICATION_DELETION_FAILED
          - RESOURCE_REPLICATION_NOT_STARTED
          description: The state of the replication.
        ReplicationStatusReason:
          type: string
          description: A description of the replication status. Use this information to resolve any issues that are preventing
            the successful replication of your Connect Customer instance to another Region.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          $ref: '#/components/schemas/ServiceQuotaExceededExceptionReason'
    ServiceQuotaExceededExceptionReason:
      type: object
      properties:
        AttachedFileServiceQuotaExceededExceptionReason:
          type: string
          enum:
          - TOTAL_FILE_SIZE_EXCEEDED
          - TOTAL_FILE_COUNT_EXCEEDED
          description: Total file size of all files or total number of files exceeds the service quota
      description: Exactly one member is set.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/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)