intermediate_table_analysis_rules

Creates, updates, deletes, gets or lists an intermediate_table_analysis_rules resource.

Overview

Name	intermediate_table_analysis_rules
Type	Resource
Id	aws.cleanrooms.intermediate_table_analysis_rules

Fields

The following fields are returned by SELECT queries:

get_intermediate_table_analysis_rule

Name	Datatype	Description
analysis_rule_policy	object	Contains the policy for an intermediate table analysis rule.
analysis_rule_type	string	The type of the analysis rule. (CUSTOM)
create_time	string (date-time)	The time the analysis rule was created.
intermediate_table_arn	string	The Amazon Resource Name (ARN) of the intermediate table associated with this analysis rule. (pattern: <code>arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/intermediatetable/[\d\w-]+</code>)
intermediate_table_identifier	string	The unique identifier of the intermediate table associated with this analysis rule. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
update_time	string (date-time)	The time the analysis rule was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_intermediate_table_analysis_rule	select	membership_identifier, intermediate_table_identifier, analysis_rule_type, region		Retrieves the analysis rule for an intermediate table.
create_intermediate_table_analysis_rule	insert	membership_identifier, intermediate_table_identifier, region, analysisRuleType, analysisRulePolicy		Creates an analysis rule for an intermediate table. Only the CUSTOM analysis rule type is supported. Only the intermediate table owner can call this operation.
update_intermediate_table_analysis_rule	update	membership_identifier, intermediate_table_identifier, analysis_rule_type, region, analysisRulePolicy		Updates the analysis rule policy for an intermediate table. Only the intermediate table owner can call this operation.
delete_intermediate_table_analysis_rule	delete	membership_identifier, intermediate_table_identifier, analysis_rule_type, region		Deletes an analysis rule from an intermediate table. After the analysis rule is deleted, the intermediate table becomes unqueryable until a new analysis rule is attached. Only the intermediate table owner can call this operation.

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 type of analysis rule to delete. Currently, only CUSTOM is supported.
intermediate_table_identifier	string	The unique identifier of the intermediate table from which to delete the analysis rule.
membership_identifier	string	The unique identifier of the membership that contains the intermediate table.
region	string	AWS region (default: us-east-1)

SELECT examples

get_intermediate_table_analysis_rule

Retrieves the analysis rule for an intermediate table.

SELECT
analysis_rule_policy,
analysis_rule_type,
create_time,
intermediate_table_arn,
intermediate_table_identifier,
update_time
FROM aws.cleanrooms.intermediate_table_analysis_rules
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND intermediate_table_identifier = '{{ intermediate_table_identifier }}' -- required
AND analysis_rule_type = '{{ analysis_rule_type }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_intermediate_table_analysis_rule

Creates an analysis rule for an intermediate table. Only the CUSTOM analysis rule type is supported. Only the intermediate table owner can call this operation.

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

Manifest

# Description fields are for documentation purposes
- name: intermediate_table_analysis_rules
props:
  - name: membership_identifier
    value: "{{ membership_identifier }}"
    description: Required parameter for the intermediate_table_analysis_rules resource.
  - name: intermediate_table_identifier
    value: "{{ intermediate_table_identifier }}"
    description: Required parameter for the intermediate_table_analysis_rules resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the intermediate_table_analysis_rules resource.
  - name: analysisRuleType
    value: "{{ analysisRuleType }}"
    valid_values: ['CUSTOM']
  - name: analysisRulePolicy
    description: |
      Contains the policy for an intermediate table analysis rule.
    value:
      v1:
        custom:
          allowedAnalyses:
            - "{{ allowedAnalyses }}"
          additionalAnalyses: "{{ additionalAnalyses }}"
          allowedAdditionalAnalyses:
            - "{{ allowedAdditionalAnalyses }}"
          allowedAnalysisProviders:
            - "{{ allowedAnalysisProviders }}"
          allowedResultReceivers:
            - "{{ allowedResultReceivers }}"
          differentialPrivacy:
            columns:
              - name: "{{ name }}"
          disallowedOutputColumns:
            - "{{ disallowedOutputColumns }}"
          aggregationThresholds:
            - identityColumns: "{{ identityColumns }}"
              minimumIdentityCount: {{ minimumIdentityCount }}
              type_: "{{ type_ }}"
              outputColumnThresholds: "{{ outputColumnThresholds }}"
              allowedAggregateExpressionType: "{{ allowedAggregateExpressionType }}"
          comparisonControls:
            allowedLiteralComparisonColumns:
              - "{{ allowedLiteralComparisonColumns }}"
            allowedColumnComparisonColumns:
              - "{{ allowedColumnComparisonColumns }}"

UPDATE examples

update_intermediate_table_analysis_rule

Updates the analysis rule policy for an intermediate table. Only the intermediate table owner can call this operation.

UPDATE aws.cleanrooms.intermediate_table_analysis_rules
SET 
analysisRulePolicy = '{{ analysisRulePolicy }}'
WHERE 
membership_identifier = '{{ membership_identifier }}' --required
AND intermediate_table_identifier = '{{ intermediate_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_intermediate_table_analysis_rule

Deletes an analysis rule from an intermediate table. After the analysis rule is deleted, the intermediate table becomes unqueryable until a new analysis rule is attached. Only the intermediate table owner can call this operation.

DELETE FROM aws.cleanrooms.intermediate_table_analysis_rules
WHERE membership_identifier = '{{ membership_identifier }}' --required
AND intermediate_table_identifier = '{{ intermediate_table_identifier }}' --required
AND analysis_rule_type = '{{ analysis_rule_type }}' --required
AND region = '{{ region }}' --required
;