Amazon Connect Connect Data Tables API

openapi: 3.1.0
info:
  title: Amazon Connect Service Data Tables 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:
  /data-tables/{InstanceId}:
    put:
      operationId: CreateDataTable
      summary: Create Data Table
      description: Creates a new data table with the specified properties. Supports the creation of all table properties except
        for attributes and values. A table with no attributes and values is a valid state for a table. The number of tables
        per instance is limited to 100 per instance. Customers can request an increase by using Amazon Web Services Service
        Quotas.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDataTableResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; DuplicateResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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'
        '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/CreateDataTableRequest'
      tags:
      - Data Tables
    get:
      operationId: ListDataTables
      summary: List Data Tables
      description: Lists all data tables for the specified Amazon Connect instance. Returns summary information for each table
        including basic metadata and modification details.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDataTablesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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/ListDataTablesRequest'
      tags:
      - Data Tables
  /data-tables/{InstanceId}/{DataTableId}:
    delete:
      operationId: DeleteDataTable
      summary: Delete Data Table
      description: Deletes a data table and all associated attributes, versions, audits, and values. Does not update any references
        to the data table, even from other data tables. This includes dynamic values and conditional validations. System managed
        data tables are not deletable by customers. API users may delete the table at any time. When deletion is requested
        from the admin website, a warning is shown alerting the user of the most recent time the table and its values were
        accessed.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDataTableResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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/DeleteDataTableRequest'
      tags:
      - Data Tables
    get:
      operationId: DescribeDataTable
      summary: Describe Data Table
      description: Returns all properties for a data table except for attributes and values. All properties from CreateDataTable
        are returned as well as properties for region replication, versioning, and system tables. "Describe" is a deprecated
        term but is allowed to maintain consistency with existing operations.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDataTableResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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/DescribeDataTableRequest'
      tags:
      - Data Tables
    post:
      operationId: UpdateDataTableMetadata
      summary: Update Data Table Metadata
      description: Updates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except
        for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties
        must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDataTableMetadataResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; DuplicateResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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/UpdateDataTableMetadataRequest'
      tags:
      - Data Tables
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:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateDataTableRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The unique identifier for the Amazon Connect instance where the data table will be created.
        Name:
          type: string
          description: The name for the data table. Must conform to Connect human readable string specification and have 1-127
            characters. Whitespace must be trimmed first. Must not start with the reserved case insensitive values 'connect:'
            and 'aws:'. Must be unique for the instance using case-insensitive comparison.
        Description:
          type: string
          description: An optional description for the data table. Must conform to Connect human readable string specification
            and have 0-250 characters. Whitespace must be trimmed first.
        TimeZone:
          type: string
          description: The IANA timezone identifier to use when resolving time based dynamic values. Required even if no time
            slices are specified.
        ValueLockLevel:
          type: string
          enum:
          - NONE
          - DATA_TABLE
          - PRIMARY_VALUE
          - ATTRIBUTE
          - VALUE
          description: The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE,
            VALUE, and NONE. NONE is the default if unspecified. This determines how concurrent edits are handled when multiple
            users attempt to modify values simultaneously.
        Status:
          type: string
          enum:
          - PUBLISHED
          description: The status of the data table. One of PUBLISHED or SAVED. Required parameter that determines the initial
            state of the table.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: Key value pairs for attribute based access control (TBAC or ABAC). Optional tags to apply to the data
            table for organization and access control purposes.
      required:
      - InstanceId
      - Name
      - TimeZone
      - ValueLockLevel
      - Status
    CreateDataTableResponse:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier for the created data table. Does not include the version alias.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) for the created data table. Does not include the version alias.
        LockVersion:
          $ref: '#/components/schemas/DataTableLockVersion'
      required:
      - Id
      - Arn
      - LockVersion
    DataTable:
      type: object
      properties:
        Name:
          type: string
          description: The human-readable name of the data table. Must be unique within the instance and conform to Connect
            naming standards.
        Id:
          type: string
          description: The unique identifier for the data table. Does not include version aliases.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) for the data table. Does not include version aliases.
        TimeZone:
          type: string
          description: The IANA timezone identifier used when resolving time based dynamic values. Required even if no time
            slices are specified.
        Description:
          type: string
          description: An optional description of the data table's purpose and contents.
        ValueLockLevel:
          type: string
          enum:
          - NONE
          - DATA_TABLE
          - PRIMARY_VALUE
          - ATTRIBUTE
          - VALUE
          description: The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE,
            VALUE, and NONE. Determines how concurrent edits are handled when multiple users attempt to modify values simultaneously.
        LockVersion:
          $ref: '#/components/schemas/DataTableLockVersion'
        Version:
          type: string
          description: A unique identifier and alias for customer managed versions (not $LATEST or $SAVED).
        VersionDescription:
          type: string
          description: A description of the customer managed version.
        Status:
          type: string
          enum:
          - PUBLISHED
          description: The current status of the data table. One of PUBLISHED or SAVED.
        CreatedTime:
          type: string
          format: date-time
          description: The timestamp when the data table was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp when the data table or any of its properties were last modified.
        LastModifiedRegion:
          type: string
          description: The Amazon Web Services Region where the data table was last modified, used for region replication.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: Key-value pairs for attribute based access control (TBAC or ABAC) and organization.
      required:
      - Name
      - Id
      - Arn
      - TimeZone
      - LastModifiedTime
    DataTableLockVersion:
      type: object
      properties:
        DataTable:
          type: string
          description: The lock version for the data table itself. Used for optimistic locking and table versioning. Changes
            with each update to the table's metadata or structure.
        Attribute:
          type: string
          description: The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes
            when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties
            are directly updated.
        PrimaryValues:
          type: string
          description: The lock version for a specific set of primary values (record). This includes the default record even
            if the table does not have any primary attributes. Used for record-level locking.
        Value:
          type: string
          description: The lock version for a specific value. Changes each time the individual value is modified. Used for
            the finest-grained locking control.
    DataTableSummary:
      type: object
      properties:
        Name:
          type: string
          description: The summary's name.
        Id:
          type: string
          description: The summary's ID.
        Arn:
          type: string
          description: The summary's ARN.
        LastModifiedTime:
          type: string
          format: date-time
          description: The summary's last modified time.
        LastModifiedRegion:
          type: string
          description: The summary's last modified region.
    DeleteDataTableRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The unique identifier for the Amazon Connect instance.
        DataTableId:
          type: string
          description: The unique identifier for the data table to delete. Must also accept the table ARN. Fails with an error
            if the version is provided and is not $LATEST.
      required:
      - InstanceId
      - DataTableId
    DeleteDataTableResponse:
      type: object
      properties: {}
    DescribeDataTableRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The unique identifier for the Amazon Connect instance.
        DataTableId:
          type: string
          description: The unique identifier for the data table. Must also accept the table ARN with or without a version
            alias. If no alias is provided, the default behavior is identical to providing the $LATEST alias.
      required:
      - InstanceId
      - DataTableId
    DescribeDataTableResponse:
      type: object
      properties:
        DataTable:
          $ref: '#/components/schemas/DataTable'
      required:
      - DataTable
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the parameters.
    ListDataTablesRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The unique identifier for the Amazon Connect instance whose data tables should be listed.
        NextToken:
          type: string
          description: Specify the pagination token from a previous request to retrieve the next page of results.
        MaxResults:
          type: integer
          description: The maximum number of data tables to return in one page of results.
      required:
      - InstanceId
    ListDataTablesResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: Specify the pagination token from a previous request to retrieve the next page of results.
        DataTableSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/DataTableSummary'
          description: A list of data table summaries containing basic information about each table including ID, ARN, name,
            and modification details.
      required:
      - DataTableSummaryList
    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
    UpdateDataTableMetadataRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The unique identifier for the Amazon Connect instance.
        DataTableId:
          type: string
          description: The unique identifier for the data table. Must also accept the table ARN with or without a version
            alias. If the version is provided as part of the identifier or ARN, the version must be $LATEST. Providing any
            other alias fails with an error.
        Name:
          type: string
          description: The updated name for the data table. Must conform to Connect human readable string specification and
            have 1-127 characters. Must be unique for the instance using case-insensitive comparison.
        Description:
          type: string
          description: The updated description for the data table. Must conform to Connect human readable string specification
            and have 0-250 characters.
        ValueLockLevel:
          type: string
          enum:
          - NONE
          - DATA_TABLE
          - PRIMARY_VALUE
          - ATTRIBUTE
          - VALUE
          description: The updated value lock level for the data table. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE,
            and NONE.
        TimeZone:
          type: string
          description: The updated IANA timezone identifier to use when resolving time based dynamic values.
      required:
      - InstanceId
      - DataTableId
      - Name
      - ValueLockLevel
      - TimeZone
    UpdateDataTableMetadataResponse:
      type: object
      properties:
        LockVersion:
          $ref: '#/components/schemas/DataTableLockVersion'
      required:
      - LockVersion
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)