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

*****************
describe_workload
*****************



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

  

  Describes a workload and its configuration.

  

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


  **Request Syntax**
  ::

    response = client.describe_workload(
        ResourceGroupName='string',
        ComponentName='string',
        WorkloadId='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 WorkloadId: string
  :param WorkloadId: **[REQUIRED]** 

    The ID of the workload.

    

  
  :type AccountId: string
  :param AccountId: 

    The Amazon Web Services account ID for the workload owner.

    

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

    
    ::

      {
          'WorkloadId': 'string',
          'WorkloadRemarks': 'string',
          'WorkloadConfiguration': {
              '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',
              'Configuration': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The ID of the workload.

        
      

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

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

        
      

      - **WorkloadConfiguration** *(dict) --* 

        The configuration settings of the workload. The value is the escaped JSON of the configuration.

        
        

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

          The name of the workload.

          
        

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

          The configuration of the workload tier.

          
        

        - **Configuration** *(string) --* 

          The configuration settings of the workload.

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

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

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

  