ApplicationInsights / Client / describe_component

describe_component

ApplicationInsights.Client.describe_component(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_component(
    ResourceGroupName='string',
    ComponentName='string'
)

Parameters:

• ResourceGroupName (string) –

  [REQUIRED]

  The name of the resource group.

• ComponentName (string) –

  [REQUIRED]

  The name of the component.

Return type:

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'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY',
        '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

• ApplicationInsights.Client.exceptions.ResourceNotFoundException

• ApplicationInsights.Client.exceptions.ValidationException

• ApplicationInsights.Client.exceptions.InternalServerException