2019/11/25 - Amazon CloudWatch Application Insights - 9 new 8 updated api methods
Changes CloudWatch Application Insights for .NET and SQL Server includes the follwing features: -Tagging Create and manage tags for your applications.-Custom log pattern matching. Define custom log patterns to be detected and monitored.-Resource-level permissions. Specify applications users can access.
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'
)
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.
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 contains at 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 contains at 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 contains at many as 50 characters, and it cannot be empty.
Rank (integer) --
Rank of the log pattern.
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
client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application that you want to add one or more tags to.
list
[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.
(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.
dict
Response Syntax
{}
Response Structure
(dict) --
Adds a log pattern to a LogPatternSet .
See also: AWS API Documentation
Request Syntax
client.update_log_pattern(
ResourceGroupName='string',
PatternSetName='string',
PatternName='string',
Pattern='string',
Rank=123
)
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 log pattern.
integer
Rank 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 contains at 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 contains at 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 contains at many as 50 characters, and it cannot be empty.
Rank (integer) --
Rank of the log pattern.
Remove one or more tags (keys and values) from a specified application.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application that you want to remove one or more tags from.
list
[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.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Removes the specified log pattern from a LogPatternSet .
See also: AWS API Documentation
Request Syntax
client.delete_log_pattern(
ResourceGroupName='string',
PatternSetName='string',
PatternName='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.
dict
Response Syntax
{}
Response Structure
(dict) --
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'
)
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.
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 contains at 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 contains at 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 contains at many as 50 characters, and it cannot be empty.
Rank (integer) --
Rank of the log pattern.
NextToken (string) --
The token used to retrieve the next page of results. This value is null when there are no more results to return.
Lists the 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'
)
string
[REQUIRED]
The name of the resource group.
integer
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
string
The token to request the next page of results.
dict
Response Syntax
{
'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.
(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.
Adds an log pattern to a LogPatternSet .
See also: AWS API Documentation
Request Syntax
client.create_log_pattern(
ResourceGroupName='string',
PatternSetName='string',
PatternName='string',
Pattern='string',
Rank=123
)
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
[REQUIRED]
The log pattern.
integer
[REQUIRED]
Rank of the log pattern.
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 contains at 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 contains at 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 contains at many as 50 characters, and it cannot be empty.
Rank (integer) --
Rank of the log pattern.
ResourceGroupName (string) --
The name of the resource group.
Retrieve 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
client.list_tags_for_resource(
ResourceARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the application that you want to retrieve tag information for.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Tags (list) --
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 ).
(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) --
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) --
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.
{'Tags': [{'Key': 'string', 'Value': '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,
OpsItemSNSTopicArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the resource group.
boolean
When set to true , creates opsItems for any problems detected on an application.
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.
dict
Response Syntax
{
'ApplicationInfo': {
'ResourceGroupName': 'string',
'LifeCycle': 'string',
'OpsItemSNSTopicArn': 'string',
'OpsCenterEnabled': True|False,
'Remarks': 'string'
}
}
Response Structure
(dict) --
ApplicationInfo (dict) --
Information about the application.
ResourceGroupName (string) --
The name of the resource group used for the application.
LifeCycle (string) --
The lifecycle of the application.
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.
Remarks (string) --
The issues on the user side that block Application Insights from successfully monitoring an application.
{'ApplicationComponent': {'Tier': ['SQL_SERVER',
'DOT_NET_WEB',
'DOT_NET_CORE',
'DOT_NET_WORKER',
'DEFAULT']}}
Describes a component and lists the resources that are grouped together in a component.
See also: AWS API Documentation
Request Syntax
client.describe_component(
ResourceGroupName='string',
ComponentName='string'
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
dict
Response Syntax
{
'ApplicationComponent': {
'ComponentName': 'string',
'ResourceType': 'string',
'Tier': 'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB'|'SQL_SERVER',
'Monitor': True|False
},
'ResourceList': [
'string',
]
}
Response Structure
(dict) --
ApplicationComponent (dict) --
Describes a standalone resource or similarly grouped resources that the application is made up of.
ComponentName (string) --
The name of the component.
ResourceType (string) --
The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.
Tier (string) --
The stack tier of the application component.
Monitor (boolean) --
Indicates whether the application component is monitored.
ResourceList (list) --
The list of resource ARNs that belong to the component.
(string) --
{'Tier': ['SQL_SERVER',
'DOT_NET_WEB',
'DOT_NET_CORE',
'DOT_NET_WORKER',
'DEFAULT']}
Describes the monitoring configuration of the component.
See also: AWS API Documentation
Request Syntax
client.describe_component_configuration(
ResourceGroupName='string',
ComponentName='string'
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
dict
Response Syntax
{
'Monitor': True|False,
'Tier': 'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB'|'SQL_SERVER',
'ComponentConfiguration': 'string'
}
Response Structure
(dict) --
Monitor (boolean) --
Indicates whether the application component is monitored.
Tier (string) --
The tier of the application component. Supported tiers include DOT_NET_CORE , DOT_NET_WORKER , DOT_NET_WEB , SQL_SERVER , and DEFAULT
ComponentConfiguration (string) --
The configuration settings of the component. The value is the escaped JSON of the configuration.
{'Tier': ['SQL_SERVER',
'DOT_NET_WEB',
'DOT_NET_CORE',
'DOT_NET_WORKER',
'DEFAULT']}
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='DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB'|'SQL_SERVER'
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
string
[REQUIRED]
The tier of the application component. Supported tiers include DOT_NET_CORE , DOT_NET_WORKER , DOT_NET_WEB , SQL_SERVER , and DEFAULT .
dict
Response Syntax
{
'ComponentConfiguration': 'string'
}
Response Structure
(dict) --
ComponentConfiguration (string) --
The recommended configuration settings of the component. The value is the escaped JSON of the configuration.
{'Problem': {'SeverityLevel': ['Low', 'High', 'Medium']}}
Describes an application problem.
See also: AWS API Documentation
Request Syntax
client.describe_problem(
ProblemId='string'
)
string
[REQUIRED]
The ID of the problem.
dict
Response Syntax
{
'Problem': {
'Id': 'string',
'Title': 'string',
'Insights': 'string',
'Status': 'IGNORE'|'RESOLVED'|'PENDING',
'AffectedResource': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'SeverityLevel': 'Low'|'Medium'|'High',
'ResourceGroupName': 'string',
'Feedback': {
'string': 'NOT_SPECIFIED'|'USEFUL'|'NOT_USEFUL'
}
}
}
Response Structure
(dict) --
Problem (dict) --
Information about the problem.
Id (string) --
The ID of the problem.
Title (string) --
The name of the problem.
Insights (string) --
A detailed analysis of the problem using machine learning.
Status (string) --
The status of the problem.
AffectedResource (string) --
The resource affected by the problem.
StartTime (datetime) --
The time when the problem started, in epoch seconds.
EndTime (datetime) --
The time when the problem ended, in epoch seconds.
SeverityLevel (string) --
A measure of the level of impact of the problem.
ResourceGroupName (string) --
The name of the resource group affected by the problem.
Feedback (dict) --
Feedback provided by the user about the problem.
(string) --
(string) --
{'ApplicationComponentList': {'Tier': ['SQL_SERVER',
'DOT_NET_WEB',
'DOT_NET_CORE',
'DOT_NET_WORKER',
'DEFAULT']}}
Lists the auto-grouped, standalone, and custom components of the application.
See also: AWS API Documentation
Request Syntax
client.list_components(
ResourceGroupName='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The name of the resource group.
integer
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
string
The token to request the next page of results.
dict
Response Syntax
{
'ApplicationComponentList': [
{
'ComponentName': 'string',
'ResourceType': 'string',
'Tier': 'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB'|'SQL_SERVER',
'Monitor': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ApplicationComponentList (list) --
The list of application components.
(dict) --
Describes a standalone resource or similarly grouped resources that the application is made up of.
ComponentName (string) --
The name of the component.
ResourceType (string) --
The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.
Tier (string) --
The stack tier of the application component.
Monitor (boolean) --
Indicates whether the application component is monitored.
NextToken (string) --
The token to request the next page of results.
{'ProblemList': {'SeverityLevel': ['Low', 'High', 'Medium']}}
Lists the problems with your application.
See also: AWS API Documentation
Request Syntax
client.list_problems(
ResourceGroupName='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string'
)
string
The name of the resource group.
datetime
The time when the problem was detected, in epoch seconds. If you don't specify a time frame for the request, problems within the past seven days are returned.
datetime
The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.
integer
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
string
The token to request the next page of results.
dict
Response Syntax
{
'ProblemList': [
{
'Id': 'string',
'Title': 'string',
'Insights': 'string',
'Status': 'IGNORE'|'RESOLVED'|'PENDING',
'AffectedResource': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'SeverityLevel': 'Low'|'Medium'|'High',
'ResourceGroupName': 'string',
'Feedback': {
'string': 'NOT_SPECIFIED'|'USEFUL'|'NOT_USEFUL'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProblemList (list) --
The list of problems.
(dict) --
Describes a problem that is detected by correlating observations.
Id (string) --
The ID of the problem.
Title (string) --
The name of the problem.
Insights (string) --
A detailed analysis of the problem using machine learning.
Status (string) --
The status of the problem.
AffectedResource (string) --
The resource affected by the problem.
StartTime (datetime) --
The time when the problem started, in epoch seconds.
EndTime (datetime) --
The time when the problem ended, in epoch seconds.
SeverityLevel (string) --
A measure of the level of impact of the problem.
ResourceGroupName (string) --
The name of the resource group affected by the problem.
Feedback (dict) --
Feedback provided by the user about the problem.
(string) --
(string) --
NextToken (string) --
The token used to retrieve the next page of results. This value is null when there are no more results to return.
{'Tier': ['SQL_SERVER',
'DOT_NET_WEB',
'DOT_NET_CORE',
'DOT_NET_WORKER',
'DEFAULT']}
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='DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB'|'SQL_SERVER',
ComponentConfiguration='string'
)
string
[REQUIRED]
The name of the resource group.
string
[REQUIRED]
The name of the component.
boolean
Indicates whether the application component is monitored.
string
The tier of the application component. Supported tiers include DOT_NET_WORKER , DOT_NET_WEB , DOT_NET_CORE , SQL_SERVER , and DEFAULT .
string
The configuration settings of the component. The value is the escaped JSON of the configuration. For more information about the JSON format, see Working with JSON . You can send a request to DescribeComponentConfigurationRecommendation to see the recommended configuration for a component. For the complete format of the component configuration file, see Component Configuration .
dict
Response Syntax
{}
Response Structure
(dict) --