CleanRoomsService / Client / get_collaboration_analysis_template

get_collaboration_analysis_template#

CleanRoomsService.Client.get_collaboration_analysis_template(**kwargs)#

Retrieves an analysis template within a collaboration.

See also: AWS API Documentation

Request Syntax

response = client.get_collaboration_analysis_template(
    collaborationIdentifier='string',
    analysisTemplateArn='string'
)
Parameters:

  • collaborationIdentifier (string) –

    [REQUIRED]

    A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

  • analysisTemplateArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

Return type:

dict

Returns:

Response Syntax

{
    'collaborationAnalysisTemplate': {
        'id': 'string',
        'arn': 'string',
        'collaborationId': 'string',
        'collaborationArn': 'string',
        'description': 'string',
        'creatorAccountId': 'string',
        'name': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'schema': {
            'referencedTables': [
                'string',
            ]
        },
        'format': 'SQL',
        'source': {
            'text': 'string'
        },
        'analysisParameters': [
            {
                'name': 'string',
                'type': 'SMALLINT'|'INTEGER'|'BIGINT'|'DECIMAL'|'REAL'|'DOUBLE_PRECISION'|'BOOLEAN'|'CHAR'|'VARCHAR'|'DATE'|'TIMESTAMP'|'TIMESTAMPTZ'|'TIME'|'TIMETZ'|'VARBYTE'|'BINARY'|'BYTE'|'CHARACTER'|'DOUBLE'|'FLOAT'|'INT'|'LONG'|'NUMERIC'|'SHORT'|'STRING'|'TIMESTAMP_LTZ'|'TIMESTAMP_NTZ'|'TINYINT',
                'defaultValue': 'string'
            },
        ],
        'validations': [
            {
                'type': 'DIFFERENTIAL_PRIVACY',
                'status': 'VALID'|'INVALID'|'UNABLE_TO_VALIDATE',
                'reasons': [
                    {
                        'message': 'string'
                    },
                ]
            },
        ]
    }
}

Response Structure

  • (dict) –

    • collaborationAnalysisTemplate (dict) –

      The analysis template within a collaboration.

      • id (string) –

        The identifier of the analysis template.

      • arn (string) –

        The Amazon Resource Name (ARN) of the analysis template.

      • collaborationId (string) –

        A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

      • collaborationArn (string) –

        The unique ARN for the analysis template’s associated collaboration.

      • description (string) –

        The description of the analysis template.

      • creatorAccountId (string) –

        The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

      • name (string) –

        The name of the analysis template.

      • createTime (datetime) –

        The time that the analysis template within a collaboration was created.

      • updateTime (datetime) –

        The time that the analysis template in the collaboration was last updated.

      • schema (dict) –

        The entire schema object.

        • referencedTables (list) –

          The tables referenced in the analysis schema.

          • (string) –

      • format (string) –

        The format of the analysis template in the collaboration.

      • source (dict) –

        The source of the analysis template within a collaboration.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: text. 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'}

        • text (string) –

          The query text.

      • analysisParameters (list) –

        The analysis parameters that have been specified in the analysis template.

        • (dict) –

          Optional. The member who can query can provide this placeholder for a literal data value in an analysis template.

          • name (string) –

            The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.

          • type (string) –

            The type of parameter.

          • defaultValue (string) –

            Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.

      • validations (list) –

        The validations that were performed.

        • (dict) –

          The status details of the analysis template validation. Clean Rooms Differential Privacy uses a general-purpose query structure to support complex SQL queries and validates whether an analysis template fits that general-purpose query structure. Validation is performed when analysis templates are created and fetched. Because analysis templates are immutable by design, we recommend that you create analysis templates after you associate the configured tables with their analysis rule to your collaboration.

          For more information, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy.

          • type (string) –

            The type of validation that was performed.

          • status (string) –

            The status of the validation.

          • reasons (list) –

            The reasons for the validation results.

            • (dict) –

              The reasons for the validation results.

              • message (string) –

                The validation message.

Exceptions