CleanRoomsService / Client / update_privacy_budget_template

update_privacy_budget_template#

CleanRoomsService.Client.update_privacy_budget_template(**kwargs)#

Updates the privacy budget template for the specified membership.

See also: AWS API Documentation

Request Syntax

response = client.update_privacy_budget_template(
    membershipIdentifier='string',
    privacyBudgetTemplateIdentifier='string',
    privacyBudgetType='DIFFERENTIAL_PRIVACY',
    parameters={
        'differentialPrivacy': {
            'epsilon': 123,
            'usersNoisePerQuery': 123
        }
    }
)
Parameters:

  • membershipIdentifier (string) –

    [REQUIRED]

    A unique identifier for one of your memberships for a collaboration. The privacy budget template is updated in the collaboration that this membership belongs to. Accepts a membership ID.

  • privacyBudgetTemplateIdentifier (string) –

    [REQUIRED]

    A unique identifier for your privacy budget template that you want to update.

  • privacyBudgetType (string) –

    [REQUIRED]

    Specifies the type of the privacy budget template.

  • parameters (dict) –

    Specifies the epsilon and noise parameters for the privacy budget template.

    Note

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

    • differentialPrivacy (dict) –

      An object that specifies the new values for the epsilon and noise parameters.

      • epsilon (integer) –

        The updated epsilon value that you want to use.

      • usersNoisePerQuery (integer) –

        The updated value of noise added per query. It 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

{
    'privacyBudgetTemplate': {
        'id': 'string',
        'arn': 'string',
        'membershipId': 'string',
        'membershipArn': 'string',
        'collaborationId': 'string',
        'collaborationArn': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'privacyBudgetType': 'DIFFERENTIAL_PRIVACY',
        'autoRefresh': 'CALENDAR_MONTH'|'NONE',
        'parameters': {
            'differentialPrivacy': {
                'epsilon': 123,
                'usersNoisePerQuery': 123
            }
        }
    }
}

Response Structure

  • (dict) –

    • privacyBudgetTemplate (dict) –

      Summary of the privacy budget template.

      • id (string) –

        The unique identifier of the privacy budget template.

      • arn (string) –

        The ARN of the privacy budget template.

      • membershipId (string) –

        The identifier for a membership resource.

      • membershipArn (string) –

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

      • collaborationId (string) –

        The unique ID of the collaboration that contains this privacy budget template.

      • collaborationArn (string) –

        The ARN of the collaboration that contains this privacy budget template.

      • createTime (datetime) –

        The time at which the privacy budget template was created.

      • updateTime (datetime) –

        The most recent time at which the privacy budget template was updated.

      • privacyBudgetType (string) –

        Specifies the type of the privacy budget template.

      • autoRefresh (string) –

        How often the privacy budget refreshes.

        Warning

        If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

      • parameters (dict) –

        Specifies the epislon and noise parameters for the privacy budget template.

        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) –

          The epsilon and noise parameters.

          • epsilon (integer) –

            The epsilon value that you specified.

          • usersNoisePerQuery (integer) –

            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.

Exceptions