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
# ApplicationInsightsClient usage example
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.
# Exceptions.exceptions usage example
client = boto3.client("application-insights")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.BadRequestException,
client.exceptions.ClientError,
client.exceptions.InternalServerException,
client.exceptions.ResourceInUseException,
client.exceptions.ResourceNotFoundException,
client.exceptions.TagsAlreadyExistException,
client.exceptions.TooManyTagsException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_application_insights.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
add_workload#
Adds a workload to a component.
Type annotations and code completion for boto3.client("application-insights").add_workload
method.
boto3 documentation
# add_workload method definition
def add_workload(
self,
*,
ResourceGroupName: str,
ComponentName: str,
WorkloadConfiguration: WorkloadConfigurationTypeDef, # (1)
) -> AddWorkloadResponseTypeDef: # (2)
...
# add_workload method usage example with argument unpacking
kwargs: AddWorkloadRequestRequestTypeDef = { # (1)
"ResourceGroupName": ...,
"ComponentName": ...,
"WorkloadConfiguration": ...,
}
parent.add_workload(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("application-insights").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("application-insights").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
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
# create_application method definition
def create_application(
self,
*,
ResourceGroupName: str = ...,
OpsCenterEnabled: bool = ...,
CWEMonitorEnabled: bool = ...,
OpsItemSNSTopicArn: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
AutoConfigEnabled: bool = ...,
AutoCreate: bool = ...,
GroupingType: GroupingTypeType = ..., # (2)
AttachMissingPermission: bool = ...,
) -> CreateApplicationResponseTypeDef: # (3)
...
# create_application method usage example with argument unpacking
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
# create_component method definition
def create_component(
self,
*,
ResourceGroupName: str,
ComponentName: str,
ResourceList: Sequence[str],
) -> Dict[str, Any]:
...
# create_component method usage example with argument unpacking
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
# create_log_pattern method definition
def create_log_pattern(
self,
*,
ResourceGroupName: str,
PatternSetName: str,
PatternName: str,
Pattern: str,
Rank: int,
) -> CreateLogPatternResponseTypeDef: # (1)
...
# create_log_pattern method usage example with argument unpacking
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
# delete_application method definition
def delete_application(
self,
*,
ResourceGroupName: str,
) -> Dict[str, Any]:
...
# delete_application method usage example with argument unpacking
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
# delete_component method definition
def delete_component(
self,
*,
ResourceGroupName: str,
ComponentName: str,
) -> Dict[str, Any]:
...
# delete_component method usage example with argument unpacking
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
# delete_log_pattern method definition
def delete_log_pattern(
self,
*,
ResourceGroupName: str,
PatternSetName: str,
PatternName: str,
) -> Dict[str, Any]:
...
# delete_log_pattern method usage example with argument unpacking
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
# describe_application method definition
def describe_application(
self,
*,
ResourceGroupName: str,
AccountId: str = ...,
) -> DescribeApplicationResponseTypeDef: # (1)
...
# describe_application method usage example with argument unpacking
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
# describe_component method definition
def describe_component(
self,
*,
ResourceGroupName: str,
ComponentName: str,
AccountId: str = ...,
) -> DescribeComponentResponseTypeDef: # (1)
...
# describe_component method usage example with argument unpacking
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
# describe_component_configuration method definition
def describe_component_configuration(
self,
*,
ResourceGroupName: str,
ComponentName: str,
AccountId: str = ...,
) -> DescribeComponentConfigurationResponseTypeDef: # (1)
...
# describe_component_configuration method usage example with argument unpacking
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
# describe_component_configuration_recommendation method definition
def describe_component_configuration_recommendation(
self,
*,
ResourceGroupName: str,
ComponentName: str,
Tier: TierType, # (1)
WorkloadName: str = ...,
RecommendationType: RecommendationTypeType = ..., # (2)
) -> DescribeComponentConfigurationRecommendationResponseTypeDef: # (3)
...
- See TierType
- See RecommendationTypeType
- See DescribeComponentConfigurationRecommendationResponseTypeDef
# describe_component_configuration_recommendation method usage example with argument unpacking
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
# describe_log_pattern method definition
def describe_log_pattern(
self,
*,
ResourceGroupName: str,
PatternSetName: str,
PatternName: str,
AccountId: str = ...,
) -> DescribeLogPatternResponseTypeDef: # (1)
...
# describe_log_pattern method usage example with argument unpacking
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
# describe_observation method definition
def describe_observation(
self,
*,
ObservationId: str,
AccountId: str = ...,
) -> DescribeObservationResponseTypeDef: # (1)
...
# describe_observation method usage example with argument unpacking
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
# describe_problem method definition
def describe_problem(
self,
*,
ProblemId: str,
AccountId: str = ...,
) -> DescribeProblemResponseTypeDef: # (1)
...
# describe_problem method usage example with argument unpacking
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.