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

******************
describe_component
******************



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

  

  Describes a component and lists the resources that are grouped together in a component.

  

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


  **Request Syntax**
  ::

    response = client.describe_component(
        ResourceGroupName='string',
        ComponentName='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 AccountId: string
  :param AccountId: 

    The Amazon Web Services account ID for the resource group owner.

    

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

    
    ::

      {
          'ApplicationComponent': {
              'ComponentName': 'string',
              'ComponentRemarks': 'string',
              'ResourceType': 'string',
              'OsType': 'WINDOWS'|'LINUX',
              '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',
              'Monitor': True|False,
              'DetectedWorkload': {
                  'string': {
                      'string': 'string'
                  }
              }
          },
          'ResourceList': [
              'string',
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ApplicationComponent** *(dict) --* 

        Describes a standalone resource or similarly grouped resources that the application is made up of.

        
        

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

          The name of the component.

          
        

        - **ComponentRemarks** *(string) --* 

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

          
        

        - **ResourceType** *(string) --* 

          The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.

          
        

        - **OsType** *(string) --* 

          The operating system of the component.

          
        

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

          The stack tier of the application component.

          
        

        - **Monitor** *(boolean) --* 

          Indicates whether the application component is monitored.

          
        

        - **DetectedWorkload** *(dict) --* 

          Workloads detected in the application component.

          
          

          - *(string) --* 
            

            - *(dict) --* 
              

              - *(string) --* 
                

                - *(string) --* 
          
        
      
    
    
      

      - **ResourceList** *(list) --* 

        The list of resource ARNs that belong to the component.

        
        

        - *(string) --* 
    
  
  **Exceptions**
  
  *   :py:class:`ApplicationInsights.Client.exceptions.ResourceNotFoundException`

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

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

  