:doc:`B2BI <../../b2bi>` / Paginator / ListProfiles

************
ListProfiles
************



.. py:class:: B2BI.Paginator.ListProfiles

  ::

    
    paginator = client.get_paginator('list_profiles')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`B2BI.Client.list_profiles`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/ListProfiles>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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**

      
      ::

        {
            'profiles': [
                {
                    'profileId': 'string',
                    'name': 'string',
                    'businessName': 'string',
                    'logging': 'ENABLED'|'DISABLED',
                    'logGroupName': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'modifiedAt': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **profiles** *(list) --* 

          Returns an array of ``ProfileSummary`` objects.

          
          

          - *(dict) --* 

            Contains the details for a profile. A profile is the mechanism used to create the concept of a private network.

            
            

            - **profileId** *(string) --* 

              Returns the unique, system-generated identifier for the profile.

              
            

            - **name** *(string) --* 

              Returns the display name for profile.

              
            

            - **businessName** *(string) --* 

              Returns the name for the business associated with this profile.

              
            

            - **logging** *(string) --* 

              Specifies whether or not logging is enabled for this profile.

              
            

            - **logGroupName** *(string) --* 

              Returns the name of the logging group.

              
            

            - **createdAt** *(datetime) --* 

              Returns the timestamp for creation date and time of the profile.

              
            

            - **modifiedAt** *(datetime) --* 

              Returns the timestamp that identifies the most recent date and time that the profile was modified.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    