:doc:`QConnect <../../qconnect>` / Paginator / ListMessageTemplates

********************
ListMessageTemplates
********************



.. py:class:: QConnect.Paginator.ListMessageTemplates

  ::

    
    paginator = client.get_paginator('list_message_templates')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`QConnect.Client.list_message_templates`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessageTemplates>`_    


    **Request Syntax**
    ::

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

      The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

      

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

      
      ::

        {
            'messageTemplateSummaries': [
                {
                    'messageTemplateArn': 'string',
                    'messageTemplateId': 'string',
                    'knowledgeBaseArn': 'string',
                    'knowledgeBaseId': 'string',
                    'name': 'string',
                    'channel': 'string',
                    'channelSubtype': 'EMAIL'|'SMS'|'WHATSAPP'|'PUSH',
                    'createdTime': datetime(2015, 1, 1),
                    'lastModifiedTime': datetime(2015, 1, 1),
                    'lastModifiedBy': 'string',
                    'sourceConfiguration': {
                        'whatsApp': {
                            'businessAccountId': 'string',
                            'templateId': 'string',
                            'components': [
                                'string',
                            ]
                        }
                    },
                    'activeVersionNumber': 123,
                    'description': 'string',
                    'tags': {
                        'string': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **messageTemplateSummaries** *(list) --* 

          Summary information about the message template.

          
          

          - *(dict) --* 

            The summary of the message template.

            
            

            - **messageTemplateArn** *(string) --* 

              The Amazon Resource Name (ARN) of the message template.

              
            

            - **messageTemplateId** *(string) --* 

              The identifier of the message template.

              
            

            - **knowledgeBaseArn** *(string) --* 

              The Amazon Resource Name (ARN) of the knowledge base.

              
            

            - **knowledgeBaseId** *(string) --* 

              The identifier of the knowledge base.

              
            

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

              The name of the message template.

              
            

            - **channel** *(string) --* 

              The channel this message template applies to.

              
            

            - **channelSubtype** *(string) --* 

              The channel subtype this message template applies to.

              
            

            - **createdTime** *(datetime) --* 

              The timestamp when the message template was created.

              
            

            - **lastModifiedTime** *(datetime) --* 

              The timestamp when the message template data was last modified.

              
            

            - **lastModifiedBy** *(string) --* 

              The Amazon Resource Name (ARN) of the user who last updated the message template data.

              
            

            - **sourceConfiguration** *(dict) --* 

              The container of message template source configuration.

              .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``whatsApp``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


            
              

              - **whatsApp** *(dict) --* 

                The sourceConfiguration of the message template that applies to the WHATSAPP channel subtype.

                
                

                - **businessAccountId** *(string) --* 

                  The ID of the End User Messaging WhatsApp Business Account to associate with this template.

                  
                

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

                  The WhatsApp template ID.

                  
                

                - **components** *(list) --* 

                  The list of component mapping from WhatsApp template parameters to Message Template attributes.

                  
                  

                  - *(string) --* 

                    The component mapping from WhatsApp template parameters to Message Template attributes.

                    
              
            
          
            

            - **activeVersionNumber** *(integer) --* 

              The version number of the message template version that is activated.

              
            

            - **description** *(string) --* 

              The description of the message template.

              
            

            - **tags** *(dict) --* 

              The tags used to organize, track, or control access for this resource.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

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

          A token to resume pagination.

          
    