CleanRoomsService / Client / update_intermediate_table_analysis_rule

update_intermediate_table_analysis_rule¶

CleanRoomsService.Client.update_intermediate_table_analysis_rule(**kwargs)¶

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

Request Syntax

response = client.update_intermediate_table_analysis_rule(
    membershipIdentifier='string',
    intermediateTableIdentifier='string',
    analysisRuleType='CUSTOM',
    analysisRulePolicy={
        'v1': {
            'custom': {
                'allowedAnalyses': [
                    'string',
                ],
                'additionalAnalyses': 'ALLOWED'|'REQUIRED'|'NOT_ALLOWED',
                'allowedAdditionalAnalyses': [
                    'string',
                ],
                'allowedAnalysisProviders': [
                    'string',
                ],
                'allowedResultReceivers': [
                    'string',
                ],
                'differentialPrivacy': {
                    'columns': [
                        {
                            'name': 'string'
                        },
                    ]
                },
                'disallowedOutputColumns': [
                    'string',
                ]
            }
        }
    }
)

Parameters:

membershipIdentifier (string) –
[REQUIRED]

The unique identifier of the membership that contains the intermediate table.
intermediateTableIdentifier (string) –
[REQUIRED]

The unique identifier of the intermediate table for which to update the analysis rule.
analysisRuleType (string) –
[REQUIRED]

The type of analysis rule to update. Currently, only CUSTOM is supported.
analysisRulePolicy (dict) –
[REQUIRED]

The updated analysis rule policy for the intermediate table.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: v1.
- v1 (dict) –
  
  The version 1 policy for the analysis rule.
  
  Note
  This is a Tagged Union structure. Only one of the following top level keys can be set: custom.
  - custom (dict) –
    
    The custom analysis rule policy.
    - allowedAnalyses (list) –
      
      The list of allowed analyses that can be performed on the intermediate table.
      - (string) –
    - additionalAnalyses (string) –
      
      The setting that controls whether additional analyses are allowed on the intermediate table.
    - allowedAdditionalAnalyses (list) –
      
      The list of allowed additional analyses for the intermediate table.
      - (string) –
    - allowedAnalysisProviders (list) –
      
      The list of Amazon Web Services account IDs for the allowed analysis providers.
      - (string) –
    - allowedResultReceivers (list) –
      
      The list of Amazon Web Services account IDs that are allowed to receive results from queries run on the intermediate table.
      - (string) –
    - differentialPrivacy (dict) –
      
      Specifies the unique identifier for your users.
      - columns (list) – [REQUIRED]
        
        The name of the column (such as user_id) that contains the unique identifier of your users whose privacy you want to protect. If you want to turn on diﬀerential privacy for two or more tables in a collaboration, you must conﬁgure the same column as the user identiﬁer column in both analysis rules.
        
        (dict) –
        
        Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect.
        
        name (string) – [REQUIRED]
        
        The name of the column, such as user_id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.
    - disallowedOutputColumns (list) –
      
      The list of columns that are not allowed in the query output.
      - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'analysisRule': {
        'intermediateTableIdentifier': 'string',
        'intermediateTableArn': 'string',
        'analysisRulePolicy': {
            'v1': {
                'custom': {
                    'allowedAnalyses': [
                        'string',
                    ],
                    'additionalAnalyses': 'ALLOWED'|'REQUIRED'|'NOT_ALLOWED',
                    'allowedAdditionalAnalyses': [
                        'string',
                    ],
                    'allowedAnalysisProviders': [
                        'string',
                    ],
                    'allowedResultReceivers': [
                        'string',
                    ],
                    'differentialPrivacy': {
                        'columns': [
                            {
                                'name': 'string'
                            },
                        ]
                    },
                    'disallowedOutputColumns': [
                        'string',
                    ]
                }
            }
        },
        'analysisRuleType': 'CUSTOM',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –
- analysisRule (dict) –
  
  The updated analysis rule for the intermediate table.
  - intermediateTableIdentifier (string) –
    
    The unique identifier of the intermediate table associated with this analysis rule.
  - intermediateTableArn (string) –
    
    The Amazon Resource Name (ARN) of the intermediate table associated with this analysis rule.
  - analysisRulePolicy (dict) –
    
    The policy of the 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 version 1 policy for the analysis rule.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: 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'}
      - custom (dict) –
        
        The custom analysis rule policy.
        
        allowedAnalyses (list) –
        
        The list of allowed analyses that can be performed on the intermediate table.
        
        (string) –
        
        additionalAnalyses (string) –
        
        The setting that controls whether additional analyses are allowed on the intermediate table.
        
        allowedAdditionalAnalyses (list) –
        
        The list of allowed additional analyses for the intermediate table.
        
        (string) –
        
        allowedAnalysisProviders (list) –
        
        The list of Amazon Web Services account IDs for the allowed analysis providers.
        
        (string) –
        
        allowedResultReceivers (list) –
        
        The list of Amazon Web Services account IDs that are allowed to receive results from queries run on the intermediate table.
        
        (string) –
        
        differentialPrivacy (dict) –
        
        Specifies the unique identifier for your users.
        
        columns (list) –
        
        The name of the column (such as user_id) that contains the unique identifier of your users whose privacy you want to protect. If you want to turn on diﬀerential privacy for two or more tables in a collaboration, you must conﬁgure the same column as the user identiﬁer column in both analysis rules.
        
        (dict) –
        
        Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect.
        
        name (string) –
        
        The name of the column, such as user_id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.
        
        disallowedOutputColumns (list) –
        
        The list of columns that are not allowed in the query output.
        
        (string) –
  - analysisRuleType (string) –
    
    The type of the analysis rule.
  - createTime (datetime) –
    
    The time the analysis rule was created.
  - updateTime (datetime) –
    
    The time the analysis rule was last updated.

update_intermediate_table_analysis_rule¶

Request Syntax

Note

Note

Response Syntax

Response Structure

Note

Note

Exceptions