ApplicationInsights / Client / describe_application

describe_application#

ApplicationInsights.Client.describe_application(**kwargs)#

Describes the application.

See also: AWS API Documentation

Request Syntax

response = client.describe_application(
    ResourceGroupName='string',
    AccountId='string'
)
Parameters:

  • ResourceGroupName (string) –

    [REQUIRED]

    The name of the resource group.

  • AccountId (string) – The Amazon Web Services account ID for the resource group owner.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • ApplicationInfo (dict) –

      Information about the application.

      • AccountId (string) –

        The Amazon Web Services account ID for the owner of 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.

      • SNSNotificationArn (string) –

        The SNS topic ARN that is associated with SNS notifications for updates or issues.

      • 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.

      • AttachMissingPermission (boolean) –

        If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.

Exceptions

  • ApplicationInsights.Client.exceptions.ResourceNotFoundException

  • ApplicationInsights.Client.exceptions.ValidationException

  • ApplicationInsights.Client.exceptions.InternalServerException