ApplicationInsights / Client / list_applications

list_applications#

ApplicationInsights.Client.list_applications(**kwargs)#

Lists the IDs of the applications that you are monitoring.

Request Syntax

response = client.list_applications(
    MaxResults=123,
    NextToken='string',
    AccountId='string'
)

Parameters:

MaxResults (integer) – The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
NextToken (string) – The token to request the next page of results.
AccountId (string) – The AWS account ID for the resource group owner.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationInfoList': [
        {
            'AccountId': 'string',
            'ResourceGroupName': 'string',
            'LifeCycle': 'string',
            'OpsItemSNSTopicArn': 'string',
            'OpsCenterEnabled': True|False,
            'CWEMonitorEnabled': True|False,
            'Remarks': 'string',
            'AutoConfigEnabled': True|False,
            'DiscoveryType': 'RESOURCE_GROUP_BASED'|'ACCOUNT_BASED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- ApplicationInfoList (list) –
  
  The list of applications.
  - (dict) –
    
    Describes the status of the application.
    - AccountId (string) –
      
      The AWS 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.
    - 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.
- NextToken (string) –
  
  The token used to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

ApplicationInsights.Client.exceptions.ValidationException
ApplicationInsights.Client.exceptions.InternalServerException