AWS Clean Rooms Service

2024/04/10 - AWS Clean Rooms Service - 5 updated api methods

Changes  AWS Clean Rooms Differential Privacy is now fully available. Differential privacy protects against user-identification attempts.

BatchGetCollaborationAnalysisTemplate (updated) Link ¶
Changes (response) 
{'collaborationAnalysisTemplates': {'validations': [{'reasons': [{'message': 'string'}],
                                                     'status': 'VALID | '
                                                               'INVALID | '
                                                               'UNABLE_TO_VALIDATE',
                                                     'type': 'DIFFERENTIAL_PRIVACY'}]}}

Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).

See also: AWS API Documentation

Request Syntax

client.batch_get_collaboration_analysis_template(
    collaborationIdentifier='string',
    analysisTemplateArns=[
        'string',
    ]
)
type collaborationIdentifier:

string

param collaborationIdentifier:

[REQUIRED]

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

type analysisTemplateArns:

list

param analysisTemplateArns:

[REQUIRED]

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

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'collaborationAnalysisTemplates': [
        {
            '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',
                    'defaultValue': 'string'
                },
            ],
            'validations': [
                {
                    'type': 'DIFFERENTIAL_PRIVACY',
                    'status': 'VALID'|'INVALID'|'UNABLE_TO_VALIDATE',
                    'reasons': [
                        {
                            'message': 'string'
                        },
                    ]
                },
            ]
        },
    ],
    'errors': [
        {
            'arn': 'string',
            'code': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • collaborationAnalysisTemplates (list) --

      The retrieved list of analysis templates within a collaboration.

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

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

    • errors (list) --

      Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.

      • (dict) --

        Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.

        • arn (string) --

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

        • code (string) --

          An error code for the error.

        • message (string) --

          A description of why the call failed.

CreateAnalysisTemplate (updated) Link ¶
Changes (response) 
{'analysisTemplate': {'validations': [{'reasons': [{'message': 'string'}],
                                       'status': 'VALID | INVALID | '
                                                 'UNABLE_TO_VALIDATE',
                                       'type': 'DIFFERENTIAL_PRIVACY'}]}}

Creates a new analysis template.

See also: AWS API Documentation

Request Syntax

client.create_analysis_template(
    description='string',
    membershipIdentifier='string',
    name='string',
    format='SQL',
    source={
        'text': 'string'
    },
    tags={
        'string': 'string'
    },
    analysisParameters=[
        {
            'name': 'string',
            'type': 'SMALLINT'|'INTEGER'|'BIGINT'|'DECIMAL'|'REAL'|'DOUBLE_PRECISION'|'BOOLEAN'|'CHAR'|'VARCHAR'|'DATE'|'TIMESTAMP'|'TIMESTAMPTZ'|'TIME'|'TIMETZ'|'VARBYTE',
            'defaultValue': 'string'
        },
    ]
)
type description:

string

param description:

The description of the analysis template.

type membershipIdentifier:

string

param membershipIdentifier:

[REQUIRED]

The identifier for a membership resource.

type name:

string

param name:

[REQUIRED]

The name of the analysis template.

type format:

string

param format:

[REQUIRED]

The format of the analysis template.

type source:

dict

param source:

[REQUIRED]

The information in the analysis template. Currently supports text, the query text for the analysis template.

  • text (string) --

    The query text.

type tags:

dict

param tags:

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

  • (string) --

    • (string) --

type analysisParameters:

list

param analysisParameters:

The parameters of 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) -- [REQUIRED]

      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) -- [REQUIRED]

      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.

rtype:

dict

returns:

Response Syntax

{
    'analysisTemplate': {
        'id': 'string',
        'arn': 'string',
        'collaborationId': 'string',
        'collaborationArn': 'string',
        'membershipId': 'string',
        'membershipArn': 'string',
        'description': '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',
                'defaultValue': 'string'
            },
        ],
        'validations': [
            {
                'type': 'DIFFERENTIAL_PRIVACY',
                'status': 'VALID'|'INVALID'|'UNABLE_TO_VALIDATE',
                'reasons': [
                    {
                        'message': 'string'
                    },
                ]
            },
        ]
    }
}

Response Structure

  • (dict) --

    • analysisTemplate (dict) --

      The analysis template.

      • id (string) --

        The identifier for the analysis template.

      • arn (string) --

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

      • collaborationId (string) --

        The unique ID for the associated collaboration of the analysis template.

      • collaborationArn (string) --

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

      • membershipId (string) --

        The identifier of a member who created the analysis template.

      • membershipArn (string) --

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

      • description (string) --

        The description of the analysis template.

      • name (string) --

        The name of the analysis template.

      • createTime (datetime) --

        The time that the analysis template was created.

      • updateTime (datetime) --

        The time that the analysis template 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.

      • source (dict) --

        The source of the analysis template.

        • text (string) --

          The query text.

      • analysisParameters (list) --

        The parameters of 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) --

        Information about the validations performed on the analysis template.

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

