:doc:`CleanRoomsService <../../cleanrooms>` / Client / get_configured_table_association_analysis_rule

**********************************************
get_configured_table_association_analysis_rule
**********************************************



.. py:method:: CleanRoomsService.Client.get_configured_table_association_analysis_rule(**kwargs)

  

  Retrieves the analysis rule for a configured table association.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/GetConfiguredTableAssociationAnalysisRule>`_  


  **Request Syntax**
  ::

    response = client.get_configured_table_association_analysis_rule(
        membershipIdentifier='string',
        configuredTableAssociationIdentifier='string',
        analysisRuleType='AGGREGATION'|'LIST'|'CUSTOM'
    )
    
  :type membershipIdentifier: string
  :param membershipIdentifier: **[REQUIRED]** 

    A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.

    

  
  :type configuredTableAssociationIdentifier: string
  :param configuredTableAssociationIdentifier: **[REQUIRED]** 

    The identiﬁer for the conﬁgured table association that's related to the analysis rule.

    

  
  :type analysisRuleType: string
  :param analysisRuleType: **[REQUIRED]** 

    The type of analysis rule that you want to retrieve.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'analysisRule': {
              'membershipIdentifier': 'string',
              'configuredTableAssociationId': 'string',
              'configuredTableAssociationArn': 'string',
              'policy': {
                  'v1': {
                      'list': {
                          'allowedResultReceivers': [
                              'string',
                          ],
                          'allowedAdditionalAnalyses': [
                              'string',
                          ]
                      },
                      'aggregation': {
                          'allowedResultReceivers': [
                              'string',
                          ],
                          'allowedAdditionalAnalyses': [
                              'string',
                          ]
                      },
                      'custom': {
                          'allowedResultReceivers': [
                              'string',
                          ],
                          'allowedAdditionalAnalyses': [
                              'string',
                          ]
                      }
                  }
              },
              'type': 'AGGREGATION'|'LIST'|'CUSTOM',
              'createTime': datetime(2015, 1, 1),
              'updateTime': datetime(2015, 1, 1)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **analysisRule** *(dict) --* 

        The analysis rule for the conﬁgured table association. In the console, the ``ConfiguredTableAssociationAnalysisRule`` is referred to as the *collaboration analysis rule*.

        
        

        - **membershipIdentifier** *(string) --* 

          The membership identifier for the configured table association analysis rule.

          
        

        - **configuredTableAssociationId** *(string) --* 

          The unique identifier for the configured table association.

          
        

        - **configuredTableAssociationArn** *(string) --* 

          The Amazon Resource Name (ARN) of the configured table association.

          
        

        - **policy** *(dict) --* 

          The policy of the configured table association analysis rule.

          .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``v1``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


        
          

          - **v1** *(dict) --* 

            The policy for the configured table association analysis rule.

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``list``, ``aggregation``, ``custom``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


          
            

            - **list** *(dict) --* 

              Analysis rule type that enables only list queries on a configured table.

              
              

              - **allowedResultReceivers** *(list) --* 

                The list of collaboration members who are allowed to receive results of queries run with this configured table.

                
                

                - *(string) --* 
            
              

              - **allowedAdditionalAnalyses** *(list) --* 

                The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

                
                

                - *(string) --* 
            
          
            

            - **aggregation** *(dict) --* 

              Analysis rule type that enables only aggregation queries on a configured table.

              
              

              - **allowedResultReceivers** *(list) --* 

                The list of collaboration members who are allowed to receive results of queries run with this configured table.

                
                

                - *(string) --* 
            
              

              - **allowedAdditionalAnalyses** *(list) --* 

                The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

                 

                The ``allowedAdditionalAnalyses`` parameter is currently supported for the list analysis rule ( ``AnalysisRuleList``) and the custom analysis rule ( ``AnalysisRuleCustom``).

                
                

                - *(string) --* 
            
          
            

            - **custom** *(dict) --* 

              Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.

              
              

              - **allowedResultReceivers** *(list) --* 

                The list of collaboration members who are allowed to receive results of queries run with this configured table.

                
                

                - *(string) --* 
            
              

              - **allowedAdditionalAnalyses** *(list) --* 

                The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.

                
                

                - *(string) --* 
            
          
        
      
        

        - **type** *(string) --* 

          The type of the configured table association analysis rule.

          
        

        - **createTime** *(datetime) --* 

          The creation time of the configured table association analysis rule.

          
        

        - **updateTime** *(datetime) --* 

          The update time of the configured table association analysis rule.

          
    
  
  **Exceptions**
  
  *   :py:class:`CleanRoomsService.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CleanRoomsService.Client.exceptions.InternalServerException`

  
  *   :py:class:`CleanRoomsService.Client.exceptions.ValidationException`

  
  *   :py:class:`CleanRoomsService.Client.exceptions.ThrottlingException`

  
  *   :py:class:`CleanRoomsService.Client.exceptions.AccessDeniedException`

  