describe_application

ApplicationInsights.Client.describe_application(**kwargs)

Describes the application.

See also: AWS API Documentation

Request Syntax

response = client.describe_application(
    ResourceGroupName='string'
)

Parameters

ResourceGroupName (string) --

[REQUIRED]

The name of the resource group.

Return type

dict

Returns

Response Syntax

{
    'ApplicationInfo': {
        'ResourceGroupName': 'string',
        'LifeCycle': 'string',
        'OpsItemSNSTopicArn': 'string',
        'OpsCenterEnabled': True|False,
        'CWEMonitorEnabled': True|False,
        'Remarks': 'string',
        'AutoConfigEnabled': True|False,
        'DiscoveryType': 'RESOURCE_GROUP_BASED'|'ACCOUNT_BASED'
    }
}

Response Structure

• (dict) --
  • ApplicationInfo (dict) --

    Information about the application.

    • ResourceGroupName (string) --

      The name of the resource group used for the application.

    • LifeCycle (string) --

      The lifecycle of the application.

    • OpsItemSNSTopicArn (string) --

      The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.

    • OpsCenterEnabled (boolean) --

      Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.

    • CWEMonitorEnabled (boolean) --

      Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated , failed deployment , and others.

    • Remarks (string) --

      The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:

      • “Configuring application, detected 1 Errors, 3 Warnings”
      • “Configuring application, detected 1 Unconfigured Components”
    • AutoConfigEnabled (boolean) --

      Indicates whether auto-configuration is turned on for this application.

    • DiscoveryType (string) --

      The method used by Application Insights to onboard your resources.

Exceptions

• ApplicationInsights.Client.exceptions.ResourceNotFoundException
• ApplicationInsights.Client.exceptions.ValidationException
• ApplicationInsights.Client.exceptions.InternalServerException