ApplicationInsights / Client / describe_component_configuration

describe_component_configuration

ApplicationInsights.Client.describe_component_configuration(**kwargs)

Describes the monitoring configuration of the component.

See also: AWS API Documentation

Request Syntax

response = client.describe_component_configuration(
    ResourceGroupName='string',
    ComponentName='string',
    AccountId='string'
)

Parameters:

• ResourceGroupName (string) –

  [REQUIRED]

  The name of the resource group.

• ComponentName (string) –

  [REQUIRED]

  The name of the component.

• AccountId (string) – The AWS account ID for the resource group owner.

Return type:

dict

Returns:

Response Syntax

{
    'Monitor': True|False,
    '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'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
    'ComponentConfiguration': 'string'
}

Response Structure

• (dict) –

  • Monitor (boolean) –

    Indicates whether the application component is monitored.

  • Tier (string) –

    The tier of the application component. Supported tiers include DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT

  • ComponentConfiguration (string) –

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

Exceptions

• ApplicationInsights.Client.exceptions.ResourceNotFoundException

• ApplicationInsights.Client.exceptions.ValidationException

• ApplicationInsights.Client.exceptions.InternalServerException