:doc:`LaunchWizard <../../launch-wizard>` / Paginator / ListWorkloadDeploymentPatterns

******************************
ListWorkloadDeploymentPatterns
******************************



.. py:class:: LaunchWizard.Paginator.ListWorkloadDeploymentPatterns

  ::

    
    paginator = client.get_paginator('list_workload_deployment_patterns')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`LaunchWizard.Client.list_workload_deployment_patterns`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/ListWorkloadDeploymentPatterns>`_    


    **Request Syntax**
    ::

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

      The name of the workload.

      

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

      
      ::

        {
            'workloadDeploymentPatterns': [
                {
                    'workloadName': 'string',
                    'deploymentPatternName': 'string',
                    'workloadVersionName': 'string',
                    'deploymentPatternVersionName': 'string',
                    'displayName': 'string',
                    'description': 'string',
                    'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED',
                    'statusMessage': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **workloadDeploymentPatterns** *(list) --* 

          Describes the workload deployment patterns.

          
          

          - *(dict) --* 

            Describes a workload deployment pattern.

            
            

            - **workloadName** *(string) --* 

              The name of the workload.

              
            

            - **deploymentPatternName** *(string) --* 

              The name of a workload deployment pattern.

              
            

            - **workloadVersionName** *(string) --* 

              The name of the workload deployment pattern version.

              
            

            - **deploymentPatternVersionName** *(string) --* 

              The version name of a workload deployment pattern.

              
            

            - **displayName** *(string) --* 

              The display name of a workload deployment pattern.

              
            

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

              The description of a workload deployment pattern.

              
            

            - **status** *(string) --* 

              The status of a workload deployment pattern.

              
            

            - **statusMessage** *(string) --* 

              A message about a workload deployment pattern's status.

              
        
      
        

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

          A token to resume pagination.

          
    