:doc:`EndUserMessagingSocial <../../socialmessaging>` / Paginator / ListLinkedWhatsAppBusinessAccounts

**********************************
ListLinkedWhatsAppBusinessAccounts
**********************************



.. py:class:: EndUserMessagingSocial.Paginator.ListLinkedWhatsAppBusinessAccounts

  ::

    
    paginator = client.get_paginator('list_linked_whatsapp_business_accounts')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`EndUserMessagingSocial.Client.list_linked_whatsapp_business_accounts`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/ListLinkedWhatsAppBusinessAccounts>`_    


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

      
      ::

        {
            'linkedAccounts': [
                {
                    'arn': 'string',
                    'id': 'string',
                    'wabaId': 'string',
                    'registrationStatus': 'COMPLETE'|'INCOMPLETE',
                    'linkDate': datetime(2015, 1, 1),
                    'wabaName': 'string',
                    'eventDestinations': [
                        {
                            'eventDestinationArn': 'string',
                            'roleArn': 'string'
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **linkedAccounts** *(list) --* 

          A list of WhatsApp Business Accounts linked to your Amazon Web Services account.

          
          

          - *(dict) --* 

            The details of a linked WhatsApp Business Account.

            
            

            - **arn** *(string) --* 

              The ARN of the linked WhatsApp Business Account.

              
            

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

              The ID of the linked WhatsApp Business Account, formatted as ``waba-01234567890123456789012345678901``.

              
            

            - **wabaId** *(string) --* 

              The WhatsApp Business Account ID provided by Meta.

              
            

            - **registrationStatus** *(string) --* 

              The registration status of the linked WhatsApp Business Account.

              
            

            - **linkDate** *(datetime) --* 

              The date the WhatsApp Business Account was linked.

              
            

            - **wabaName** *(string) --* 

              The name of the linked WhatsApp Business Account.

              
            

            - **eventDestinations** *(list) --* 

              The event destinations for the linked WhatsApp Business Account.

              
              

              - *(dict) --* 

                Contains information on the event destination.

                
                

                - **eventDestinationArn** *(string) --* 

                  The ARN of the event destination.

                  
                

                - **roleArn** *(string) --* 

                  The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to import phone numbers and write events.

                  
            
          
        
      
        

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

          A token to resume pagination.

          
    