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

***************************
ListWhatsAppTemplateLibrary
***************************



.. py:class:: EndUserMessagingSocial.Paginator.ListWhatsAppTemplateLibrary

  ::

    
    paginator = client.get_paginator('list_whatsapp_template_library')

  
  

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

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

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


    **Request Syntax**
    ::

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

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

      

    
    :type filters: dict
    :param filters: 

      Map of filters to apply (searchKey, topic, usecase, industry, language).

      

    
      - *(string) --* 

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

      
      ::

        {
            'metaLibraryTemplates': [
                {
                    'templateName': 'string',
                    'templateLanguage': 'string',
                    'templateCategory': 'string',
                    'templateTopic': 'string',
                    'templateUseCase': 'string',
                    'templateIndustry': [
                        'string',
                    ],
                    'templateHeader': 'string',
                    'templateBody': 'string',
                    'templateButtons': [
                        {
                            'type': 'string',
                            'text': 'string',
                            'phoneNumber': 'string',
                            'url': 'string',
                            'otpType': 'string',
                            'zeroTapTermsAccepted': True|False,
                            'supportedApps': [
                                {
                                    'string': 'string'
                                },
                            ]
                        },
                    ],
                    'templateId': 'string',
                    'templateBodyExampleParams': [
                        'string',
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **metaLibraryTemplates** *(list) --* 

          A list of templates from Meta's library.

          
          

          - *(dict) --* 

            Defines the complete structure and content of a template in Meta's library.

            
            

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

              The name of the template.

              
            

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

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

              
            

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

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

              
            

            - **templateTopic** *(string) --* 

              The topic or subject matter of the template.

              
            

            - **templateUseCase** *(string) --* 

              The intended use case for the template.

              
            

            - **templateIndustry** *(list) --* 

              The industries the template is designed for.

              
              

              - *(string) --* 
          
            

            - **templateHeader** *(string) --* 

              The header text of the template.

              
            

            - **templateBody** *(string) --* 

              The body text of the template.

              
            

            - **templateButtons** *(list) --* 

              The buttons included in the template.

              
              

              - *(dict) --* 

                Defines a button in a template from Meta's library.

                
                

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

                  The type of button (for example, QUICK_REPLY, CALL, or URL).

                  
                

                - **text** *(string) --* 

                  The text displayed on the button (maximum 40 characters).

                  
                

                - **phoneNumber** *(string) --* 

                  The phone number in E.164 format for CALL-type buttons.

                  
                

                - **url** *(string) --* 

                  The URL for URL-type buttons.

                  
                

                - **otpType** *(string) --* 

                  The type of one-time password for OTP buttons.

                  
                

                - **zeroTapTermsAccepted** *(boolean) --* 

                  When true, indicates acceptance of zero-tap terms for the button.

                  
                

                - **supportedApps** *(list) --* 

                  List of supported applications for this button type.

                  
                  

                  - *(dict) --* 
                    

                    - *(string) --* 
                      

                      - *(string) --* 
                
              
              
            
          
            

            - **templateId** *(string) --* 

              The ID of the template in Meta's library.

              
            

            - **templateBodyExampleParams** *(list) --* 

              Example parameter values for the template body, used to demonstrate how dynamic content appears in the template.

              
              

              - *(string) --* 
          
        
      
        

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

          A token to resume pagination.

          
    