:doc:`LaunchWizard <../../launch-wizard>` / Client / list_workloads

**************
list_workloads
**************



.. py:method:: LaunchWizard.Client.list_workloads(**kwargs)

  

  Lists the available workload names. You can use the `ListWorkloadDeploymentPatterns <https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html>`__ operation to discover the available deployment patterns for a given workload.

  

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


  **Request Syntax**
  ::

    response = client.list_workloads(
        maxResults=123,
        nextToken='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

    

  
  :type nextToken: string
  :param nextToken: 

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'workloads': [
              {
                  'workloadName': 'string',
                  'displayName': 'string',
                  'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **workloads** *(list) --* 

        Information about the workloads.

        
        

        - *(dict) --* 

          Describes workload data.

          
          

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

            The name of the workload.

            
          

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

            The display name of the workload data.

            
          

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

            The status of the workload.

            
      
    
      

      - **nextToken** *(string) --* 

        The token to include in another request to get the next page of items. This value is ``null`` when there are no more items to return.

        
  
  **Exceptions**
  
  *   :py:class:`LaunchWizard.Client.exceptions.InternalServerException`

  
  *   :py:class:`LaunchWizard.Client.exceptions.ValidationException`

  