:doc:`mgn <../../mgn>` / Paginator / ListTemplateActions

*******************
ListTemplateActions
*******************



.. py:class:: mgn.Paginator.ListTemplateActions

  ::

    
    paginator = client.get_paginator('list_template_actions')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`mgn.Client.list_template_actions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mgn-2020-02-26/ListTemplateActions>`_    


    **Request Syntax**
    ::

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

      Launch configuration template ID.

      

    
    :type filters: dict
    :param filters: 

      Filters to apply when listing template post migration custom actions.

      

    
      - **actionIDs** *(list) --* 

        Action IDs to filter template post migration custom actions by.

        

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

      
      ::

        {
            'items': [
                {
                    'actionID': 'string',
                    'actionName': 'string',
                    'documentIdentifier': 'string',
                    'order': 123,
                    'documentVersion': 'string',
                    'active': True|False,
                    'timeoutSeconds': 123,
                    'mustSucceedForCutover': True|False,
                    'parameters': {
                        'string': [
                            {
                                'parameterType': 'STRING'|'SECURE_STRING',
                                'parameterName': 'string'
                            },
                        ]
                    },
                    'operatingSystem': 'string',
                    'externalParameters': {
                        'string': {
                            'dynamicPath': 'string'
                        }
                    },
                    'description': 'string',
                    'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          List of template post migration custom actions.

          
          

          - *(dict) --* 
            

            - **actionID** *(string) --* 

              Template post migration custom action ID.

              
            

            - **actionName** *(string) --* 

              Template post migration custom action name.

              
            

            - **documentIdentifier** *(string) --* 

              Template post migration custom action document identifier.

              
            

            - **order** *(integer) --* 

              Template post migration custom action order.

              
            

            - **documentVersion** *(string) --* 

              Template post migration custom action document version.

              
            

            - **active** *(boolean) --* 

              Template post migration custom action active status.

              
            

            - **timeoutSeconds** *(integer) --* 

              Template post migration custom action timeout in seconds.

              
            

            - **mustSucceedForCutover** *(boolean) --* 

              Template post migration custom action must succeed for cutover.

              
            

            - **parameters** *(dict) --* 

              Template post migration custom action parameters.

              
              

              - *(string) --* 
                

                - *(list) --* 
                  

                  - *(dict) --* 

                    AWS Systems Manager Parameter Store parameter.

                    
                    

                    - **parameterType** *(string) --* 

                      AWS Systems Manager Parameter Store parameter type.

                      
                    

                    - **parameterName** *(string) --* 

                      AWS Systems Manager Parameter Store parameter name.

                      
                
              
          
        
            

            - **operatingSystem** *(string) --* 

              Operating system eligible for this template post migration custom action.

              
            

            - **externalParameters** *(dict) --* 

              Template post migration custom action external parameters.

              
              

              - *(string) --* 
                

                - *(dict) --* 

                  AWS Systems Manager Document external parameter.

                  .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``dynamicPath``.     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'}


                
                  

                  - **dynamicPath** *(string) --* 

                    AWS Systems Manager Document external parameters dynamic path.

                    
              
          
        
            

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

              Template post migration custom action description.

              
            

            - **category** *(string) --* 

              Template post migration custom action category.

              
        
      
        

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

          A token to resume pagination.

          
    