:doc:`ApplicationInsights <../../application-insights>` / Client / list_workloads

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



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

  

  Lists the workloads that are configured on a given component.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/ListWorkloads>`_  


  **Request Syntax**
  ::

    response = client.list_workloads(
        ResourceGroupName='string',
        ComponentName='string',
        MaxResults=123,
        NextToken='string',
        AccountId='string'
    )
    
  :type ResourceGroupName: string
  :param ResourceGroupName: **[REQUIRED]** 

    The name of the resource group.

    

  
  :type ComponentName: string
  :param ComponentName: **[REQUIRED]** 

    The name of the component.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned ``NextToken`` value.

    

  
  :type NextToken: string
  :param NextToken: 

    The token to request the next page of results.

    

  
  :type AccountId: string
  :param AccountId: 

    The Amazon Web Services account ID of the owner of the workload.

    

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

    
    ::

      {
          'WorkloadList': [
              {
                  'WorkloadId': 'string',
                  'ComponentName': 'string',
                  'WorkloadName': 'string',
                  'Tier': 'CUSTOM'|'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB_TIER'|'DOT_NET_WEB'|'SQL_SERVER'|'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'|'MYSQL'|'POSTGRESQL'|'JAVA_JMX'|'ORACLE'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SAP_ASE_SINGLE_NODE'|'SAP_ASE_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
                  'WorkloadRemarks': 'string',
                  'MissingWorkloadConfig': True|False
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **WorkloadList** *(list) --* 

        The list of workloads.

        
        

        - *(dict) --* 

          Describes the workloads on a component.

          
          

          - **WorkloadId** *(string) --* 

            The ID of the workload.

            
          

          - **ComponentName** *(string) --* 

            The name of the component.

            
          

          - **WorkloadName** *(string) --* 

            The name of the workload.

            
          

          - **Tier** *(string) --* 

            The tier of the workload.

            
          

          - **WorkloadRemarks** *(string) --* 

            If logging is supported for the resource type, shows whether the component has configured logs to be monitored.

            
          

          - **MissingWorkloadConfig** *(boolean) --* 

            Indicates whether all of the component configurations required to monitor a workload were provided.

            
      
    
      

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

        The token to request the next page of results.

        
  
  **Exceptions**
  
  *   :py:class:`ApplicationInsights.Client.exceptions.ResourceNotFoundException`

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

  
  *   :py:class:`ApplicationInsights.Client.exceptions.InternalServerException`

  