configured_table_analysis_rules

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

Overview

Name	configured_table_analysis_rules
Type	Resource
Id	aws.cleanrooms.configured_table_analysis_rules

Fields

The following fields are returned by SELECT queries:

get_configured_table_analysis_rule

Name	Datatype	Description
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>)
configured_table_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>)
create_time	string (date-time)	The time the configured table analysis rule was created.
policy	object	Controls on the query specifications that can be run on a configured table.
type_	string	The type of configured table analysis rule. (AGGREGATION, LIST, CUSTOM)
update_time	string (date-time)	The time the configured table analysis rule was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_configured_table_analysis_rule	select	configured_table_identifier, analysis_rule_type, region		Retrieves a configured table analysis rule.
create_configured_table_analysis_rule	insert	configured_table_identifier, region, analysisRuleType, analysisRulePolicy		Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.
update_configured_table_analysis_rule	update	configured_table_identifier, analysis_rule_type, region, analysisRulePolicy		Updates a configured table analysis rule.
delete_configured_table_analysis_rule	delete	configured_table_identifier, analysis_rule_type, region		Deletes a configured table analysis rule.

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
analysis_rule_type	string	The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
configured_table_identifier	string	The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.
region	string	AWS region (default: us-east-1)

SELECT examples

get_configured_table_analysis_rule

Retrieves a configured table analysis rule.

SELECT
configured_table_arn,
configured_table_id,
create_time,
policy,
type_,
update_time
FROM aws.cleanrooms.configured_table_analysis_rules
WHERE configured_table_identifier = '{{ configured_table_identifier }}' -- required
AND analysis_rule_type = '{{ analysis_rule_type }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_configured_table_analysis_rule

Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.

INSERT INTO aws.cleanrooms.configured_table_analysis_rules (
analysisRuleType,
analysisRulePolicy,
configured_table_identifier,
region
)
SELECT 
'{{ analysisRuleType }}' /* required */,
'{{ analysisRulePolicy }}' /* required */,
'{{ configured_table_identifier }}',
'{{ region }}'
RETURNING
analysis_rule
;

Manifest

# Description fields are for documentation purposes
- name: configured_table_analysis_rules
props:
  - name: configured_table_identifier
    value: "{{ configured_table_identifier }}"
    description: Required parameter for the configured_table_analysis_rules resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configured_table_analysis_rules resource.
  - name: analysisRuleType
    value: "{{ analysisRuleType }}"
    valid_values: ['AGGREGATION', 'LIST', 'CUSTOM']
  - name: analysisRulePolicy
    description: |
      Controls on the query specifications that can be run on a configured table.
    value:
      v1:
        list:
          joinColumns:
            - "{{ joinColumns }}"
          allowedJoinOperators:
            - "{{ allowedJoinOperators }}"
          listColumns:
            - "{{ listColumns }}"
          additionalAnalyses: "{{ additionalAnalyses }}"
        aggregation:
          aggregateColumns:
            - columnNames: "{{ columnNames }}"
              function: "{{ function }}"
          joinColumns:
            - "{{ joinColumns }}"
          joinRequired: "{{ joinRequired }}"
          allowedJoinOperators:
            - "{{ allowedJoinOperators }}"
          dimensionColumns:
            - "{{ dimensionColumns }}"
          scalarFunctions:
            - "{{ scalarFunctions }}"
          outputConstraints:
            - columnName: "{{ columnName }}"
              minimum_: {{ minimum_ }}
              type_: "{{ type_ }}"
          additionalAnalyses: "{{ additionalAnalyses }}"
        custom:
          allowedAnalyses:
            - "{{ allowedAnalyses }}"
          allowedAnalysisProviders:
            - "{{ allowedAnalysisProviders }}"
          additionalAnalyses: "{{ additionalAnalyses }}"
          disallowedOutputColumns:
            - "{{ disallowedOutputColumns }}"
          differentialPrivacy:
            columns:
              - name: "{{ name }}"
          aggregationThresholds:
            - identityColumns: "{{ identityColumns }}"
              minimumIdentityCount: {{ minimumIdentityCount }}
              type_: "{{ type_ }}"
              outputColumnThresholds: "{{ outputColumnThresholds }}"
              allowedAggregateExpressionType: "{{ allowedAggregateExpressionType }}"
          comparisonControls:
            allowedLiteralComparisonColumns:
              - "{{ allowedLiteralComparisonColumns }}"
            allowedColumnComparisonColumns:
              - "{{ allowedColumnComparisonColumns }}"
          allowedResultReceivers:
            - "{{ allowedResultReceivers }}"
          allowedAdditionalAnalyses:
            - "{{ allowedAdditionalAnalyses }}"

UPDATE examples

update_configured_table_analysis_rule

Updates a configured table analysis rule.

UPDATE aws.cleanrooms.configured_table_analysis_rules
SET 
analysisRulePolicy = '{{ analysisRulePolicy }}'
WHERE 
configured_table_identifier = '{{ configured_table_identifier }}' --required
AND analysis_rule_type = '{{ analysis_rule_type }}' --required
AND region = '{{ region }}' --required
AND analysisRulePolicy = '{{ analysisRulePolicy }}' --required
RETURNING
analysis_rule;

DELETE examples

delete_configured_table_analysis_rule

Deletes a configured table analysis rule.

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