configured_table_association_analysis_rules

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

Overview

Name	configured_table_association_analysis_rules
Type	Resource
Id	aws.cleanrooms.configured_table_association_analysis_rules

Fields

The following fields are returned by SELECT queries:

get_configured_table_association_analysis_rule

Name	Datatype	Description
configured_table_association_arn	string	The Amazon Resource Name (ARN) of the configured table association. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:configuredtableassociation/[\d\w-]+/[\d\w-]+</code>)
configured_table_association_id	string	The unique identifier for the configured table association. (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 creation time of the configured table association analysis rule.
membership_identifier	string	The membership identifier for the configured table association 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>)
policy	object	Controls on the query specifications that can be run on an associated configured table.
type_	string	The type of the configured table association analysis rule. (AGGREGATION, LIST, CUSTOM)
update_time	string (date-time)	The update time of the configured table association analysis rule.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_configured_table_association_analysis_rule	select	membership_identifier, configured_table_association_identifier, analysis_rule_type, region		Retrieves the analysis rule for a configured table association.
create_configured_table_association_analysis_rule	insert	membership_identifier, configured_table_association_identifier, region, analysisRuleType, analysisRulePolicy		Creates a new analysis rule for an associated configured table.
update_configured_table_association_analysis_rule	update	membership_identifier, configured_table_association_identifier, analysis_rule_type, region, analysisRulePolicy		Updates the analysis rule for a configured table association.
delete_configured_table_association_analysis_rule	delete	membership_identifier, configured_table_association_identifier, analysis_rule_type, region		Deletes an analysis rule for a configured table association.

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 the analysis rule that you want to delete.
configured_table_association_identifier	string	The identifier for the configured table association that's related to the analysis rule that you want to delete.
membership_identifier	string	A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
region	string	AWS region (default: us-east-1)

SELECT examples

get_configured_table_association_analysis_rule

Retrieves the analysis rule for a configured table association.

SELECT
configured_table_association_arn,
configured_table_association_id,
create_time,
membership_identifier,
policy,
type_,
update_time
FROM aws.cleanrooms.configured_table_association_analysis_rules
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND configured_table_association_identifier = '{{ configured_table_association_identifier }}' -- required
AND analysis_rule_type = '{{ analysis_rule_type }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_configured_table_association_analysis_rule

Creates a new analysis rule for an associated configured table.

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

Manifest

# Description fields are for documentation purposes
- name: configured_table_association_analysis_rules
props:
  - name: membership_identifier
    value: "{{ membership_identifier }}"
    description: Required parameter for the configured_table_association_analysis_rules resource.
  - name: configured_table_association_identifier
    value: "{{ configured_table_association_identifier }}"
    description: Required parameter for the configured_table_association_analysis_rules resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configured_table_association_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 an associated configured table.
    value:
      v1:
        list:
          allowedResultReceivers:
            - "{{ allowedResultReceivers }}"
          allowedAdditionalAnalyses:
            - "{{ allowedAdditionalAnalyses }}"
        aggregation:
          allowedResultReceivers:
            - "{{ allowedResultReceivers }}"
          allowedAdditionalAnalyses:
            - "{{ allowedAdditionalAnalyses }}"
        custom:
          allowedResultReceivers:
            - "{{ allowedResultReceivers }}"
          allowedAdditionalAnalyses:
            - "{{ allowedAdditionalAnalyses }}"

UPDATE examples

update_configured_table_association_analysis_rule

Updates the analysis rule for a configured table association.

UPDATE aws.cleanrooms.configured_table_association_analysis_rules
SET 
analysisRulePolicy = '{{ analysisRulePolicy }}'
WHERE 
membership_identifier = '{{ membership_identifier }}' --required
AND configured_table_association_identifier = '{{ configured_table_association_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_association_analysis_rule

Deletes an analysis rule for a configured table association.

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