Amazon Clean Rooms Configured Tables API

Operations for managing configured tables

GitHub OpenAPI

Operations 5

POST /configuredTables Create Configured Table #
GET /configuredTables List Configured Tables #
GET /configuredTables/{configuredTableIdentifier} Get Configured Table #
PATCH /configuredTables/{configuredTableIdentifier} Update Configured Table #
DELETE /configuredTables/{configuredTableIdentifier} Delete Configured Table #

Documentation

Specifications

Examples

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-clean-rooms:amazon-clean-rooms-configured-tables-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-clean-rooms-configured-tables-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Clean Rooms Service Configured Tables API
  version: '2022-02-17'
  description: Generated from AWS's published Smithy model for AWS Clean Rooms 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://cleanrooms.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /configuredTables:
    post:
      operationId: CreateConfiguredTable
      summary: Create Configured Table
      description: Creates a new configured table resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConfiguredTableOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConfiguredTableInput'
      tags:
      - Configured Tables
    get:
      operationId: ListConfiguredTables
      summary: List Configured Tables
      description: Lists configured tables.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConfiguredTablesOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListConfiguredTablesInput'
      tags:
      - Configured Tables
  /configuredTables/{configuredTableIdentifier}:
    get:
      operationId: GetConfiguredTable
      summary: Get Configured Table
      description: Retrieves a configured table.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfiguredTableOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetConfiguredTableInput'
      tags:
      - Configured Tables
    patch:
      operationId: UpdateConfiguredTable
      summary: Update Configured Table
      description: Updates a configured table.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateConfiguredTableOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConfiguredTableInput'
      tags:
      - Configured Tables
    delete:
      operationId: DeleteConfiguredTable
      summary: Delete Configured Table
      description: Deletes a configured table.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteConfiguredTableOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteConfiguredTableInput'
      tags:
      - Configured 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: cleanrooms
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          description: A reason code for the exception.
    AthenaTableReference:
      type: object
      properties:
        region:
          type: string
          enum:
          - us-west-1
          - us-west-2
          - us-east-1
          - us-east-2
          - af-south-1
          - ap-east-1
          - ap-south-2
          - ap-southeast-1
          - ap-southeast-2
          - ap-southeast-3
          - ap-southeast-5
          - ap-southeast-4
          - ap-southeast-7
          - ap-south-1
          - ap-northeast-3
          - ap-northeast-1
          - ap-northeast-2
          - ca-central-1
          - ca-west-1
          - eu-south-1
          - eu-west-3
          - eu-south-2
          - eu-central-2
          - eu-central-1
          - eu-north-1
          - eu-west-1
          - eu-west-2
          - me-south-1
          - me-central-1
          - il-central-1
          - sa-east-1
          - mx-central-1
          - ap-east-2
          description: The Amazon Web Services Region where the Athena table is located. This parameter is required to uniquely
            identify and access tables across different Regions.
        workGroup:
          type: string
          description: The workgroup of the Athena table reference.
        outputLocation:
          type: string
          description: The output location for the Athena table.
        databaseName:
          type: string
          description: The database name.
        tableName:
          type: string
          description: The table reference.
        catalogName:
          type: string
          description: The catalog name.
      required:
      - workGroup
      - databaseName
      - tableName
    ConfiguredTable:
      type: object
      properties:
        id:
          type: string
          description: The unique ID for the configured table.
        arn:
          type: string
          description: The unique ARN for the configured table.
        name:
          type: string
          description: A name for the configured table.
        description:
          type: string
          description: A description for the configured table.
        tableReference:
          $ref: '#/components/schemas/TableReference'
        tableType:
          type: string
          enum:
          - GLUE
          - SNOWFLAKE
          - ATHENA
          - DATABRICKS
          description: 'Type of the Configured Table DataSource, example: Glue, Snowflake, Athena, Databricks'
        createTime:
          type: string
          description: The time the configured table was created.
        updateTime:
          type: string
          description: The time the configured table was last updated
        analysisRuleTypes:
          type: array
          items:
            type: string
            enum:
            - AGGREGATION
            - LIST
            - CUSTOM
          description: The types of analysis rules associated with this configured table. Currently, only one analysis rule
            may be associated with a configured table.
        analysisMethod:
          type: string
          enum:
          - DIRECT_QUERY
          - DIRECT_JOB
          - MULTIPLE
          description: The analysis method for the configured table. DIRECT_QUERY allows SQL queries to be run directly on
            this table. DIRECT_JOB allows PySpark jobs to be run directly on this table. MULTIPLE allows both SQL queries
            and PySpark jobs to be run directly on this table.
        allowedColumns:
          type: array
          items:
            type: string
          description: The columns within the underlying Glue table that can be used within collaborations.
        selectedAnalysisMethods:
          type: array
          items:
            type: string
            enum:
            - DIRECT_QUERY
            - DIRECT_JOB
          description: The selected analysis methods for the configured table.
      required:
      - id
      - arn
      - name
      - tableReference
      - createTime
      - updateTime
      - analysisRuleTypes
      - analysisMethod
      - allowedColumns
    ConfiguredTableSummary:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the configured table.
        arn:
          type: string
          description: The unique ARN of the configured table.
        name:
          type: string
          description: The name of the configured table.
        tableType:
          type: string
          enum:
          - GLUE
          - SNOWFLAKE
          - ATHENA
          - DATABRICKS
          description: 'Type of the Configured Table DataSource, example: Glue, Snowflake, Athena, Databricks'
        createTime:
          type: string
          description: The time the configured table was created.
        updateTime:
          type: string
          description: The time the configured table was last updated.
        analysisRuleTypes:
          type: array
          items:
            type: string
            enum:
            - AGGREGATION
            - LIST
            - CUSTOM
          description: The types of analysis rules associated with this configured table.
        analysisMethod:
          type: string
          enum:
          - DIRECT_QUERY
          - DIRECT_JOB
          - MULTIPLE
          description: The analysis method for the configured tables. DIRECT_QUERY allows SQL queries to be run directly on
            this table. DIRECT_JOB allows PySpark jobs to be run directly on this table. MULTIPLE allows both SQL queries
            and PySpark jobs to be run directly on this table.
        selectedAnalysisMethods:
          type: array
          items:
            type: string
            enum:
            - DIRECT_QUERY
            - DIRECT_JOB
          description: The selected analysis methods for the configured table summary.
      required:
      - id
      - arn
      - name
      - createTime
      - updateTime
      - analysisRuleTypes
      - analysisMethod
    ConflictException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the conflicting resource.
        resourceType:
          type: string
          description: The type of the conflicting resource.
        reason:
          type: string
          description: A reason code for the exception.
    CreateConfiguredTableInput:
      type: object
      properties:
        name:
          type: string
          description: The name of the configured table.
        description:
          type: string
          description: A description for the configured table.
        tableReference:
          $ref: '#/components/schemas/TableReference'
        allowedColumns:
          type: array
          items:
            type: string
          description: The columns of the underlying table that can be used by collaborations or analysis rules.
        analysisMethod:
          type: string
          enum:
          - DIRECT_QUERY
          - DIRECT_JOB
          - MULTIPLE
          description: The analysis method allowed for the configured tables. DIRECT_QUERY allows SQL queries to be run directly
            on this table. DIRECT_JOB allows PySpark jobs to be run directly on this table. MULTIPLE allows both SQL queries
            and PySpark jobs to be run directly on this table.
        selectedAnalysisMethods:
          type: array
          items:
            type: string
            enum:
            - DIRECT_QUERY
            - DIRECT_JOB
          description: The analysis methods to enable for the configured table. When configured, you must specify at least
            two analysis methods.
        tags:
          type: object
          additionalProperties:
            type: string
          description: An optional label that you can assign to a resource when you create it. Each tag consists of a key
            and an optional value, both of which you define. When you use tagging, you can also use tag-based access control
            in IAM policies to control access to this resource.
      required:
      - name
      - tableReference
      - allowedColumns
      - analysisMethod
    CreateConfiguredTableOutput:
      type: object
      properties:
        configuredTable:
          $ref: '#/components/schemas/ConfiguredTable'
      required:
      - configuredTable
    DatabricksConnectionType:
      type: object
      properties:
        deltaSharing:
          $ref: '#/components/schemas/DatabricksDeltaSharingConnection'
      description: Exactly one member is set.
    DatabricksDeltaSharingConnection:
      type: object
      properties:
        deltaShareEndpoint:
          type: string
          description: The base URL of a Delta Sharing server that hosts shared datasets.
        shareName:
          type: string
          description: Name of the Share used for OpenSharing (Delta Sharing) the Databricks Table.
      required:
      - deltaShareEndpoint
      - shareName
    DatabricksTableReference:
      type: object
      properties:
        schemaName:
          type: string
          description: Name of the Schema within Databricks.
        tableName:
          type: string
          description: Name of the Table within Databricks.
        workspaceUrl:
          type: string
          description: URL for the Databricks Workspace.
        connectionType:
          $ref: '#/components/schemas/DatabricksConnectionType'
      required:
      - schemaName
      - tableName
      - workspaceUrl
      - connectionType
    DeleteConfiguredTableInput:
      type: object
      properties:
        configuredTableIdentifier:
          type: string
          description: The unique ID for the configured table to delete.
      required:
      - configuredTableIdentifier
    DeleteConfiguredTableOutput:
      type: object
      properties: {}
    GetConfiguredTableInput:
      type: object
      properties:
        configuredTableIdentifier:
          type: string
          description: The unique ID for the configured table to retrieve.
      required:
      - configuredTableIdentifier
    GetConfiguredTableOutput:
      type: object
      properties:
        configuredTable:
          $ref: '#/components/schemas/ConfiguredTable'
      required:
      - configuredTable
    GlueTableReference:
      type: object
      properties:
        region:
          type: string
          enum:
          - us-west-1
          - us-west-2
          - us-east-1
          - us-east-2
          - af-south-1
          - ap-east-1
          - ap-south-2
          - ap-southeast-1
          - ap-southeast-2
          - ap-southeast-3
          - ap-southeast-5
          - ap-southeast-4
          - ap-southeast-7
          - ap-south-1
          - ap-northeast-3
          - ap-northeast-1
          - ap-northeast-2
          - ca-central-1
          - ca-west-1
          - eu-south-1
          - eu-west-3
          - eu-south-2
          - eu-central-2
          - eu-central-1
          - eu-north-1
          - eu-west-1
          - eu-west-2
          - me-south-1
          - me-central-1
          - il-central-1
          - sa-east-1
          - mx-central-1
          - ap-east-2
          description: The Amazon Web Services Region where the Glue table is located. This parameter is required to uniquely
            identify and access tables across different Regions.
        tableName:
          type: string
          description: The name of the Glue table.
        databaseName:
          type: string
          description: The name of the database the Glue table belongs to.
      required:
      - tableName
      - databaseName
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListConfiguredTablesInput:
      type: object
      properties:
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
        maxResults:
          type: integer
          description: The maximum number of results that are returned for an API request call. The service chooses a default
            number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been
            met.
    ListConfiguredTablesOutput:
      type: object
      properties:
        configuredTableSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ConfiguredTableSummary'
          description: The configured tables listed by the request.
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
      required:
      - configuredTableSummaries
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The Id of the missing resource.
        resourceType:
          type: string
          description: The type of the missing resource.
      required:
      - message
      - resourceId
      - resourceType
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
        quotaName:
          type: string
          description: The name of the quota.
        quotaValue:
          type: number
          description: The value of the quota.
      required:
      - message
      - quotaName
      - quotaValue
    SnowflakeTableReference:
      type: object
      properties:
        secretArn:
          type: string
          description: The secret ARN of the Snowflake table reference.
        accountIdentifier:
          type: string
          description: The account identifier for the Snowflake table reference.
        databaseName:
          type: string
          description: The name of the database the Snowflake table belongs to.
        tableName:
          type: string
          description: The name of the Snowflake table.
        schemaName:
          type: string
          description: The schema name of the Snowflake table reference.
        tableSchema:
          $ref: '#/components/schemas/SnowflakeTableSchema'
      required:
      - secretArn
      - accountIdentifier
      - databaseName
      - tableName
      - schemaName
      - tableSchema
    SnowflakeTableSchema:
      type: object
      properties:
        v1:
          type: array
          items:
            $ref: '#/components/schemas/SnowflakeTableSchemaV1'
          description: The schema of a Snowflake table.
      description: Exactly one member is set.
    SnowflakeTableSchemaV1:
      type: object
      properties:
        columnName:
          type: string
          description: The column name.
        columnType:
          type: string
          description: 'The column''s data type. Supported data types: ARRAY, BIGINT, BOOLEAN, CHAR, DATE, DECIMAL, DOUBLE,
            DOUBLE PRECISION, FLOAT, FLOAT4, INT, INTEGER, MAP, NUMERIC, NUMBER, REAL, SMALLINT, STRING, TIMESTAMP, TIMESTAMP_LTZ,
            TIMESTAMP_NTZ, DATETIME, TINYINT, VARCHAR, TEXT, CHARACTER.'
      required:
      - columnName
      - columnType
    TableReference:
      type: object
      properties:
        glue:
          $ref: '#/components/schemas/GlueTableReference'
        snowflake:
          $ref: '#/components/schemas/SnowflakeTableReference'
        athena:
          $ref: '#/components/schemas/AthenaTableReference'
        databricks:
          $ref: '#/components/schemas/DatabricksTableReference'
      description: Exactly one member is set.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    UpdateConfiguredTableInput:
      type: object
      properties:
        configuredTableIdentifier:
          type: string
          description: The identifier for the configured table to update. Currently accepts the configured table ID.
        name:
          type: string
          description: A new name for the configured table.
        description:
          type: string
          description: A new description for the configured table.
        tableReference:
          $ref: '#/components/schemas/TableReference'
        allowedColumns:
          type: array
          items:
            type: string
          description: The columns of the underlying table that can be used by collaborations or analysis rules.
        analysisMethod:
          type: string
          enum:
          - DIRECT_QUERY
          - DIRECT_JOB
          - MULTIPLE
          description: The analysis method for the configured table. DIRECT_QUERY allows SQL queries to be run directly on
            this table. DIRECT_JOB allows PySpark jobs to be run directly on this table. MULTIPLE allows both SQL queries
            and PySpark jobs to be run directly on this table.
        selectedAnalysisMethods:
          type: array
          items:
            type: string
            enum:
            - DIRECT_QUERY
            - DIRECT_JOB
          description: The selected analysis methods for the table configuration update.
      required:
      - configuredTableIdentifier
    UpdateConfiguredTableOutput:
      type: object
      properties:
        configuredTable:
          $ref: '#/components/schemas/ConfiguredTable'
      required:
      - configuredTable
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          description: A reason code for the exception.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: Validation errors for specific input parameters.
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the input parameter.
        message:
          type: string
          description: A message for the input validation error.
      required:
      - name
      - message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/cleanrooms/service/2022-02-17/cleanrooms-2022-02-17.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)