CleanRoomsService / Client / get_intermediate_table_analysis_rule

get_intermediate_table_analysis_rule

CleanRoomsService.Client.get_intermediate_table_analysis_rule(**kwargs)

Retrieves the analysis rule for an intermediate table.

See also: AWS API Documentation

Request Syntax

response = client.get_intermediate_table_analysis_rule(
    membershipIdentifier='string',
    intermediateTableIdentifier='string',
    analysisRuleType='CUSTOM'
)

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 retrieve the analysis rule.

• analysisRuleType (string) –

  [REQUIRED]

  The type of analysis rule to retrieve. Currently, only CUSTOM is supported.

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 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 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.

              • (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.

Exceptions

• CleanRoomsService.Client.exceptions.ResourceNotFoundException

• CleanRoomsService.Client.exceptions.InternalServerException

• CleanRoomsService.Client.exceptions.ValidationException

• CleanRoomsService.Client.exceptions.ThrottlingException

• CleanRoomsService.Client.exceptions.AccessDeniedException