CleanRoomsService / Client / list_privacy_budgets

list_privacy_budgets

CleanRoomsService.Client.list_privacy_budgets(**kwargs)

Returns detailed information about the privacy budgets in a specified membership.

See also: AWS API Documentation

Request Syntax

response = client.list_privacy_budgets(
    membershipIdentifier='string',
    privacyBudgetType='DIFFERENTIAL_PRIVACY',
    nextToken='string',
    maxResults=123
)

Parameters:

• membershipIdentifier (string) –

  [REQUIRED]

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

• privacyBudgetType (string) –

  [REQUIRED]

  The privacy budget type.

• nextToken (string) – The pagination token that’s used to fetch the next set of results.

• maxResults (integer) – The maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a nextToken even if the maxResults value has not been met.

Return type:

dict

Returns:

Response Syntax

{
    'privacyBudgetSummaries': [
        {
            'id': 'string',
            'privacyBudgetTemplateId': 'string',
            'privacyBudgetTemplateArn': 'string',
            'membershipId': 'string',
            'membershipArn': 'string',
            'collaborationId': 'string',
            'collaborationArn': 'string',
            'type': 'DIFFERENTIAL_PRIVACY',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'budget': {
                'differentialPrivacy': {
                    'aggregations': [
                        {
                            'type': 'AVG'|'COUNT'|'COUNT_DISTINCT'|'SUM'|'STDDEV',
                            'maxCount': 123,
                            'remainingCount': 123
                        },
                    ],
                    'epsilon': 123
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • privacyBudgetSummaries (list) –

    An array that summarizes the privacy budgets. The summary includes collaboration information, membership information, privacy budget template information, and privacy budget details.

    • (dict) –

      An array that summaries the specified privacy budget. This summary includes collaboration information, creation information, membership information, and privacy budget information.

      • id (string) –

        The unique identifier of the privacy budget.

      • privacyBudgetTemplateId (string) –

        The unique identifier of the privacy budget template.

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

      • collaborationId (string) –

        The unique identifier of the collaboration that contains this privacy budget.

      • collaborationArn (string) –

        The ARN of the collaboration that contains this privacy budget.

      • type (string) –

        Specifies the type of the privacy budget.

      • createTime (datetime) –

        The time at which the privacy budget was created.

      • updateTime (datetime) –

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

      • budget (dict) –

        The provided 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 specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.

          • aggregations (list) –

            This information includes the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations.

            • (dict) –

              Information about the total number of aggregations, as well as the remaining aggregations.

              • type (string) –

                The different types of aggregation functions that you can perform.

              • maxCount (integer) –

                The maximum number of aggregation functions that you can perform with the given privacy budget.

              • remainingCount (integer) –

                The remaining number of aggregation functions that can be run with the available privacy budget.

          • epsilon (integer) –

            The epsilon value that you configured.

  • nextToken (string) –

    The pagination token that’s used to fetch the next set of results.

Exceptions

• CleanRoomsService.Client.exceptions.ResourceNotFoundException

• CleanRoomsService.Client.exceptions.InternalServerException

• CleanRoomsService.Client.exceptions.ValidationException

• CleanRoomsService.Client.exceptions.ThrottlingException

• CleanRoomsService.Client.exceptions.AccessDeniedException