2023/07/28 - Amazon CloudWatch Application Insights - 6 new17 updated api methods
Changes This release enable customer to add/remove/update more than one workload for a component
Describes a workload and its configuration.
See also: AWS API Documentation
Request Syntax
client.describe_workload(
ResourceGroupName='string',
ComponentName='string',
WorkloadId='string',
AccountId='string'
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
string
[REQUIRED]
The ID of the workload.
string
The AWS account ID for the workload owner.
dict
Response Syntax
{
'WorkloadId': 'string',
'WorkloadRemarks': 'string',
'WorkloadConfiguration': {
'WorkloadName': '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'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
'Configuration': 'string'
}
}
Response Structure
(dict) --
WorkloadId (string) --
The ID of the workload.
WorkloadRemarks (string) --
If logging is supported for the resource type, shows whether the component has configured logs to be monitored.
WorkloadConfiguration (dict) --
The configuration settings of the workload. The value is the escaped JSON of the configuration.
WorkloadName (string) --
The name of the workload.
Tier (string) --
The configuration of the workload tier.
Configuration (string) --
The configuration settings of the workload.
Updates the visibility of the problem or specifies the problem as RESOLVED.
See also: AWS API Documentation
Request Syntax
client.update_problem(
ProblemId='string',
UpdateStatus='RESOLVED',
Visibility='IGNORED'|'VISIBLE'
)
string
[REQUIRED]
The ID of the problem.
string
The status of the problem. Arguments can be passed for only problems that show a status of RECOVERING.
string
The visibility of a problem. When you pass a value of IGNORED, the problem is removed from the default view, and all notifications for the problem are suspended. When VISIBLE is passed, the IGNORED action is reversed.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the workloads that are configured on a given component.
See also: AWS API Documentation
Request Syntax
client.list_workloads(
ResourceGroupName='string',
ComponentName='string',
MaxResults=123,
NextToken='string',
AccountId='string'
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
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
The AWS account ID of the owner of the workload.
dict
Response Syntax
{
'WorkloadList': [
{
'WorkloadId': 'string',
'ComponentName': 'string',
'WorkloadName': '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'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
'WorkloadRemarks': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
WorkloadList (list) --
The list of workloads.
(dict) --
Describes the workloads on a component.
WorkloadId (string) --
The ID of the workload.
ComponentName (string) --
The name of the component.
WorkloadName (string) --
The name of the workload.
Tier (string) --
The tier of the workload.
WorkloadRemarks (string) --
If logging is supported for the resource type, shows whether the component has configured logs to be monitored.
NextToken (string) --
The token to request the next page of results.
Remove workload from a component.
See also: AWS API Documentation
Request Syntax
client.remove_workload(
ResourceGroupName='string',
ComponentName='string',
WorkloadId='string'
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
string
[REQUIRED]
The ID of the workload.
dict
Response Syntax
{}
Response Structure
(dict) --
Adds a workload to a component. Each component can have at most five workloads.
See also: AWS API Documentation
Request Syntax
client.add_workload(
ResourceGroupName='string',
ComponentName='string',
WorkloadConfiguration={
'WorkloadName': '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'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
'Configuration': 'string'
}
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
dict
[REQUIRED]
The configuration settings of the workload. The value is the escaped JSON of the configuration.
WorkloadName (string) --
The name of the workload.
Tier (string) --
The configuration of the workload tier.
Configuration (string) --
The configuration settings of the workload.
dict
Response Syntax
{
'WorkloadId': 'string',
'WorkloadConfiguration': {
'WorkloadName': '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'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
'Configuration': 'string'
}
}
Response Structure
(dict) --
WorkloadId (string) --
The ID of the workload.
WorkloadConfiguration (dict) --
The configuration settings of the workload. The value is the escaped JSON of the configuration.
WorkloadName (string) --
The name of the workload.
Tier (string) --
The configuration of the workload tier.
Configuration (string) --
The configuration settings of the workload.
Adds a workload to a component. Each component can have at most five workloads.
See also: AWS API Documentation
Request Syntax
client.update_workload(
ResourceGroupName='string',
ComponentName='string',
WorkloadId='string',
WorkloadConfiguration={
'WorkloadName': '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'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
'Configuration': 'string'
}
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
string
The ID of the workload.
dict
[REQUIRED]
The configuration settings of the workload. The value is the escaped JSON of the configuration.
WorkloadName (string) --
The name of the workload.
Tier (string) --
The configuration of the workload tier.
Configuration (string) --
The configuration settings of the workload.
dict
Response Syntax
{
'WorkloadId': 'string',
'WorkloadConfiguration': {
'WorkloadName': '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'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
'Configuration': 'string'
}
}
Response Structure
(dict) --
WorkloadId (string) --
The ID of the workload.
WorkloadConfiguration (dict) --
The configuration settings of the workload. The value is the escaped JSON of the configuration.
WorkloadName (string) --
The name of the workload.
Tier (string) --
The configuration of the workload tier.
Configuration (string) --
The configuration settings of the workload.
{'ApplicationInfo': {'AccountId': 'string'}}
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,
GroupingType='ACCOUNT_BASED'
)
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
Indicates whether Application Insights automatically configures unmonitored resources in the resource group.
boolean
Configures all of the resources in the resource group by applying the recommended configurations.
string
Application Insights can create applications based on a resource group or on an account. To create an account-based application using all of the resources in the account, set this parameter to ACCOUNT_BASED.
dict
Response Syntax
{
'ApplicationInfo': {
'AccountId': 'string',
'ResourceGroupName': 'string',
'LifeCycle': 'string',
'OpsItemSNSTopicArn': 'string',
'OpsCenterEnabled': True|False,
'CWEMonitorEnabled': True|False,
'Remarks': 'string',
'AutoConfigEnabled': True|False,
'DiscoveryType': 'RESOURCE_GROUP_BASED'|'ACCOUNT_BASED'
}
}
Response Structure
(dict) --
ApplicationInfo (dict) --
Information about the application.
AccountId (string) --
The AWS account ID for the owner of the application.
ResourceGroupName (string) --
The name of the resource group used for the application.
LifeCycle (string) --
The lifecycle of the application.
OpsItemSNSTopicArn (string) --
The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.
OpsCenterEnabled (boolean) --
Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.
CWEMonitorEnabled (boolean) --
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.
Remarks (string) --
The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:
“Configuring application, detected 1 Errors, 3 Warnings”
“Configuring application, detected 1 Unconfigured Components”
AutoConfigEnabled (boolean) --
Indicates whether auto-configuration is turned on for this application.
DiscoveryType (string) --
The method used by Application Insights to onboard your resources.
{'AccountId': 'string'}
Response {'ApplicationInfo': {'AccountId': 'string'}}
Describes the application.
See also: AWS API Documentation
Request Syntax
client.describe_application(
ResourceGroupName='string',
AccountId='string'
)
string
[REQUIRED]
The name of the resource group.
string
The AWS account ID for the resource group owner.
dict
Response Syntax
{
'ApplicationInfo': {
'AccountId': 'string',
'ResourceGroupName': 'string',
'LifeCycle': 'string',
'OpsItemSNSTopicArn': 'string',
'OpsCenterEnabled': True|False,
'CWEMonitorEnabled': True|False,
'Remarks': 'string',
'AutoConfigEnabled': True|False,
'DiscoveryType': 'RESOURCE_GROUP_BASED'|'ACCOUNT_BASED'
}
}
Response Structure
(dict) --
ApplicationInfo (dict) --
Information about the application.
AccountId (string) --
The AWS account ID for the owner of the application.
ResourceGroupName (string) --
The name of the resource group used for the application.
LifeCycle (string) --
The lifecycle of the application.
OpsItemSNSTopicArn (string) --
The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.
OpsCenterEnabled (boolean) --
Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.
CWEMonitorEnabled (boolean) --
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.
Remarks (string) --
The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:
“Configuring application, detected 1 Errors, 3 Warnings”
“Configuring application, detected 1 Unconfigured Components”
AutoConfigEnabled (boolean) --
Indicates whether auto-configuration is turned on for this application.
DiscoveryType (string) --
The method used by Application Insights to onboard your resources.
{'AccountId': 'string'}
Response {'ApplicationComponent': {'Tier': {'SAP_NETWEAVER_DISTRIBUTED',
'SAP_NETWEAVER_HIGH_AVAILABILITY',
'SAP_NETWEAVER_STANDARD'}}}
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',
AccountId='string'
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
string
The AWS account ID for the resource group owner.
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'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
'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) --
{'AccountId': 'string'}
Response {'Tier': {'SAP_NETWEAVER_DISTRIBUTED',
'SAP_NETWEAVER_HIGH_AVAILABILITY',
'SAP_NETWEAVER_STANDARD'}}
Describes the monitoring configuration of the component.
See also: AWS API Documentation
Request Syntax
client.describe_component_configuration(
ResourceGroupName='string',
ComponentName='string',
AccountId='string'
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
string
The AWS account ID for the resource group owner.
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'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
'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.
{'RecommendationType': 'INFRA_ONLY | WORKLOAD_ONLY | ALL',
'Tier': {'SAP_NETWEAVER_DISTRIBUTED',
'SAP_NETWEAVER_HIGH_AVAILABILITY',
'SAP_NETWEAVER_STANDARD'}}
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_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
RecommendationType='INFRA_ONLY'|'WORKLOAD_ONLY'|'ALL'
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
string
[REQUIRED]
The tier of the application component.
string
The recommended configuration type.
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.
{'AccountId': 'string'}
Describe a specific log pattern from a LogPatternSet.
See also: AWS API Documentation
Request Syntax
client.describe_log_pattern(
ResourceGroupName='string',
PatternSetName='string',
PatternName='string',
AccountId='string'
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the log pattern set.
string
[REQUIRED]
The name of the log pattern.
string
The AWS account ID for the resource group owner.
dict
Response Syntax
{
'ResourceGroupName': 'string',
'AccountId': 'string',
'LogPattern': {
'PatternSetName': 'string',
'PatternName': 'string',
'Pattern': 'string',
'Rank': 123
}
}
Response Structure
(dict) --
ResourceGroupName (string) --
The name of the resource group.
AccountId (string) --
The AWS account ID for the resource group owner.
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.
{'AccountId': 'string'}
Describes an anomaly or error with the application.
See also: AWS API Documentation
Request Syntax
client.describe_observation(
ObservationId='string',
AccountId='string'
)
string
[REQUIRED]
The ID of the observation.
string
The AWS account ID for the resource group owner.
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,
'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
(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.
CloudWatchEventId (string) --
The ID of the CloudWatch Event-based observation related to the detected problem.
CloudWatchEventSource (string) --
The source of the CloudWatch Event.
CloudWatchEventDetailType (string) --
The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification.
HealthEventArn (string) --
The Amazon Resource Name (ARN) of the AWS Health Event-based observation.
HealthService (string) --
The service to which the AWS Health Event belongs, such as EC2.
HealthEventTypeCode (string) --
The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE.
HealthEventTypeCategory (string) --
The category of the AWS Health event, such as issue.
HealthEventDescription (string) --
The description of the AWS Health event provided by the service, such as Amazon EC2.
CodeDeployDeploymentId (string) --
The deployment ID of the CodeDeploy-based observation related to the detected problem.
CodeDeployDeploymentGroup (string) --
The deployment group to which the CodeDeploy deployment belongs.
CodeDeployState (string) --
The status of the CodeDeploy deployment, for example SUCCESS or FAILURE.
CodeDeployApplication (string) --
The CodeDeploy application to which the deployment belongs.
CodeDeployInstanceGroupId (string) --
The instance group to which the CodeDeploy instance belongs.
Ec2State (string) --
The state of the instance, such as STOPPING or TERMINATING.
RdsEventCategories (string) --
The category of an RDS event.
RdsEventMessage (string) --
The message of an RDS event.
S3EventName (string) --
The name of the S3 CloudWatch Event-based observation.
StatesExecutionArn (string) --
The Amazon Resource Name (ARN) of the step function execution-based observation.
StatesArn (string) --
The Amazon Resource Name (ARN) of the step function-based observation.
StatesStatus (string) --
The status of the step function-related observation.
StatesInput (string) --
The input to the step function-based observation.
EbsEvent (string) --
The type of EBS CloudWatch event, such as createVolume, deleteVolume or attachVolume.
EbsResult (string) --
The result of an EBS CloudWatch event, such as failed or succeeded.
EbsCause (string) --
The cause of an EBS CloudWatch event.
EbsRequestId (string) --
The request ID of an EBS CloudWatch event.
XRayFaultPercent (integer) --
The X-Ray request fault percentage for this node.
XRayThrottlePercent (integer) --
The X-Ray request throttle percentage for this node.
XRayErrorPercent (integer) --
The X-Ray request error percentage for this node.
XRayRequestCount (integer) --
The X-Ray request count for this node.
XRayRequestAverageLatency (integer) --
The X-Ray node request average latency for this node.
XRayNodeName (string) --
The name of the X-Ray node.
XRayNodeType (string) --
The type of the X-Ray node.
{'AccountId': 'string'}
Response {'Problem': {'AccountId': 'string',
'ResolutionMethod': 'MANUAL | AUTOMATIC | UNRESOLVED',
'Status': {'RECOVERING'},
'Visibility': 'IGNORED | VISIBLE'}}
Describes an application problem.
See also: AWS API Documentation
Request Syntax
client.describe_problem(
ProblemId='string',
AccountId='string'
)
string
[REQUIRED]
The ID of the problem.
string
The AWS account ID for the owner of the resource group affected by the problem.
dict
Response Syntax
{
'Problem': {
'Id': 'string',
'Title': 'string',
'Insights': 'string',
'Status': 'IGNORE'|'RESOLVED'|'PENDING'|'RECURRING'|'RECOVERING',
'AffectedResource': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'SeverityLevel': 'Informative'|'Low'|'Medium'|'High',
'AccountId': 'string',
'ResourceGroupName': 'string',
'Feedback': {
'string': 'NOT_SPECIFIED'|'USEFUL'|'NOT_USEFUL'
},
'RecurringCount': 123,
'LastRecurrenceTime': datetime(2015, 1, 1),
'Visibility': 'IGNORED'|'VISIBLE',
'ResolutionMethod': 'MANUAL'|'AUTOMATIC'|'UNRESOLVED'
}
}
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.
AccountId (string) --
The AWS account ID for the owner of the resource group affected by 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) --
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.
Visibility (string) --
Specifies whether or not you can view the problem. Updates to ignored problems do not generate notifications.
ResolutionMethod (string) --
Specifies how the problem was resolved. If the value is AUTOMATIC, the system resolved the problem. If the value is MANUAL, the user resolved the problem. If the value is UNRESOLVED, then the problem is not resolved.
{'AccountId': 'string'}
Describes the anomalies or errors associated with the problem.
See also: AWS API Documentation
Request Syntax
client.describe_problem_observations(
ProblemId='string',
AccountId='string'
)
string
[REQUIRED]
The ID of the problem.
string
The AWS account ID for the resource group owner.
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,
'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
(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.
CloudWatchEventId (string) --
The ID of the CloudWatch Event-based observation related to the detected problem.
CloudWatchEventSource (string) --
The source of the CloudWatch Event.
CloudWatchEventDetailType (string) --
The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification.
HealthEventArn (string) --
The Amazon Resource Name (ARN) of the AWS Health Event-based observation.
HealthService (string) --
The service to which the AWS Health Event belongs, such as EC2.
HealthEventTypeCode (string) --
The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE.
HealthEventTypeCategory (string) --
The category of the AWS Health event, such as issue.
HealthEventDescription (string) --
The description of the AWS Health event provided by the service, such as Amazon EC2.
CodeDeployDeploymentId (string) --
The deployment ID of the CodeDeploy-based observation related to the detected problem.
CodeDeployDeploymentGroup (string) --
The deployment group to which the CodeDeploy deployment belongs.
CodeDeployState (string) --
The status of the CodeDeploy deployment, for example SUCCESS or FAILURE.
CodeDeployApplication (string) --
The CodeDeploy application to which the deployment belongs.
CodeDeployInstanceGroupId (string) --
The instance group to which the CodeDeploy instance belongs.
Ec2State (string) --
The state of the instance, such as STOPPING or TERMINATING.
RdsEventCategories (string) --
The category of an RDS event.
RdsEventMessage (string) --
The message of an RDS event.
S3EventName (string) --
The name of the S3 CloudWatch Event-based observation.
StatesExecutionArn (string) --
The Amazon Resource Name (ARN) of the step function execution-based observation.
StatesArn (string) --
The Amazon Resource Name (ARN) of the step function-based observation.
StatesStatus (string) --
The status of the step function-related observation.
StatesInput (string) --
The input to the step function-based observation.
EbsEvent (string) --
The type of EBS CloudWatch event, such as createVolume, deleteVolume or attachVolume.
EbsResult (string) --
The result of an EBS CloudWatch event, such as failed or succeeded.
EbsCause (string) --
The cause of an EBS CloudWatch event.
EbsRequestId (string) --
The request ID of an EBS CloudWatch event.
XRayFaultPercent (integer) --
The X-Ray request fault percentage for this node.
XRayThrottlePercent (integer) --
The X-Ray request throttle percentage for this node.
XRayErrorPercent (integer) --
The X-Ray request error percentage for this node.
XRayRequestCount (integer) --
The X-Ray request count for this node.
XRayRequestAverageLatency (integer) --
The X-Ray node request average latency for this node.
XRayNodeName (string) --
The name of the X-Ray node.
XRayNodeType (string) --
The type of the X-Ray node.
{'AccountId': 'string'}
Response {'ApplicationInfoList': {'AccountId': 'string'}}
Lists the IDs of the applications that you are monitoring.
See also: AWS API Documentation
Request Syntax
client.list_applications(
MaxResults=123,
NextToken='string',
AccountId='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.
string
The AWS account ID for the resource group owner.
dict
Response Syntax
{
'ApplicationInfoList': [
{
'AccountId': 'string',
'ResourceGroupName': 'string',
'LifeCycle': 'string',
'OpsItemSNSTopicArn': 'string',
'OpsCenterEnabled': True|False,
'CWEMonitorEnabled': True|False,
'Remarks': 'string',
'AutoConfigEnabled': True|False,
'DiscoveryType': 'RESOURCE_GROUP_BASED'|'ACCOUNT_BASED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ApplicationInfoList (list) --
The list of applications.
(dict) --
Describes the status of the application.
AccountId (string) --
The AWS account ID for the owner of the application.
ResourceGroupName (string) --
The name of the resource group used for the application.
LifeCycle (string) --
The lifecycle of the application.
OpsItemSNSTopicArn (string) --
The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.
OpsCenterEnabled (boolean) --
Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.
CWEMonitorEnabled (boolean) --
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.
Remarks (string) --
The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:
“Configuring application, detected 1 Errors, 3 Warnings”
“Configuring application, detected 1 Unconfigured Components”
AutoConfigEnabled (boolean) --
Indicates whether auto-configuration is turned on for this application.
DiscoveryType (string) --
The method used by Application Insights to onboard your resources.
NextToken (string) --
The token used to retrieve the next page of results. This value is null when there are no more results to return.
{'AccountId': 'string'}
Response {'ApplicationComponentList': {'Tier': {'SAP_NETWEAVER_DISTRIBUTED',
'SAP_NETWEAVER_HIGH_AVAILABILITY',
'SAP_NETWEAVER_STANDARD'}}}
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',
AccountId='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.
string
The AWS account ID for the resource group owner.
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'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
'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.
{'AccountId': 'string'}
Response {'EventList': {'AccountId': 'string', 'ResourceGroupName': 'string'}}
Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:
INFO: creating a new alarm or updating an alarm threshold.
WARN: alarm not created due to insufficient data points used to predict thresholds.
ERROR: alarm not created due to permission errors or exceeding quotas.
See also: AWS API Documentation
Request Syntax
client.list_configuration_history(
ResourceGroupName='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
EventStatus='INFO'|'WARN'|'ERROR',
MaxResults=123,
NextToken='string',
AccountId='string'
)
string
Resource group to which the application belongs.
datetime
The start time of the event.
datetime
The end time of the event.
string
The status of the configuration update event. Possible values include INFO, WARN, and ERROR.
integer
The maximum number of results returned by 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.
string
The 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.
string
The AWS account ID for the resource group owner.
dict
Response Syntax
{
'EventList': [
{
'ResourceGroupName': 'string',
'AccountId': 'string',
'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.
ResourceGroupName (string) --
The name of the resource group of the application to which the configuration event belongs.
AccountId (string) --
The AWS account ID for the owner of the application to which the configuration event belongs.
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.
{'AccountId': 'string'}
Lists the log pattern sets in the specific application.
See also: AWS API Documentation
Request Syntax
client.list_log_pattern_sets(
ResourceGroupName='string',
MaxResults=123,
NextToken='string',
AccountId='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.
string
The AWS account ID for the resource group owner.
dict
Response Syntax
{
'ResourceGroupName': 'string',
'AccountId': 'string',
'LogPatternSets': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceGroupName (string) --
The name of the resource group.
AccountId (string) --
The AWS account ID for the resource group owner.
LogPatternSets (list) --
The list of log pattern sets.
(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.
{'AccountId': 'string'}
Lists the log patterns in the specific log LogPatternSet.
See also: AWS API Documentation
Request Syntax
client.list_log_patterns(
ResourceGroupName='string',
PatternSetName='string',
MaxResults=123,
NextToken='string',
AccountId='string'
)
string
[REQUIRED]
The name of the resource group.
string
The name of the log pattern set.
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
The AWS account ID for the resource group owner.
dict
Response Syntax
{
'ResourceGroupName': 'string',
'AccountId': 'string',
'LogPatterns': [
{
'PatternSetName': 'string',
'PatternName': 'string',
'Pattern': 'string',
'Rank': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceGroupName (string) --
The name of the resource group.
AccountId (string) --
The AWS account ID for the resource group owner.
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.
{'AccountId': 'string', 'Visibility': 'IGNORED | VISIBLE'}
Response {'AccountId': 'string',
'ProblemList': {'AccountId': 'string',
'ResolutionMethod': 'MANUAL | AUTOMATIC | UNRESOLVED',
'Status': {'RECOVERING'},
'Visibility': 'IGNORED | VISIBLE'}}
Lists the problems with your application.
See also: AWS API Documentation
Request Syntax
client.list_problems(
AccountId='string',
ResourceGroupName='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string',
ComponentName='string',
Visibility='IGNORED'|'VISIBLE'
)
string
The AWS account ID for the resource group owner.
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
The name of the component.
string
Specifies whether or not you can view the problem. If not specified, visible and ignored problems are returned.
dict
Response Syntax
{
'ProblemList': [
{
'Id': 'string',
'Title': 'string',
'Insights': 'string',
'Status': 'IGNORE'|'RESOLVED'|'PENDING'|'RECURRING'|'RECOVERING',
'AffectedResource': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'SeverityLevel': 'Informative'|'Low'|'Medium'|'High',
'AccountId': 'string',
'ResourceGroupName': 'string',
'Feedback': {
'string': 'NOT_SPECIFIED'|'USEFUL'|'NOT_USEFUL'
},
'RecurringCount': 123,
'LastRecurrenceTime': datetime(2015, 1, 1),
'Visibility': 'IGNORED'|'VISIBLE',
'ResolutionMethod': 'MANUAL'|'AUTOMATIC'|'UNRESOLVED'
},
],
'NextToken': 'string',
'ResourceGroupName': 'string',
'AccountId': '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.
AccountId (string) --
The AWS account ID for the owner of the resource group affected by 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) --
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.
Visibility (string) --
Specifies whether or not you can view the problem. Updates to ignored problems do not generate notifications.
ResolutionMethod (string) --
Specifies how the problem was resolved. If the value is AUTOMATIC, the system resolved the problem. If the value is MANUAL, the user resolved the problem. If the value is UNRESOLVED, then the problem is not resolved.
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.
AccountId (string) --
The AWS account ID for the resource group owner.
{'ApplicationInfo': {'AccountId': 'string'}}
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
Turns auto-configuration on or off.
dict
Response Syntax
{
'ApplicationInfo': {
'AccountId': 'string',
'ResourceGroupName': 'string',
'LifeCycle': 'string',
'OpsItemSNSTopicArn': 'string',
'OpsCenterEnabled': True|False,
'CWEMonitorEnabled': True|False,
'Remarks': 'string',
'AutoConfigEnabled': True|False,
'DiscoveryType': 'RESOURCE_GROUP_BASED'|'ACCOUNT_BASED'
}
}
Response Structure
(dict) --
ApplicationInfo (dict) --
Information about the application.
AccountId (string) --
The AWS account ID for the owner of the application.
ResourceGroupName (string) --
The name of the resource group used for the application.
LifeCycle (string) --
The lifecycle of the application.
OpsItemSNSTopicArn (string) --
The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.
OpsCenterEnabled (boolean) --
Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.
CWEMonitorEnabled (boolean) --
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.
Remarks (string) --
The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:
“Configuring application, detected 1 Errors, 3 Warnings”
“Configuring application, detected 1 Unconfigured Components”
AutoConfigEnabled (boolean) --
Indicates whether auto-configuration is turned on for this application.
DiscoveryType (string) --
The method used by Application Insights to onboard your resources.
{'Tier': {'SAP_NETWEAVER_DISTRIBUTED',
'SAP_NETWEAVER_HIGH_AVAILABILITY',
'SAP_NETWEAVER_STANDARD'}}
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_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
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.
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
Automatically configures the component by applying the recommended configurations.
dict
Response Syntax
{}
Response Structure
(dict) --