Table of Contents
ApplicationInsights.Client¶A low-level client representing Amazon CloudWatch Application Insights
Amazon CloudWatch Application Insights is a service that helps you detect common problems with your applications. It enables you to pinpoint the source of issues in your applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into detected problems.
After you onboard your application, CloudWatch Application Insights identifies, recommends, and sets up metrics and logs. It continuously analyzes and correlates your metrics and logs for unusual behavior to surface actionable problems with your application. For example, if your application is slow and unresponsive and leading to HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you that a memory pressure problem with your SQL Server database is occurring. It bases this analysis on impactful metrics and log errors.
import boto3
client = boto3.client('application-insights')
These are the available methods:
can_paginate()close()create_application()create_component()create_log_pattern()delete_application()delete_component()delete_log_pattern()describe_application()describe_component()describe_component_configuration()describe_component_configuration_recommendation()describe_log_pattern()describe_observation()describe_problem()describe_problem_observations()get_paginator()get_waiter()list_applications()list_components()list_configuration_history()list_log_pattern_sets()list_log_patterns()list_problems()list_tags_for_resource()tag_resource()untag_resource()update_application()update_component()update_component_configuration()update_log_pattern()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_application(**kwargs)¶Adds an application that is created from a resource group.
See also: AWS API Documentation
Request Syntax
response = client.create_application(
ResourceGroupName='string',
OpsCenterEnabled=True|False,
CWEMonitorEnabled=True|False,
OpsItemSNSTopicArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
AutoConfigEnabled=True|False,
AutoCreate=True|False,
GroupingType='ACCOUNT_BASED'
)
true , creates opsItems for any problems detected on an application.instance terminated , failed deployment , and others.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.
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:
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.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.
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.
ACCOUNT_BASED .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:
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.ResourceInUseExceptionApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptionApplicationInsights.Client.exceptions.TagsAlreadyExistExceptionApplicationInsights.Client.exceptions.AccessDeniedExceptioncreate_component(**kwargs)¶Creates a custom component by grouping similar standalone instances to monitor.
See also: AWS API Documentation
Request Syntax
response = client.create_component(
ResourceGroupName='string',
ComponentName='string',
ResourceList=[
'string',
]
)
[REQUIRED]
The name of the resource group.
[REQUIRED]
The name of the component.
[REQUIRED]
The list of resource ARNs that belong to the component.
dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationInsights.Client.exceptions.ResourceInUseExceptionApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptioncreate_log_pattern(**kwargs)¶Adds an log pattern to a LogPatternSet .
See also: AWS API Documentation
Request Syntax
response = client.create_log_pattern(
ResourceGroupName='string',
PatternSetName='string',
PatternName='string',
Pattern='string',
Rank=123
)
[REQUIRED]
The name of the resource group.
[REQUIRED]
The name of the log pattern set.
[REQUIRED]
The name of the log pattern.
[REQUIRED]
The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
[REQUIRED]
Rank of the log pattern. Must be a value between 1 and 1,000,000 . The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.
dict
Response Syntax
{
'LogPattern': {
'PatternSetName': 'string',
'PatternName': 'string',
'Pattern': 'string',
'Rank': 123
},
'ResourceGroupName': 'string'
}
Response Structure
(dict) --
LogPattern (dict) --
The successfully created log pattern.
PatternSetName (string) --
The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
PatternName (string) --
The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
Pattern (string) --
A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
Rank (integer) --
Rank of the log pattern. Must be a value between 1 and 1,000,000 . The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.
ResourceGroupName (string) --
The name of the resource group.
Exceptions
ApplicationInsights.Client.exceptions.ResourceInUseExceptionApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptiondelete_application(**kwargs)¶Removes the specified application from monitoring. Does not delete the application.
See also: AWS API Documentation
Request Syntax
response = client.delete_application(
ResourceGroupName='string'
)
[REQUIRED]
The name of the resource group.
{}
Response Structure
Exceptions
ApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.BadRequestExceptionApplicationInsights.Client.exceptions.InternalServerExceptiondelete_component(**kwargs)¶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
response = client.delete_component(
ResourceGroupName='string',
ComponentName='string'
)
[REQUIRED]
The name of the resource group.
[REQUIRED]
The name of the component.
dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptiondelete_log_pattern(**kwargs)¶Removes the specified log pattern from a LogPatternSet .
See also: AWS API Documentation
Request Syntax
response = client.delete_log_pattern(
ResourceGroupName='string',
PatternSetName='string',
PatternName='string'
)
[REQUIRED]
The name of the resource group.
[REQUIRED]
The name of the log pattern set.
[REQUIRED]
The name of the log pattern.
dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.BadRequestExceptionApplicationInsights.Client.exceptions.InternalServerExceptiondescribe_application(**kwargs)¶Describes the application.
See also: AWS API Documentation
Request Syntax
response = client.describe_application(
ResourceGroupName='string'
)
[REQUIRED]
The name of the resource group.
{
'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
Information about the application.
The name of the resource group used for the application.
The lifecycle of the application.
The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.
Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated , failed deployment , and others.
The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:
Indicates whether auto-configuration is turned on for this application.
The method used by Application Insights to onboard your resources.
Exceptions
ApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptiondescribe_component(**kwargs)¶Describes a component and lists the resources that are grouped together in a component.
See also: AWS API Documentation
Request Syntax
response = client.describe_component(
ResourceGroupName='string',
ComponentName='string'
)
[REQUIRED]
The name of the resource group.
[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_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY',
'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.
ResourceList (list) --
The list of resource ARNs that belong to the component.
Exceptions
ApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptiondescribe_component_configuration(**kwargs)¶Describes the monitoring configuration of the component.
See also: AWS API Documentation
Request Syntax
response = client.describe_component_configuration(
ResourceGroupName='string',
ComponentName='string'
)
[REQUIRED]
The name of the resource group.
[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_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY',
'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.
Exceptions
ApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptiondescribe_component_configuration_recommendation(**kwargs)¶Describes the recommended monitoring configuration of the component.
See also: AWS API Documentation
Request Syntax
response = 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_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'
)
[REQUIRED]
The name of the resource group.
[REQUIRED]
The name of the component.
[REQUIRED]
The tier of the application component.
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.
Exceptions
ApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptiondescribe_log_pattern(**kwargs)¶Describe a specific log pattern from a LogPatternSet .
See also: AWS API Documentation
Request Syntax
response = client.describe_log_pattern(
ResourceGroupName='string',
PatternSetName='string',
PatternName='string'
)
[REQUIRED]
The name of the resource group.
[REQUIRED]
The name of the log pattern set.
[REQUIRED]
The name of the log pattern.
dict
Response Syntax
{
'ResourceGroupName': 'string',
'LogPattern': {
'PatternSetName': 'string',
'PatternName': 'string',
'Pattern': 'string',
'Rank': 123
}
}
Response Structure
(dict) --
ResourceGroupName (string) --
The name of the resource group.
LogPattern (dict) --
The successfully created log pattern.
PatternSetName (string) --
The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
PatternName (string) --
The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
Pattern (string) --
A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
Rank (integer) --
Rank of the log pattern. Must be a value between 1 and 1,000,000 . The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.
Exceptions
ApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptiondescribe_observation(**kwargs)¶Describes an anomaly or error with the application.
See also: AWS API Documentation
Request Syntax
response = client.describe_observation(
ObservationId='string'
)
[REQUIRED]
The ID of the observation.
{
'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,
'CloudWatchEventId': 'string',
'CloudWatchEventSource': 'EC2'|'CODE_DEPLOY'|'HEALTH'|'RDS',
'CloudWatchEventDetailType': 'string',
'HealthEventArn': 'string',
'HealthService': 'string',
'HealthEventTypeCode': 'string',
'HealthEventTypeCategory': 'string',
'HealthEventDescription': 'string',
'CodeDeployDeploymentId': 'string',
'CodeDeployDeploymentGroup': 'string',
'CodeDeployState': 'string',
'CodeDeployApplication': 'string',
'CodeDeployInstanceGroupId': 'string',
'Ec2State': 'string',
'RdsEventCategories': 'string',
'RdsEventMessage': 'string',
'S3EventName': 'string',
'StatesExecutionArn': 'string',
'StatesArn': 'string',
'StatesStatus': 'string',
'StatesInput': 'string',
'EbsEvent': 'string',
'EbsResult': 'string',
'EbsCause': 'string',
'EbsRequestId': 'string',
'XRayFaultPercent': 123,
'XRayThrottlePercent': 123,
'XRayErrorPercent': 123,
'XRayRequestCount': 123,
'XRayRequestAverageLatency': 123,
'XRayNodeName': 'string',
'XRayNodeType': 'string'
}
}
Response Structure
Information about the observation.
The ID of the observation type.
The time when the observation was first detected, in epoch seconds.
The time when the observation ended, in epoch seconds.
The source type of the observation.
The source resource ARN of the observation.
The log group name.
The timestamp in the CloudWatch Logs that specifies when the matched line occurred.
The log text of the observation.
The log filter of the observation.
The namespace of the observation metric.
The name of the observation metric.
The unit of the source observation metric.
The value of the source observation metric.
The ID of the CloudWatch Event-based observation related to the detected problem.
The source of the CloudWatch Event.
The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification .
The Amazon Resource Name (ARN) of the AWS Health Event-based observation.
The service to which the AWS Health Event belongs, such as EC2.
The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE .
The category of the AWS Health event, such as issue .
The description of the AWS Health event provided by the service, such as Amazon EC2.
The deployment ID of the CodeDeploy-based observation related to the detected problem.
The deployment group to which the CodeDeploy deployment belongs.
The status of the CodeDeploy deployment, for example SUCCESS or FAILURE .
The CodeDeploy application to which the deployment belongs.
The instance group to which the CodeDeploy instance belongs.
The state of the instance, such as STOPPING or TERMINATING .
The category of an RDS event.
The message of an RDS event.
The name of the S3 CloudWatch Event-based observation.
The Amazon Resource Name (ARN) of the step function execution-based observation.
The Amazon Resource Name (ARN) of the step function-based observation.
The status of the step function-related observation.
The input to the step function-based observation.
The type of EBS CloudWatch event, such as createVolume , deleteVolume or attachVolume .
The result of an EBS CloudWatch event, such as failed or succeeded .
The cause of an EBS CloudWatch event.
The request ID of an EBS CloudWatch event.
The X-Ray request fault percentage for this node.
The X-Ray request throttle percentage for this node.
The X-Ray request error percentage for this node.
The X-Ray request count for this node.
The X-Ray node request average latency for this node.
The name of the X-Ray node.
The type of the X-Ray node.
Exceptions
ApplicationInsights.Client.exceptions.InternalServerExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.ResourceNotFoundExceptiondescribe_problem(**kwargs)¶Describes an application problem.
See also: AWS API Documentation
Request Syntax
response = client.describe_problem(
ProblemId='string'
)
[REQUIRED]
The ID of the problem.
{
'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': 'Informative'|'Low'|'Medium'|'High',
'ResourceGroupName': 'string',
'Feedback': {
'string': 'NOT_SPECIFIED'|'USEFUL'|'NOT_USEFUL'
},
'RecurringCount': 123,
'LastRecurrenceTime': datetime(2015, 1, 1)
}
}
Response Structure
Information about the problem.
The ID of the problem.
The name of the problem.
A detailed analysis of the problem using machine learning.
The status of the problem.
The resource affected by the problem.
The time when the problem started, in epoch seconds.
The time when the problem ended, in epoch seconds.
A measure of the level of impact of the problem.
The name of the resource group affected by the problem.
Feedback provided by the user about the problem.
The number of times that the same problem reoccurred after the first time it was resolved.
The last time that the problem reoccurred after its last resolution.
Exceptions
ApplicationInsights.Client.exceptions.InternalServerExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.ResourceNotFoundExceptiondescribe_problem_observations(**kwargs)¶Describes the anomalies or errors associated with the problem.
See also: AWS API Documentation
Request Syntax
response = client.describe_problem_observations(
ProblemId='string'
)
[REQUIRED]
The ID of the problem.
{
'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,
'CloudWatchEventId': 'string',
'CloudWatchEventSource': 'EC2'|'CODE_DEPLOY'|'HEALTH'|'RDS',
'CloudWatchEventDetailType': 'string',
'HealthEventArn': 'string',
'HealthService': 'string',
'HealthEventTypeCode': 'string',
'HealthEventTypeCategory': 'string',
'HealthEventDescription': 'string',
'CodeDeployDeploymentId': 'string',
'CodeDeployDeploymentGroup': 'string',
'CodeDeployState': 'string',
'CodeDeployApplication': 'string',
'CodeDeployInstanceGroupId': 'string',
'Ec2State': 'string',
'RdsEventCategories': 'string',
'RdsEventMessage': 'string',
'S3EventName': 'string',
'StatesExecutionArn': 'string',
'StatesArn': 'string',
'StatesStatus': 'string',
'StatesInput': 'string',
'EbsEvent': 'string',
'EbsResult': 'string',
'EbsCause': 'string',
'EbsRequestId': 'string',
'XRayFaultPercent': 123,
'XRayThrottlePercent': 123,
'XRayErrorPercent': 123,
'XRayRequestCount': 123,
'XRayRequestAverageLatency': 123,
'XRayNodeName': 'string',
'XRayNodeType': 'string'
},
]
}
}
Response Structure
Observations related to the problem.
The list of observations related to the problem.
Describes an anomaly or error with the application.
The ID of the observation type.
The time when the observation was first detected, in epoch seconds.
The time when the observation ended, in epoch seconds.
The source type of the observation.
The source resource ARN of the observation.
The log group name.
The timestamp in the CloudWatch Logs that specifies when the matched line occurred.
The log text of the observation.
The log filter of the observation.
The namespace of the observation metric.
The name of the observation metric.
The unit of the source observation metric.
The value of the source observation metric.
The ID of the CloudWatch Event-based observation related to the detected problem.
The source of the CloudWatch Event.
The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification .
The Amazon Resource Name (ARN) of the AWS Health Event-based observation.
The service to which the AWS Health Event belongs, such as EC2.
The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE .
The category of the AWS Health event, such as issue .
The description of the AWS Health event provided by the service, such as Amazon EC2.
The deployment ID of the CodeDeploy-based observation related to the detected problem.
The deployment group to which the CodeDeploy deployment belongs.
The status of the CodeDeploy deployment, for example SUCCESS or FAILURE .
The CodeDeploy application to which the deployment belongs.
The instance group to which the CodeDeploy instance belongs.
The state of the instance, such as STOPPING or TERMINATING .
The category of an RDS event.
The message of an RDS event.
The name of the S3 CloudWatch Event-based observation.
The Amazon Resource Name (ARN) of the step function execution-based observation.
The Amazon Resource Name (ARN) of the step function-based observation.
The status of the step function-related observation.
The input to the step function-based observation.
The type of EBS CloudWatch event, such as createVolume , deleteVolume or attachVolume .
The result of an EBS CloudWatch event, such as failed or succeeded .
The cause of an EBS CloudWatch event.
The request ID of an EBS CloudWatch event.
The X-Ray request fault percentage for this node.
The X-Ray request throttle percentage for this node.
The X-Ray request error percentage for this node.
The X-Ray request count for this node.
The X-Ray node request average latency for this node.
The name of the X-Ray node.
The type of the X-Ray node.
Exceptions
ApplicationInsights.Client.exceptions.InternalServerExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.ResourceNotFoundExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_applications(**kwargs)¶Lists the IDs of the applications that you are monitoring.
See also: AWS API Documentation
Request Syntax
response = client.list_applications(
MaxResults=123,
NextToken='string'
)
NextToken value.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:
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.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptionlist_components(**kwargs)¶Lists the auto-grouped, standalone, and custom components of the application.
See also: AWS API Documentation
Request Syntax
response = client.list_components(
ResourceGroupName='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The name of the resource group.
NextToken value.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_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY',
'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.
NextToken (string) --
The token to request the next page of results.
Exceptions
ApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptionlist_configuration_history(**kwargs)¶Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:
See also: AWS API Documentation
Request Syntax
response = client.list_configuration_history(
ResourceGroupName='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
EventStatus='INFO'|'WARN'|'ERROR',
MaxResults=123,
NextToken='string'
)
ListConfigurationHistory in paginated output. When this parameter is used, ListConfigurationHistory returns only MaxResults in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another ListConfigurationHistory request with the returned NextToken value. If this parameter is not used, then ListConfigurationHistory returns all results.NextToken value returned from a previous paginated ListConfigurationHistory request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.dict
Response Syntax
{
'EventList': [
{
'MonitoredResourceARN': 'string',
'EventStatus': 'INFO'|'WARN'|'ERROR',
'EventResourceType': 'CLOUDWATCH_ALARM'|'CLOUDWATCH_LOG'|'CLOUDFORMATION'|'SSM_ASSOCIATION',
'EventTime': datetime(2015, 1, 1),
'EventDetail': 'string',
'EventResourceName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EventList (list) --
The list of configuration events and their corresponding details.
(dict) --
The event information.
MonitoredResourceARN (string) --
The resource monitored by Application Insights.
EventStatus (string) --
The status of the configuration update event. Possible values include INFO, WARN, and ERROR.
EventResourceType (string) --
The resource type that Application Insights attempted to configure, for example, CLOUDWATCH_ALARM.
EventTime (datetime) --
The timestamp of the event.
EventDetail (string) --
The details of the event in plain text.
EventResourceName (string) --
The name of the resource Application Insights attempted to configure.
NextToken (string) --
The NextToken value to include in a future ListConfigurationHistory request. When the results of a ListConfigurationHistory request exceed MaxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
ApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.InternalServerExceptionlist_log_pattern_sets(**kwargs)¶Lists the log pattern sets in the specific application.
See also: AWS API Documentation
Request Syntax
response = client.list_log_pattern_sets(
ResourceGroupName='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The name of the resource group.
NextToken value.dict
Response Syntax
{
'ResourceGroupName': 'string',
'LogPatternSets': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceGroupName (string) --
The name of the resource group.
LogPatternSets (list) --
The list of log pattern sets.
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.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptionlist_log_patterns(**kwargs)¶Lists the log patterns in the specific log LogPatternSet .
See also: AWS API Documentation
Request Syntax
response = client.list_log_patterns(
ResourceGroupName='string',
PatternSetName='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The name of the resource group.
NextToken value.dict
Response Syntax
{
'ResourceGroupName': 'string',
'LogPatterns': [
{
'PatternSetName': 'string',
'PatternName': 'string',
'Pattern': 'string',
'Rank': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceGroupName (string) --
The name of the resource group.
LogPatterns (list) --
The list of log patterns.
(dict) --
An object that defines the log patterns that belongs to a LogPatternSet .
PatternSetName (string) --
The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
PatternName (string) --
The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
Pattern (string) --
A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
Rank (integer) --
Rank of the log pattern. Must be a value between 1 and 1,000,000 . The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.
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.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptionlist_problems(**kwargs)¶Lists the problems with your application.
See also: AWS API Documentation
Request Syntax
response = client.list_problems(
ResourceGroupName='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string',
ComponentName='string'
)
NextToken value.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': 'Informative'|'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.
RecurringCount (integer) --
The number of times that the same problem reoccurred after the first time it was resolved.
LastRecurrenceTime (datetime) --
The last time that the problem reoccurred after its last resolution.
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) --
The name of the resource group.
Exceptions
ApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.InternalServerExceptionRetrieve a list of the tags (keys and values) that are associated with a specified application. A tag is a label that you optionally define and associate with an application. Each tag consists of a required tag key and an optional associated tag value . A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application that you want to retrieve tag information for.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
An array that lists all the tags that are associated with the application. Each tag consists of a required tag key (Key ) and an associated tag value (Value ).
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:
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.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.
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.
Exceptions
ApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptiontag_resource(**kwargs)¶Add one or more tags (keys and values) to a specified application. A tag is a label that you optionally define and associate with an application. Tags can help you categorize and manage application 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 more specific tag values. A tag value acts as a descriptor within a tag key.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application that you want to add one or more tags to.
[REQUIRED]
A list of tags that to add to the application. A tag consists of a required 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.
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:
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.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.
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.
dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.TooManyTagsExceptionApplicationInsights.Client.exceptions.ValidationExceptionuntag_resource(**kwargs)¶Remove one or more tags (keys and values) from a specified application.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the application that you want to remove one or more tags from.
[REQUIRED]
The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.
To remove more than one tag from the application, append the TagKeys parameter and argument for each additional tag to remove, separated by an ampersand.
dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionupdate_application(**kwargs)¶Updates the application.
See also: AWS API Documentation
Request Syntax
response = client.update_application(
ResourceGroupName='string',
OpsCenterEnabled=True|False,
CWEMonitorEnabled=True|False,
OpsItemSNSTopicArn='string',
RemoveSNSTopic=True|False,
AutoConfigEnabled=True|False
)
[REQUIRED]
The name of the resource group.
true , creates opsItems for any problems detected on an application.instance terminated , failed deployment , and others.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:
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.InternalServerExceptionApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionupdate_component(**kwargs)¶Updates the custom component name and/or the list of resources that make up the component.
See also: AWS API Documentation
Request Syntax
response = client.update_component(
ResourceGroupName='string',
ComponentName='string',
NewComponentName='string',
ResourceList=[
'string',
]
)
[REQUIRED]
The name of the resource group.
[REQUIRED]
The name of the component.
The list of resource ARNs that belong to the component.
dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationInsights.Client.exceptions.ResourceInUseExceptionApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptionupdate_component_configuration(**kwargs)¶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
response = 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_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY',
ComponentConfiguration='string',
AutoConfigEnabled=True|False
)
[REQUIRED]
The name of the resource group.
[REQUIRED]
The name of the component.
DescribeComponentConfigurationRecommendation to see the recommended configuration for a component. For the complete format of the component configuration file, see Component Configuration .dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptionupdate_log_pattern(**kwargs)¶Adds a log pattern to a LogPatternSet .
See also: AWS API Documentation
Request Syntax
response = client.update_log_pattern(
ResourceGroupName='string',
PatternSetName='string',
PatternName='string',
Pattern='string',
Rank=123
)
[REQUIRED]
The name of the resource group.
[REQUIRED]
The name of the log pattern set.
[REQUIRED]
The name of the log pattern.
1 and 1,000,000 . The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.dict
Response Syntax
{
'ResourceGroupName': 'string',
'LogPattern': {
'PatternSetName': 'string',
'PatternName': 'string',
'Pattern': 'string',
'Rank': 123
}
}
Response Structure
(dict) --
ResourceGroupName (string) --
The name of the resource group.
LogPattern (dict) --
The successfully created log pattern.
PatternSetName (string) --
The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
PatternName (string) --
The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
Pattern (string) --
A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
Rank (integer) --
Rank of the log pattern. Must be a value between 1 and 1,000,000 . The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.
Exceptions
ApplicationInsights.Client.exceptions.ResourceInUseExceptionApplicationInsights.Client.exceptions.ResourceNotFoundExceptionApplicationInsights.Client.exceptions.ValidationExceptionApplicationInsights.Client.exceptions.InternalServerExceptionThe available paginators are: