configured_tables

Creates, updates, deletes, gets or lists a configured_tables resource.

Overview

Name	`configured_tables`
Type	Resource
Id	`aws.cleanrooms.configured_tables`

Fields

The following fields are returned by SELECT queries:

get_configured_table
list_configured_tables

Name	Datatype	Description
`id`	`string`	The unique ID for the configured table. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
`name`	`string`	A name for the configured table. (pattern: <code>(?!\s$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]</code>)
`allowed_columns`	`array`	The columns within the underlying Glue table that can be used within collaborations.
`analysis_method`	`string`	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. (DIRECT_QUERY, DIRECT_JOB, MULTIPLE)
`analysis_rule_types`	`array`	The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.
`arn`	`string`	The unique ARN for the configured table. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:configuredtable/[\d\w-]+</code>)
`create_time`	`string (date-time)`	The time the configured table was created.
`description`	`string`	A description for the configured table. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
`selected_analysis_methods`	`array`	The selected analysis methods for the configured table.
`table_reference`	`object`	A pointer to the dataset that underlies this table.
`update_time`	`string (date-time)`	The time the configured table was last updated

Name	Datatype	Description
`id`	`string`	The unique ID of the configured table. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
`name`	`string`	The name of the configured table. (pattern: <code>(?!\s$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]</code>)
`analysis_method`	`string`	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. (DIRECT_QUERY, DIRECT_JOB, MULTIPLE)
`analysis_rule_types`	`array`	The types of analysis rules associated with this configured table.
`arn`	`string`	The unique ARN of the configured table. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:configuredtable/[\d\w-]+</code>)
`create_time`	`string (date-time)`	The time the configured table was created.
`selected_analysis_methods`	`array`	The selected analysis methods for the configured table summary.
`update_time`	`string (date-time)`	The time the configured table was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_configured_table`	`select`	`configured_table_identifier`, `region`		Retrieves a configured table.
`list_configured_tables`	`select`	`region`	`nextToken`, `maxResults`	Lists configured tables.
`create_configured_table`	`insert`	`region`, `name`, `tableReference`, `allowedColumns`, `analysisMethod`		Creates a new configured table resource.
`update_configured_table`	`update`	`configured_table_identifier`, `region`		Updates a configured table.
`delete_configured_table`	`delete`	`configured_table_identifier`, `region`		Deletes a configured table.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`configured_table_identifier`	`string`	The unique ID for the configured table to delete.
`region`	`string`	AWS region (default: us-east-1)
`maxResults`	`integer`	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.
`nextToken`	`string`	The pagination token that's used to fetch the next set of results.

`SELECT` examples

get_configured_table
list_configured_tables

Retrieves a configured table.

SELECT
id,
name,
allowed_columns,
analysis_method,
analysis_rule_types,
arn,
create_time,
description,
selected_analysis_methods,
table_reference,
update_time
FROM aws.cleanrooms.configured_tables
WHERE configured_table_identifier = '{{ configured_table_identifier }}' -- required
AND region = '{{ region }}' -- required
;

Lists configured tables.

SELECT
id,
name,
analysis_method,
analysis_rule_types,
arn,
create_time,
selected_analysis_methods,
update_time
FROM aws.cleanrooms.configured_tables
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

`INSERT` examples

create_configured_table
Manifest

Creates a new configured table resource.

INSERT INTO aws.cleanrooms.configured_tables (
name,
description,
tableReference,
allowedColumns,
analysisMethod,
selectedAnalysisMethods,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ tableReference }}' /* required */,
'{{ allowedColumns }}' /* required */,
'{{ analysisMethod }}' /* required */,
'{{ selectedAnalysisMethods }}',
'{{ tags }}',
'{{ region }}'
RETURNING
configured_table
;

# Description fields are for documentation purposes
- name: configured_tables
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configured_tables resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: tableReference
    description: |
      A pointer to the dataset that underlies this table.
    value:
      glue:
        region: "{{ region }}"
        tableName: "{{ tableName }}"
        databaseName: "{{ databaseName }}"
      snowflake:
        secretArn: "{{ secretArn }}"
        accountIdentifier: "{{ accountIdentifier }}"
        databaseName: "{{ databaseName }}"
        tableName: "{{ tableName }}"
        schemaName: "{{ schemaName }}"
        tableSchema:
          v1:
            - columnName: "{{ columnName }}"
              columnType: "{{ columnType }}"
      athena:
        region: "{{ region }}"
        workGroup: "{{ workGroup }}"
        outputLocation: "{{ outputLocation }}"
        databaseName: "{{ databaseName }}"
        tableName: "{{ tableName }}"
        catalogName: "{{ catalogName }}"
  - name: allowedColumns
    value:
      - "{{ allowedColumns }}"
  - name: analysisMethod
    value: "{{ analysisMethod }}"
    valid_values: ['DIRECT_QUERY', 'DIRECT_JOB', 'MULTIPLE']
  - name: selectedAnalysisMethods
    value:
      - "{{ selectedAnalysisMethods }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Map of tags assigned to a resource

`UPDATE` examples

update_configured_table

Updates a configured table.

UPDATE aws.cleanrooms.configured_tables
SET 
name = '{{ name }}',
description = '{{ description }}',
tableReference = '{{ tableReference }}',
allowedColumns = '{{ allowedColumns }}',
analysisMethod = '{{ analysisMethod }}',
selectedAnalysisMethods = '{{ selectedAnalysisMethods }}'
WHERE 
configured_table_identifier = '{{ configured_table_identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
configured_table;

`DELETE` examples

delete_configured_table

Deletes a configured table.

DELETE FROM aws.cleanrooms.configured_tables
WHERE configured_table_identifier = '{{ configured_table_identifier }}' --required
AND region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​