:doc:`CleanRoomsService <../../cleanrooms>` / Paginator / ListCollaborationPrivacyBudgets

*******************************
ListCollaborationPrivacyBudgets
*******************************



.. py:class:: CleanRoomsService.Paginator.ListCollaborationPrivacyBudgets

  ::

    
    paginator = client.get_paginator('list_collaboration_privacy_budgets')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`CleanRoomsService.Client.list_collaboration_privacy_budgets`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListCollaborationPrivacyBudgets>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          collaborationIdentifier='string',
          privacyBudgetType='DIFFERENTIAL_PRIVACY'|'ACCESS_BUDGET',
          accessBudgetResourceArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type collaborationIdentifier: string
    :param collaborationIdentifier: **[REQUIRED]** 

      A unique identifier for one of your collaborations.

      

    
    :type privacyBudgetType: string
    :param privacyBudgetType: **[REQUIRED]** 

      Specifies the type of the privacy budget.

      

    
    :type accessBudgetResourceArn: string
    :param accessBudgetResourceArn: 

      The Amazon Resource Name (ARN) of the Configured Table Association (ConfiguredTableAssociation) used to filter privacy budgets.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'collaborationPrivacyBudgetSummaries': [
                {
                    'id': 'string',
                    'privacyBudgetTemplateId': 'string',
                    'privacyBudgetTemplateArn': 'string',
                    'collaborationId': 'string',
                    'collaborationArn': 'string',
                    'creatorAccountId': '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) --* 
        

        - **collaborationPrivacyBudgetSummaries** *(list) --* 

          Summaries of the collaboration privacy budgets.

          
          

          - *(dict) --* 

            A summary of the collaboration privacy budgets. This summary includes the collaboration information, creation information, epsilon provided, and utility in terms of aggregations.

            
            

            - **id** *(string) --* 

              The unique identifier of the collaboration privacy budget.

              
            

            - **privacyBudgetTemplateId** *(string) --* 

              The unique identifier of the collaboration privacy budget template.

              
            

            - **privacyBudgetTemplateArn** *(string) --* 

              The ARN of the collaboration privacy budget template.

              
            

            - **collaborationId** *(string) --* 

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

              
            

            - **collaborationArn** *(string) --* 

              The ARN of the collaboration that includes this privacy budget.

              
            

            - **creatorAccountId** *(string) --* 

              The unique identifier of the account that created this privacy budget.

              
            

            - **type** *(string) --* 

              The type of privacy budget template.

              
            

            - **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 includes epsilon provided and utility in terms of aggregations.

              .. 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) --* 

          A token to resume pagination.

          
    