GetAnalysisTemplate (updated) Link ¶
Changes (response) 
{'analysisTemplate': {'validations': [{'reasons': [{'message': 'string'}],
                                       'status': 'VALID | INVALID | '
                                                 'UNABLE_TO_VALIDATE',
                                       'type': 'DIFFERENTIAL_PRIVACY'}]}}

Retrieves an analysis template.

See also: AWS API Documentation

Request Syntax

client.get_analysis_template(
    membershipIdentifier='string',
    analysisTemplateIdentifier='string'
)
type membershipIdentifier:

string

param membershipIdentifier:

[REQUIRED]

The identifier for a membership resource.

type analysisTemplateIdentifier:

string

param analysisTemplateIdentifier:

[REQUIRED]

The identifier for the analysis template resource.

rtype:

dict

returns:

Response Syntax

{
    'analysisTemplate': {
        'id': 'string',
        'arn': 'string',
        'collaborationId': 'string',
        'collaborationArn': 'string',
        'membershipId': 'string',
        'membershipArn': 'string',
        'description': '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',
                'defaultValue': 'string'
            },
        ],
        'validations': [
            {
                'type': 'DIFFERENTIAL_PRIVACY',
                'status': 'VALID'|'INVALID'|'UNABLE_TO_VALIDATE',
                'reasons': [
                    {
                        'message': 'string'
                    },
                ]
            },
        ]
    }
}

Response Structure

  • (dict) --

    • analysisTemplate (dict) --

      The analysis template.

      • id (string) --

        The identifier for the analysis template.

      • arn (string) --

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

      • collaborationId (string) --

        The unique ID for the associated collaboration of the analysis template.

      • collaborationArn (string) --

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

      • membershipId (string) --

        The identifier of a member who created the analysis template.

      • membershipArn (string) --

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

      • description (string) --

        The description of the analysis template.

      • name (string) --

        The name of the analysis template.

      • createTime (datetime) --

        The time that the analysis template was created.

      • updateTime (datetime) --

        The time that the analysis template 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.

      • source (dict) --

        The source of the analysis template.

        • text (string) --

          The query text.

      • analysisParameters (list) --

        The parameters of 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) --

        Information about the validations performed on the analysis template.

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

GetCollaborationAnalysisTemplate (updated) Link ¶
Changes (response) 
{'collaborationAnalysisTemplate': {'validations': [{'reasons': [{'message': 'string'}],
                                                    'status': 'VALID | INVALID '
                                                              '| '
                                                              'UNABLE_TO_VALIDATE',
                                                    'type': 'DIFFERENTIAL_PRIVACY'}]}}

Retrieves an analysis template within a collaboration.

See also: AWS API Documentation

Request Syntax

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

string

param collaborationIdentifier:

[REQUIRED]

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

type analysisTemplateArn:

string

param analysisTemplateArn:

[REQUIRED]

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

rtype:

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

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

UpdateAnalysisTemplate (updated) Link ¶
Changes (response) 
{'analysisTemplate': {'validations': [{'reasons': [{'message': 'string'}],
                                       'status': 'VALID | INVALID | '
                                                 'UNABLE_TO_VALIDATE',
                                       'type': 'DIFFERENTIAL_PRIVACY'}]}}

Updates the analysis template metadata.

See also: AWS API Documentation

Request Syntax

client.update_analysis_template(
    membershipIdentifier='string',
    analysisTemplateIdentifier='string',
    description='string'
)
type membershipIdentifier:

string

param membershipIdentifier:

[REQUIRED]

The identifier for a membership resource.

type analysisTemplateIdentifier:

string

param analysisTemplateIdentifier:

[REQUIRED]

The identifier for the analysis template resource.

type description:

string

param description:

A new description for the analysis template.

rtype:

dict

returns:

Response Syntax

{
    'analysisTemplate': {
        'id': 'string',
        'arn': 'string',
        'collaborationId': 'string',
        'collaborationArn': 'string',
        'membershipId': 'string',
        'membershipArn': 'string',
        'description': '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',
                'defaultValue': 'string'
            },
        ],
        'validations': [
            {
                'type': 'DIFFERENTIAL_PRIVACY',
                'status': 'VALID'|'INVALID'|'UNABLE_TO_VALIDATE',
                'reasons': [
                    {
                        'message': 'string'
                    },
                ]
            },
        ]
    }
}

Response Structure

  • (dict) --

    • analysisTemplate (dict) --

      The analysis template.

      • id (string) --

        The identifier for the analysis template.

      • arn (string) --

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

      • collaborationId (string) --

        The unique ID for the associated collaboration of the analysis template.

      • collaborationArn (string) --

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

      • membershipId (string) --

        The identifier of a member who created the analysis template.

      • membershipArn (string) --

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

      • description (string) --

        The description of the analysis template.

      • name (string) --

        The name of the analysis template.

      • createTime (datetime) --

        The time that the analysis template was created.

      • updateTime (datetime) --

        The time that the analysis template 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.

      • source (dict) --

        The source of the analysis template.

        • text (string) --

          The query text.

      • analysisParameters (list) --

        The parameters of 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) --

        Information about the validations performed on the analysis template.

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