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

****************************
ListWhatsAppMessageTemplates
****************************



.. py:class:: EndUserMessagingSocial.Paginator.ListWhatsAppMessageTemplates

  ::

    
    paginator = client.get_paginator('list_whatsapp_message_templates')

  
  

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

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

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


    **Request Syntax**
    ::

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

      The ID of the WhatsApp Business Account to list templates for.

      

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

      
      ::

        {
            'templates': [
                {
                    'templateName': 'string',
                    'metaTemplateId': 'string',
                    'templateStatus': 'string',
                    'templateQualityScore': 'string',
                    'templateLanguage': 'string',
                    'templateCategory': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **templates** *(list) --* 

          A list of template summaries.

          
          

          - *(dict) --* 

            Provides a summary of a WhatsApp message template's key attributes.

            
            

            - **templateName** *(string) --* 

              The name of the template.

              
            

            - **metaTemplateId** *(string) --* 

              The numeric ID assigned to the template by Meta.

              
            

            - **templateStatus** *(string) --* 

              The current status of the template (for example, APPROVED, PENDING, or REJECTED).

              
            

            - **templateQualityScore** *(string) --* 

              The quality score assigned to the template by Meta.

              
            

            - **templateLanguage** *(string) --* 

              The language code of the template (for example, en_US).

              
            

            - **templateCategory** *(string) --* 

              The category of the template (for example, UTILITY or MARKETING).

              
        
      
        

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

          A token to resume pagination.

          
    