ApplicationInsightsClient
Index > ApplicationInsights > ApplicationInsightsClient
Auto-generated documentation for ApplicationInsights type annotations stubs module mypy-boto3-application-insights.
ApplicationInsightsClient
Type annotations and code completion for boto3.client("application-insights")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_application_insights.client import ApplicationInsightsClient
def get_application-insights_client() -> ApplicationInsightsClient:
return Session().client("application-insights")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("application-insights").exceptions
structure.
client = boto3.client("application-insights")
try:
do_something(client)
except (
client.AccessDeniedException,
client.BadRequestException,
client.ClientError,
client.InternalServerException,
client.ResourceInUseException,
client.ResourceNotFoundException,
client.TagsAlreadyExistException,
client.TooManyTagsException,
client.ValidationException,
) as e:
print(e)
from mypy_boto3_application_insights.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("application-insights").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("application-insights").close
method.
boto3 documentation
create_application
Adds an application that is created from a resource group.
Type annotations and code completion for boto3.client("application-insights").create_application
method.
boto3 documentation
def create_application(
self,
*,
ResourceGroupName: str = ...,
OpsCenterEnabled: bool = ...,
CWEMonitorEnabled: bool = ...,
OpsItemSNSTopicArn: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
AutoConfigEnabled: bool = ...,
AutoCreate: bool = ...,
GroupingType: GroupingTypeType = ..., # (2)
) -> CreateApplicationResponseTypeDef: # (3)
...
kwargs: CreateApplicationRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
}
parent.create_application(**kwargs)
create_component
Creates a custom component by grouping similar standalone instances to monitor.
Type annotations and code completion for boto3.client("application-insights").create_component
method.
boto3 documentation
def create_component(
self,
*,
ResourceGroupName: str,
ComponentName: str,
ResourceList: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: CreateComponentRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
"ComponentName": ...,
"ResourceList": ...,
}
parent.create_component(**kwargs)
create_log_pattern
Adds an log pattern to a LogPatternSet
.
Type annotations and code completion for boto3.client("application-insights").create_log_pattern
method.
boto3 documentation
def create_log_pattern(
self,
*,
ResourceGroupName: str,
PatternSetName: str,
PatternName: str,
Pattern: str,
Rank: int,
) -> CreateLogPatternResponseTypeDef: # (1)
...
kwargs: CreateLogPatternRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
"PatternSetName": ...,
"PatternName": ...,
"Pattern": ...,
"Rank": ...,
}
parent.create_log_pattern(**kwargs)
delete_application
Removes the specified application from monitoring.
Type annotations and code completion for boto3.client("application-insights").delete_application
method.
boto3 documentation
kwargs: DeleteApplicationRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
}
parent.delete_application(**kwargs)
delete_component
Ungroups a custom component.
Type annotations and code completion for boto3.client("application-insights").delete_component
method.
boto3 documentation
def delete_component(
self,
*,
ResourceGroupName: str,
ComponentName: str,
) -> Dict[str, Any]:
...
kwargs: DeleteComponentRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
"ComponentName": ...,
}
parent.delete_component(**kwargs)
delete_log_pattern
Removes the specified log pattern from a LogPatternSet
.
Type annotations and code completion for boto3.client("application-insights").delete_log_pattern
method.
boto3 documentation
def delete_log_pattern(
self,
*,
ResourceGroupName: str,
PatternSetName: str,
PatternName: str,
) -> Dict[str, Any]:
...
kwargs: DeleteLogPatternRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
"PatternSetName": ...,
"PatternName": ...,
}
parent.delete_log_pattern(**kwargs)
describe_application
Describes the application.
Type annotations and code completion for boto3.client("application-insights").describe_application
method.
boto3 documentation
def describe_application(
self,
*,
ResourceGroupName: str,
) -> DescribeApplicationResponseTypeDef: # (1)
...
kwargs: DescribeApplicationRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
}
parent.describe_application(**kwargs)
describe_component
Describes a component and lists the resources that are grouped together in a component.
Type annotations and code completion for boto3.client("application-insights").describe_component
method.
boto3 documentation
def describe_component(
self,
*,
ResourceGroupName: str,
ComponentName: str,
) -> DescribeComponentResponseTypeDef: # (1)
...
kwargs: DescribeComponentRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
"ComponentName": ...,
}
parent.describe_component(**kwargs)
describe_component_configuration
Describes the monitoring configuration of the component.
Type annotations and code completion for boto3.client("application-insights").describe_component_configuration
method.
boto3 documentation
def describe_component_configuration(
self,
*,
ResourceGroupName: str,
ComponentName: str,
) -> DescribeComponentConfigurationResponseTypeDef: # (1)
...
kwargs: DescribeComponentConfigurationRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
"ComponentName": ...,
}
parent.describe_component_configuration(**kwargs)
describe_component_configuration_recommendation
Describes the recommended monitoring configuration of the component.
Type annotations and code completion for boto3.client("application-insights").describe_component_configuration_recommendation
method.
boto3 documentation
def describe_component_configuration_recommendation(
self,
*,
ResourceGroupName: str,
ComponentName: str,
Tier: TierType, # (1)
) -> DescribeComponentConfigurationRecommendationResponseTypeDef: # (2)
...
kwargs: DescribeComponentConfigurationRecommendationRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
"ComponentName": ...,
"Tier": ...,
}
parent.describe_component_configuration_recommendation(**kwargs)
describe_log_pattern
Describe a specific log pattern from a LogPatternSet
.
Type annotations and code completion for boto3.client("application-insights").describe_log_pattern
method.
boto3 documentation
def describe_log_pattern(
self,
*,
ResourceGroupName: str,
PatternSetName: str,
PatternName: str,
) -> DescribeLogPatternResponseTypeDef: # (1)
...
kwargs: DescribeLogPatternRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
"PatternSetName": ...,
"PatternName": ...,
}
parent.describe_log_pattern(**kwargs)
describe_observation
Describes an anomaly or error with the application.
Type annotations and code completion for boto3.client("application-insights").describe_observation
method.
boto3 documentation
def describe_observation(
self,
*,
ObservationId: str,
) -> DescribeObservationResponseTypeDef: # (1)
...
kwargs: DescribeObservationRequestRequestTypeDef = { # (1)
"ObservationId": ...,
}
parent.describe_observation(**kwargs)
describe_problem
Describes an application problem.
Type annotations and code completion for boto3.client("application-insights").describe_problem
method.
boto3 documentation
def describe_problem(
self,
*,
ProblemId: str,
) -> DescribeProblemResponseTypeDef: # (1)
...
kwargs: DescribeProblemRequestRequestTypeDef = { # (1)
"ProblemId": ...,
}
parent.describe_problem(**kwargs)
describe_problem_observations
Describes the anomalies or errors associated with the problem.
Type annotations and code completion for boto3.client("application-insights").describe_problem_observations
method.
boto3 documentation
def describe_problem_observations(
self,
*,
ProblemId: str,
) -> DescribeProblemObservationsResponseTypeDef: # (1)
...
kwargs: DescribeProblemObservationsRequestRequestTypeDef = { # (1)
"ProblemId": ...,
}
parent.describe_problem_observations(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("application-insights").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
list_applications
Lists the IDs of the applications that you are monitoring.
Type annotations and code completion for boto3.client("application-insights").list_applications
method.
boto3 documentation
def list_applications(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListApplicationsResponseTypeDef: # (1)
...
kwargs: ListApplicationsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_applications(**kwargs)
list_components
Lists the auto-grouped, standalone, and custom components of the application.
Type annotations and code completion for boto3.client("application-insights").list_components
method.
boto3 documentation
def list_components(
self,
*,
ResourceGroupName: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListComponentsResponseTypeDef: # (1)
...
kwargs: ListComponentsRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
}
parent.list_components(**kwargs)
list_configuration_history
Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights.
Type annotations and code completion for boto3.client("application-insights").list_configuration_history
method.
boto3 documentation
def list_configuration_history(
self,
*,
ResourceGroupName: str = ...,
StartTime: Union[datetime, str] = ...,
EndTime: Union[datetime, str] = ...,
EventStatus: ConfigurationEventStatusType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListConfigurationHistoryResponseTypeDef: # (2)
...
kwargs: ListConfigurationHistoryRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
}
parent.list_configuration_history(**kwargs)
list_log_pattern_sets
Lists the log pattern sets in the specific application.
Type annotations and code completion for boto3.client("application-insights").list_log_pattern_sets
method.
boto3 documentation
def list_log_pattern_sets(
self,
*,
ResourceGroupName: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListLogPatternSetsResponseTypeDef: # (1)
...
kwargs: ListLogPatternSetsRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
}
parent.list_log_pattern_sets(**kwargs)
list_log_patterns
Lists the log patterns in the specific log LogPatternSet
.
Type annotations and code completion for boto3.client("application-insights").list_log_patterns
method.
boto3 documentation
def list_log_patterns(
self,
*,
ResourceGroupName: str,
PatternSetName: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListLogPatternsResponseTypeDef: # (1)
...
kwargs: ListLogPatternsRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
}
parent.list_log_patterns(**kwargs)
list_problems
Lists the problems with your application.
Type annotations and code completion for boto3.client("application-insights").list_problems
method.
boto3 documentation
def list_problems(
self,
*,
ResourceGroupName: str = ...,
StartTime: Union[datetime, str] = ...,
EndTime: Union[datetime, str] = ...,
MaxResults: int = ...,
NextToken: str = ...,
ComponentName: str = ...,
) -> ListProblemsResponseTypeDef: # (1)
...
kwargs: ListProblemsRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
}
parent.list_problems(**kwargs)
list_tags_for_resource
Retrieve a list of the tags (keys and values) that are associated with a specified application.
Type annotations and code completion for boto3.client("application-insights").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
tag_resource
Add one or more tags (keys and values) to a specified application.
Type annotations and code completion for boto3.client("application-insights").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Remove one or more tags (keys and values) from a specified application.
Type annotations and code completion for boto3.client("application-insights").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_application
Updates the application.
Type annotations and code completion for boto3.client("application-insights").update_application
method.
boto3 documentation
def update_application(
self,
*,
ResourceGroupName: str,
OpsCenterEnabled: bool = ...,
CWEMonitorEnabled: bool = ...,
OpsItemSNSTopicArn: str = ...,
RemoveSNSTopic: bool = ...,
AutoConfigEnabled: bool = ...,
) -> UpdateApplicationResponseTypeDef: # (1)
...
kwargs: UpdateApplicationRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
}
parent.update_application(**kwargs)
update_component
Updates the custom component name and/or the list of resources that make up the component.
Type annotations and code completion for boto3.client("application-insights").update_component
method.
boto3 documentation
def update_component(
self,
*,
ResourceGroupName: str,
ComponentName: str,
NewComponentName: str = ...,
ResourceList: Sequence[str] = ...,
) -> Dict[str, Any]:
...
kwargs: UpdateComponentRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
"ComponentName": ...,
}
parent.update_component(**kwargs)
update_component_configuration
Updates the monitoring configurations for the component.
Type annotations and code completion for boto3.client("application-insights").update_component_configuration
method.
boto3 documentation
def update_component_configuration(
self,
*,
ResourceGroupName: str,
ComponentName: str,
Monitor: bool = ...,
Tier: TierType = ..., # (1)
ComponentConfiguration: str = ...,
AutoConfigEnabled: bool = ...,
) -> Dict[str, Any]:
...
- See TierType
kwargs: UpdateComponentConfigurationRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
"ComponentName": ...,
}
parent.update_component_configuration(**kwargs)
update_log_pattern
Adds a log pattern to a LogPatternSet
.
Type annotations and code completion for boto3.client("application-insights").update_log_pattern
method.
boto3 documentation
def update_log_pattern(
self,
*,
ResourceGroupName: str,
PatternSetName: str,
PatternName: str,
Pattern: str = ...,
Rank: int = ...,
) -> UpdateLogPatternResponseTypeDef: # (1)
...