CleanRoomsService / Client / create_privacy_budget_template

create_privacy_budget_template

CleanRoomsService.Client.create_privacy_budget_template(**kwargs)

Creates a privacy budget template for a specified membership. Each membership can have only one privacy budget template, but it can be deleted and recreated. If you need to change the privacy budget template for a membership, use the UpdatePrivacyBudgetTemplate operation.

See also: AWS API Documentation

Request Syntax

response = client.create_privacy_budget_template(
    membershipIdentifier='string',
    autoRefresh='CALENDAR_MONTH'|'NONE',
    privacyBudgetType='DIFFERENTIAL_PRIVACY',
    parameters={
        'differentialPrivacy': {
            'epsilon': 123,
            'usersNoisePerQuery': 123
        }
    },
    tags={
        'string': 'string'
    }
)

Parameters:

• membershipIdentifier (string) –

  [REQUIRED]

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

• autoRefresh (string) –

  [REQUIRED]

  How often the privacy budget refreshes.

  Warning

  If you plan to regularly bring new data into the collaboration, you can 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 queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

• privacyBudgetType (string) –

  [REQUIRED]

  Specifies the type of the privacy budget template.

• parameters (dict) –

  [REQUIRED]

  Specifies your 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 epsilon and noise parameters.

    • epsilon (integer) – [REQUIRED]

      The epsilon value that you want to use.

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

• tags (dict) –

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

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

    A summary of the elements in 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

• CleanRoomsService.Client.exceptions.ConflictException

• CleanRoomsService.Client.exceptions.ResourceNotFoundException

• CleanRoomsService.Client.exceptions.InternalServerException

• CleanRoomsService.Client.exceptions.ValidationException

• CleanRoomsService.Client.exceptions.ThrottlingException

• CleanRoomsService.Client.exceptions.AccessDeniedException