schema_analysis_rules

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

Overview

Name	schema_analysis_rules
Type	Resource
Id	aws.cleanrooms.schema_analysis_rules

Fields

The following fields are returned by SELECT queries:

get_schema_analysis_rule

Name	Datatype	Description
name	string	The name for the analysis rule. (pattern: <code>[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?</code>)
collaboration_id	string	The unique ID for the associated collaboration. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
collaboration_policy	object	Controls on the query specifications that can be run on an associated configured table.
consolidated_policy	object	The consolidated policy for the analysis rule.
create_time	string (date-time)	The time the analysis rule was created.
policy	object	A policy that describes the associated data usage limitations.
type_	string	The type of analysis rule. (AGGREGATION, LIST, CUSTOM, ID_MAPPING_TABLE)
update_time	string (date-time)	The time the analysis rule was last updated.

batch_get_schema_analysis_rule

Name	Datatype	Description
analysis_rules	array	The retrieved list of analysis rules.
errors	array	Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_schema_analysis_rule	select	collaboration_identifier, name, type, region		Retrieves a schema analysis rule.
batch_get_schema_analysis_rule	select	collaboration_identifier, region		Retrieves multiple analysis rule schemas.

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
collaboration_identifier	string	The unique identifier of the collaboration that contains the schema analysis rule.
name	string	The name of the schema to retrieve the analysis rule for.
region	string	AWS region (default: us-east-1)
type	string	The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.

SELECT examples

get_schema_analysis_rule

Retrieves a schema analysis rule.

SELECT
name,
collaboration_id,
collaboration_policy,
consolidated_policy,
create_time,
policy,
type_,
update_time
FROM aws.cleanrooms.schema_analysis_rules
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND name = '{{ name }}' -- required
AND type = '{{ type }}' -- required
AND region = '{{ region }}' -- required
;

batch_get_schema_analysis_rule

Retrieves multiple analysis rule schemas.

SELECT
analysis_rules,
errors
FROM aws.cleanrooms.schema_analysis_rules
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND region = '{{ region }}' -- required
;