:doc:`PartnerCentralAccountAPI <../../partnercentral-account>` / Paginator / ListPartners

************
ListPartners
************



.. py:class:: PartnerCentralAccountAPI.Paginator.ListPartners

  ::

    
    paginator = client.get_paginator('list_partners')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`PartnerCentralAccountAPI.Client.list_partners`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/partnercentral-account-2025-04-04/ListPartners>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Catalog='string',
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Catalog: string
    :param Catalog: **[REQUIRED]** 

      The catalog identifier to list partners from.

      

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

        

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

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

        

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

      
      ::

        {
            'PartnerSummaryList': [
                {
                    'Catalog': 'string',
                    'Arn': 'string',
                    'Id': 'string',
                    'LegalName': 'string',
                    'CreatedAt': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **PartnerSummaryList** *(list) --* 

          A list of partner summaries including basic information about each partner account.

          
          

          - *(dict) --* 

            A summary view of a partner account containing basic information for listing purposes.

            
            

            - **Catalog** *(string) --* 

              The catalog identifier for the partner account.

              
            

            - **Arn** *(string) --* 

              The Amazon Resource Name (ARN) of the partner account.

              
            

            - **Id** *(string) --* 

              The unique identifier of the partner account.

              
            

            - **LegalName** *(string) --* 

              The legal name of the partner organization.

              
            

            - **CreatedAt** *(datetime) --* 

              The timestamp when the partner account was created.

              
        
      
    