2021/10/29 - Amazon CloudWatch Application Insights - 11 updated api methods
Changes Added Monitoring support for SQL Server Failover Cluster Instance. Additionally, added a new API to allow one-click monitoring of containers resources.
{'AutoConfigEnabled': 'boolean', 'AutoCreate': 'boolean'}
Response {'ApplicationInfo': {'AutoConfigEnabled': 'boolean',
'DiscoveryType': 'RESOURCE_GROUP_BASED | ACCOUNT_BASED'}}
Adds an application that is created from a resource group.
See also: AWS API Documentation
Request Syntax
client.create_application(
ResourceGroupName='string',
OpsCenterEnabled=True|False,
CWEMonitorEnabled=True|False,
OpsItemSNSTopicArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
AutoConfigEnabled=True|False,
AutoCreate=True|False
)
string
The name of the resource group.
boolean
When set to true, creates opsItems for any problems detected on an application.
boolean
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.
string
The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.
list
List of tags to add to the application. tag key ( Key) and an associated tag value ( Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
(dict) --
An object that defines the tags associated with an application. A tag is a label that you optionally define and associate with an application. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
Tag keys and values are case sensitive.
For each associated resource, each tag key must be unique and it can have only one value.
The aws: prefix is reserved for use by AWS; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix.
Key (string) -- [REQUIRED]
One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.
Value (string) -- [REQUIRED]
The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want an application to have a specific tag value, don't specify a value for this parameter.
boolean
boolean
dict
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) --
DiscoveryType (string) --
{'ApplicationInfo': {'AutoConfigEnabled': 'boolean',
'DiscoveryType': 'RESOURCE_GROUP_BASED | ACCOUNT_BASED'}}
Describes the application.
See also: AWS API Documentation
Request Syntax
client.describe_application(
ResourceGroupName='string'
)
string
[REQUIRED]
The name of the resource group.
dict
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) --
DiscoveryType (string) --
{'ApplicationComponent': {'Tier': {'SAP_HANA',
'SAP_HANA_HIGH_AVAILABILITY',
'SAP_HANA_MULTI_NODE',
'SAP_HANA_SINGLE_NODE',
'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'}}}
Describes a component and lists the resources that are grouped together in a component.
See also: AWS API Documentation
Request Syntax
client.describe_component(
ResourceGroupName='string',
ComponentName='string'
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
dict
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'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE',
'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) --
{'Tier': {'SAP_HANA',
'SAP_HANA_HIGH_AVAILABILITY',
'SAP_HANA_MULTI_NODE',
'SAP_HANA_SINGLE_NODE',
'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'}}
Describes the monitoring configuration of the component.
See also: AWS API Documentation
Request Syntax
client.describe_component_configuration(
ResourceGroupName='string',
ComponentName='string'
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
dict
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'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE',
'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.
{'Tier': {'SAP_HANA',
'SAP_HANA_HIGH_AVAILABILITY',
'SAP_HANA_MULTI_NODE',
'SAP_HANA_SINGLE_NODE',
'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'}}
Describes the recommended monitoring configuration of the component.
See also: AWS API Documentation
Request Syntax
client.describe_component_configuration_recommendation(
ResourceGroupName='string',
ComponentName='string',
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'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
string
[REQUIRED]
The tier of the application component. Supported tiers include DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT.
dict
Response Syntax
{
'ComponentConfiguration': 'string'
}
Response Structure
(dict) --
ComponentConfiguration (string) --
The recommended configuration settings of the component. The value is the escaped JSON of the configuration.
{'Problem': {'LastRecurrenceTime': 'timestamp',
'RecurringCount': 'long',
'Status': {'RECURRING'}}}
Describes an application problem.
See also: AWS API Documentation
Request Syntax
client.describe_problem(
ProblemId='string'
)
string
[REQUIRED]
The ID of the problem.
dict
Response Syntax
{
'Problem': {
'Id': 'string',
'Title': 'string',
'Insights': 'string',
'Status': 'IGNORE'|'RESOLVED'|'PENDING'|'RECURRING',
'AffectedResource': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'SeverityLevel': 'Low'|'Medium'|'High',
'ResourceGroupName': 'string',
'Feedback': {
'string': 'NOT_SPECIFIED'|'USEFUL'|'NOT_USEFUL'
},
'RecurringCount': 123,
'LastRecurrenceTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Problem (dict) --
Information about the problem.
Id (string) --
The ID of the problem.
Title (string) --
The name of the problem.
Insights (string) --
A detailed analysis of the problem using machine learning.
Status (string) --
The status of the problem.
AffectedResource (string) --
The resource affected by the problem.
StartTime (datetime) --
The time when the problem started, in epoch seconds.
EndTime (datetime) --
The time when the problem ended, in epoch seconds.
SeverityLevel (string) --
A measure of the level of impact of the problem.
ResourceGroupName (string) --
The name of the resource group affected by the problem.
Feedback (dict) --
Feedback provided by the user about the problem.
(string) --
(string) --
RecurringCount (integer) --
LastRecurrenceTime (datetime) --
{'ApplicationInfoList': {'AutoConfigEnabled': 'boolean',
'DiscoveryType': 'RESOURCE_GROUP_BASED | '
'ACCOUNT_BASED'}}
Lists the IDs of the applications that you are monitoring.
See also: AWS API Documentation
Request Syntax
client.list_applications(
MaxResults=123,
NextToken='string'
)
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.
string
The token to request the next page of results.
dict
Response Syntax
{
'ApplicationInfoList': [
{
'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.
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) --
DiscoveryType (string) --
NextToken (string) --
The token used to retrieve the next page of results. This value is null when there are no more results to return.
{'ApplicationComponentList': {'Tier': {'SAP_HANA',
'SAP_HANA_HIGH_AVAILABILITY',
'SAP_HANA_MULTI_NODE',
'SAP_HANA_SINGLE_NODE',
'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'}}}
Lists the auto-grouped, standalone, and custom components of the application.
See also: AWS API Documentation
Request Syntax
client.list_components(
ResourceGroupName='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The name of the resource group.
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.
string
The token to request the next page of results.
dict
Response Syntax
{
'ApplicationComponentList': [
{
'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'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE',
'Monitor': True|False,
'DetectedWorkload': {
'string': {
'string': 'string'
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ApplicationComponentList (list) --
The list of application components.
(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) --
NextToken (string) --
The token to request the next page of results.
{'ComponentName': 'string'}
Response {'ProblemList': {'LastRecurrenceTime': 'timestamp',
'RecurringCount': 'long',
'Status': {'RECURRING'}},
'ResourceGroupName': 'string'}
Lists the problems with your application.
See also: AWS API Documentation
Request Syntax
client.list_problems(
ResourceGroupName='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string',
ComponentName='string'
)
string
The name of the resource group.
datetime
The time when the problem was detected, in epoch seconds. If you don't specify a time frame for the request, problems within the past seven days are returned.
datetime
The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.
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.
string
The token to request the next page of results.
string
dict
Response Syntax
{
'ProblemList': [
{
'Id': 'string',
'Title': 'string',
'Insights': 'string',
'Status': 'IGNORE'|'RESOLVED'|'PENDING'|'RECURRING',
'AffectedResource': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'SeverityLevel': 'Low'|'Medium'|'High',
'ResourceGroupName': 'string',
'Feedback': {
'string': 'NOT_SPECIFIED'|'USEFUL'|'NOT_USEFUL'
},
'RecurringCount': 123,
'LastRecurrenceTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string',
'ResourceGroupName': 'string'
}
Response Structure
(dict) --
ProblemList (list) --
The list of problems.
(dict) --
Describes a problem that is detected by correlating observations.
Id (string) --
The ID of the problem.
Title (string) --
The name of the problem.
Insights (string) --
A detailed analysis of the problem using machine learning.
Status (string) --
The status of the problem.
AffectedResource (string) --
The resource affected by the problem.
StartTime (datetime) --
The time when the problem started, in epoch seconds.
EndTime (datetime) --
The time when the problem ended, in epoch seconds.
SeverityLevel (string) --
A measure of the level of impact of the problem.
ResourceGroupName (string) --
The name of the resource group affected by the problem.
Feedback (dict) --
Feedback provided by the user about the problem.
(string) --
(string) --
RecurringCount (integer) --
LastRecurrenceTime (datetime) --
NextToken (string) --
The token used to retrieve the next page of results. This value is null when there are no more results to return.
ResourceGroupName (string) --
{'AutoConfigEnabled': 'boolean'}
Response {'ApplicationInfo': {'AutoConfigEnabled': 'boolean',
'DiscoveryType': 'RESOURCE_GROUP_BASED | ACCOUNT_BASED'}}
Updates the application.
See also: AWS API Documentation
Request Syntax
client.update_application(
ResourceGroupName='string',
OpsCenterEnabled=True|False,
CWEMonitorEnabled=True|False,
OpsItemSNSTopicArn='string',
RemoveSNSTopic=True|False,
AutoConfigEnabled=True|False
)
string
[REQUIRED]
The name of the resource group.
boolean
When set to true, creates opsItems for any problems detected on an application.
boolean
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.
string
The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.
boolean
Disassociates the SNS topic from the opsItem created for detected problems.
boolean
dict
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) --
DiscoveryType (string) --
{'AutoConfigEnabled': 'boolean',
'Tier': {'SAP_HANA',
'SAP_HANA_HIGH_AVAILABILITY',
'SAP_HANA_MULTI_NODE',
'SAP_HANA_SINGLE_NODE',
'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'}}
Updates the monitoring configurations for the component. The configuration input parameter is an escaped JSON of the configuration and should match the schema of what is returned by DescribeComponentConfigurationRecommendation.
See also: AWS API Documentation
Request Syntax
client.update_component_configuration(
ResourceGroupName='string',
ComponentName='string',
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'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE',
ComponentConfiguration='string',
AutoConfigEnabled=True|False
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
boolean
Indicates whether the application component is monitored.
string
The tier of the application component. Supported tiers include DOT_NET_WORKER, DOT_NET_WEB, DOT_NET_CORE, SQL_SERVER, and DEFAULT.
string
The configuration settings of the component. The value is the escaped JSON of the configuration. For more information about the JSON format, see Working with JSON. You can send a request to DescribeComponentConfigurationRecommendation to see the recommended configuration for a component. For the complete format of the component configuration file, see Component Configuration.
boolean
dict
Response Syntax
{}
Response Structure
(dict) --