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.

Request Syntax

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

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.
accessBudgetResourceArn (string) – The Amazon Resource Name (ARN) of the access budget resource to filter privacy budgets by.

Return type:

dict

Returns:

Response Syntax

{
    'privacyBudgetSummaries': [
        {
            'id': 'string',
            'privacyBudgetTemplateId': 'string',
            'privacyBudgetTemplateArn': 'string',
            'membershipId': 'string',
            'membershipArn': 'string',
            'collaborationId': 'string',
            'collaborationArn': 'string',
            'type': 'DIFFERENTIAL_PRIVACY'|'ACCESS_BUDGET',
            '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
                },
                'accessBudget': {
                    'resourceArn': 'string',
                    'details': [
                        {
                            'startTime': datetime(2015, 1, 1),
                            'endTime': datetime(2015, 1, 1),
                            'remainingBudget': 123,
                            'budget': 123,
                            'budgetType': 'CALENDAR_DAY'|'CALENDAR_MONTH'|'CALENDAR_WEEK'|'LIFETIME',
                            'autoRefresh': 'ENABLED'|'DISABLED'
                        },
                    ],
                    'aggregateRemainingBudget': 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, accessBudget. 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.
      - accessBudget (dict) –
        
        Access budget information associated with this privacy budget.
        
        resourceArn (string) –
        
        The Amazon Resource Name (ARN) of the access budget resource.
        
        details (list) –
        
        Detailed budget information including time bounds, remaining budget, and refresh settings.
        
        (dict) –
        
        Detailed information about an access budget including time bounds, budget allocation, and configuration settings.
        
        startTime (datetime) –
        
        The start time for the access budget period.
        
        endTime (datetime) –
        
        The end time for the access budget period.
        
        remainingBudget (integer) –
        
        The remaining budget amount available for use within this access budget.
        
        budget (integer) –
        
        The total budget allocation amount for this access budget.
        
        budgetType (string) –
        
        Specifies the time period for limiting table usage in queries and jobs. For calendar-based periods, the budget can renew if auto refresh is enabled. For lifetime budgets, the limit applies to the total usage throughout the collaboration. Valid values are:
        
        CALENDAR_DAY - Limit table usage per day.
        
        CALENDAR_WEEK - Limit table usage per week.
        
        CALENDAR_MONTH - Limit table usage per month.
        
        LIFETIME - Limit total table usage for the collaboration duration.
        
        autoRefresh (string) –
        
        Indicates whether the budget automatically refreshes for each time period specified in budgetType. Valid values are:
        
        ENABLED - The budget refreshes automatically at the start of each period.
        
        DISABLED - The budget must be refreshed manually.
        
        NULL - The value is null when budgetType is set to LIFETIME.
        
        aggregateRemainingBudget (integer) –
        
        The total remaining budget across all budget parameters, showing the lower value between the per-period budget and lifetime budget for this access budget. For individual parameter budgets, see remainingBudget.
- 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