CleanRoomsService / Client / preview_privacy_impact

preview_privacy_impact#

CleanRoomsService.Client.preview_privacy_impact(**kwargs)#

An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.

See also: AWS API Documentation

Request Syntax

response = client.preview_privacy_impact(
    membershipIdentifier='string',
    parameters={
        'differentialPrivacy': {
            'epsilon': 123,
            'usersNoisePerQuery': 123
        }
    }
)
Parameters:

  • membershipIdentifier (string) –

    [REQUIRED]

    A unique identifier for one of your memberships for a collaboration. Accepts a membership ID.

  • parameters (dict) –

    [REQUIRED]

    Specifies the desired epsilon and noise parameters to preview.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: differentialPrivacy.

    • differentialPrivacy (dict) –

      An array that specifies the epsilon and noise parameters.

      • epsilon (integer) – [REQUIRED]

        The epsilon value that you want to preview.

      • usersNoisePerQuery (integer) – [REQUIRED]

        Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.

Return type:

dict

Returns:

Response Syntax

{
    'privacyImpact': {
        'differentialPrivacy': {
            'aggregations': [
                {
                    'type': 'AVG'|'COUNT'|'COUNT_DISTINCT'|'SUM'|'STDDEV',
                    'maxCount': 123
                },
            ]
        }
    }
}

Response Structure

  • (dict) –

    • privacyImpact (dict) –

      An estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters. This does not change the privacy budget.

      Note

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

      • differentialPrivacy (dict) –

        An object that lists the number and type of aggregation functions you can perform.

        • aggregations (list) –

          The number of aggregation functions that you can perform.

          • (dict) –

            Provides an estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.

            • type (string) –

              The type of aggregation function.

            • maxCount (integer) –

              The maximum number of aggregations that the member who can query can run given the epsilon and noise parameters.

Exceptions