2019/06/24 - Amazon CloudWatch Application Insights - 16 new api methods
Changes Update application-insights client to latest version
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='string'
)
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_WORKER, DOT_NET_WEB_TIER, 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.
Adds an application that is created from a resource group.
See also: AWS API Documentation
Request Syntax
client.create_application(
ResourceGroupName='string'
)
string
[REQUIRED]
The name of the resource group.
dict
Response Syntax
{
'ApplicationInfo': {
'ResourceGroupName': 'string',
'LifeCycle': 'string',
'Remarks': 'string'
}
}
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.
Remarks (string) --
The issues on the user side that are blocking Application Insights from fully monitoring the application.
Describes an anomaly or error with the application.
See also: AWS API Documentation
Request Syntax
client.describe_observation(
ObservationId='string'
)
string
[REQUIRED]
The ID of the observation.
dict
Response Syntax
{
'Observation': {
'Id': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'SourceType': 'string',
'SourceARN': 'string',
'LogGroup': 'string',
'LineTime': datetime(2015, 1, 1),
'LogText': 'string',
'LogFilter': 'ERROR'|'WARN'|'INFO',
'MetricNamespace': 'string',
'MetricName': 'string',
'Unit': 'string',
'Value': 123.0
}
}
Response Structure
(dict) --
Observation (dict) --
Information about the observation.
Id (string) --
The ID of the observation type.
StartTime (datetime) --
The time when the observation was first detected, in epoch seconds.
EndTime (datetime) --
The time when the observation ended, in epoch seconds.
SourceType (string) --
The source type of the observation.
SourceARN (string) --
The source resource ARN of the observation.
LogGroup (string) --
The log group name.
LineTime (datetime) --
The timestamp in the CloudWatch Logs that specifies when the matched line occurred.
LogText (string) --
The log text of the observation.
LogFilter (string) --
The log filter of the observation.
MetricNamespace (string) --
The namespace of the observation metric.
MetricName (string) --
The name of the observation metric.
Unit (string) --
The unit of the source observation metric.
Value (float) --
The value of the source observation metric.
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',
'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'
}
}
}
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) --
Describes the anomalies or errors associated with the problem.
See also: AWS API Documentation
Request Syntax
client.describe_problem_observations(
ProblemId='string'
)
string
[REQUIRED]
The ID of the problem.
dict
Response Syntax
{
'RelatedObservations': {
'ObservationList': [
{
'Id': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'SourceType': 'string',
'SourceARN': 'string',
'LogGroup': 'string',
'LineTime': datetime(2015, 1, 1),
'LogText': 'string',
'LogFilter': 'ERROR'|'WARN'|'INFO',
'MetricNamespace': 'string',
'MetricName': 'string',
'Unit': 'string',
'Value': 123.0
},
]
}
}
Response Structure
(dict) --
RelatedObservations (dict) --
Observations related to the problem.
ObservationList (list) --
The list of observations related to the problem.
(dict) --
Describes an anomaly or error with the application.
Id (string) --
The ID of the observation type.
StartTime (datetime) --
The time when the observation was first detected, in epoch seconds.
EndTime (datetime) --
The time when the observation ended, in epoch seconds.
SourceType (string) --
The source type of the observation.
SourceARN (string) --
The source resource ARN of the observation.
LogGroup (string) --
The log group name.
LineTime (datetime) --
The timestamp in the CloudWatch Logs that specifies when the matched line occurred.
LogText (string) --
The log text of the observation.
LogFilter (string) --
The log filter of the observation.
MetricNamespace (string) --
The namespace of the observation metric.
MetricName (string) --
The name of the observation metric.
Unit (string) --
The unit of the source observation metric.
Value (float) --
The value of the source observation metric.
Updates the custom component name and/or the list of resources that make up the component.
See also: AWS API Documentation
Request Syntax
client.update_component(
ResourceGroupName='string',
ComponentName='string',
NewComponentName='string',
ResourceList=[
'string',
]
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
string
The new name of the component.
list
The list of resource ARNs that belong to the component.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a custom component by grouping similar standalone instances to monitor.
See also: AWS API Documentation
Request Syntax
client.create_component(
ResourceGroupName='string',
ComponentName='string',
ResourceList=[
'string',
]
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
list
[REQUIRED]
The list of resource ARNs that belong to the component.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
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='string',
ComponentConfiguration='string'
)
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_TIER, 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.
dict
Response Syntax
{}
Response Structure
(dict) --
Removes the specified application from monitoring. Does not delete the application.
See also: AWS API Documentation
Request Syntax
client.delete_application(
ResourceGroupName='string'
)
string
[REQUIRED]
The name of the resource group.
dict
Response Syntax
{}
Response Structure
(dict) --
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': 'string',
'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_WORKER, DOT_NET_WEB_TIER, SQL_SERVER, and DEFAULT
ComponentConfiguration (string) --
The configuration settings of the component. The value is the escaped JSON of the configuration.
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',
'Remarks': 'string'
},
],
'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.
Remarks (string) --
The issues on the user side that are blocking Application Insights from fully monitoring the application.
NextToken (string) --
The token used to retrieve the next page of results. This value is null when there are no more results to return.
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'
)
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.
dict
Response Syntax
{
'ProblemList': [
{
'Id': 'string',
'Title': 'string',
'Insights': 'string',
'Status': 'IGNORE'|'RESOLVED'|'PENDING',
'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'
}
},
],
'NextToken': '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) --
NextToken (string) --
The token used to retrieve the next page of results. This value is null when there are no more results to return.
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',
'ResourceType': 'string',
'Tier': 'string',
'Monitor': True|False
},
],
'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.
ResourceType (string) --
The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.
Tier (string) --
The stack tier of the application component.
Monitor (boolean) --
Indicates whether the application component is monitored.
NextToken (string) --
The token to request the next page of results.
Ungroups a custom component. When you ungroup custom components, all applicable monitors that are set up for the component are removed and the instances revert to their standalone status.
See also: AWS API Documentation
Request Syntax
client.delete_component(
ResourceGroupName='string',
ComponentName='string'
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
dict
Response Syntax
{}
Response Structure
(dict) --
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',
'ResourceType': 'string',
'Tier': 'string',
'Monitor': True|False
},
'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.
ResourceType (string) --
The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.
Tier (string) --
The stack tier of the application component.
Monitor (boolean) --
Indicates whether the application component is monitored.
ResourceList (list) --
The list of resource ARNs that belong to the component.
(string) --
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',
'Remarks': 'string'
}
}
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.
Remarks (string) --
The issues on the user side that are blocking Application Insights from fully monitoring the application.