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

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)
) -> CreateApplicationResponseTypeDef:  # (3)
    ...

1. See TagTypeDef
2. See GroupingTypeType
3. See CreateApplicationResponseTypeDef

# create_application method usage example with argument unpacking

kwargs: CreateApplicationRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
}

parent.create_application(**kwargs)

1. See CreateApplicationRequestRequestTypeDef

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)

1. See CreateComponentRequestRequestTypeDef

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)
    ...

1. See CreateLogPatternResponseTypeDef

# create_log_pattern method usage example with argument unpacking

kwargs: CreateLogPatternRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
    "PatternSetName": ...,
    "PatternName": ...,
    "Pattern": ...,
    "Rank": ...,
}

parent.create_log_pattern(**kwargs)

1. See CreateLogPatternRequestRequestTypeDef

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)

1. See DeleteApplicationRequestRequestTypeDef

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)

1. See DeleteComponentRequestRequestTypeDef

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)

1. See DeleteLogPatternRequestRequestTypeDef

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,
) -> DescribeApplicationResponseTypeDef:  # (1)
    ...

1. See DescribeApplicationResponseTypeDef

# describe_application method usage example with argument unpacking

kwargs: DescribeApplicationRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
}

parent.describe_application(**kwargs)

1. See DescribeApplicationRequestRequestTypeDef

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,
) -> DescribeComponentResponseTypeDef:  # (1)
    ...

1. See DescribeComponentResponseTypeDef

# describe_component method usage example with argument unpacking

kwargs: DescribeComponentRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
    "ComponentName": ...,
}

parent.describe_component(**kwargs)

1. See DescribeComponentRequestRequestTypeDef

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,
) -> DescribeComponentConfigurationResponseTypeDef:  # (1)
    ...

1. See DescribeComponentConfigurationResponseTypeDef

# describe_component_configuration method usage example with argument unpacking

kwargs: DescribeComponentConfigurationRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
    "ComponentName": ...,
}

parent.describe_component_configuration(**kwargs)

1. See DescribeComponentConfigurationRequestRequestTypeDef

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)
) -> DescribeComponentConfigurationRecommendationResponseTypeDef:  # (2)
    ...

1. See TierType
2. See DescribeComponentConfigurationRecommendationResponseTypeDef

# describe_component_configuration_recommendation method usage example with argument unpacking

kwargs: DescribeComponentConfigurationRecommendationRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
    "ComponentName": ...,
    "Tier": ...,
}

parent.describe_component_configuration_recommendation(**kwargs)

1. See DescribeComponentConfigurationRecommendationRequestRequestTypeDef

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,
) -> DescribeLogPatternResponseTypeDef:  # (1)
    ...

1. See DescribeLogPatternResponseTypeDef

# describe_log_pattern method usage example with argument unpacking

kwargs: DescribeLogPatternRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
    "PatternSetName": ...,
    "PatternName": ...,
}

parent.describe_log_pattern(**kwargs)

1. See DescribeLogPatternRequestRequestTypeDef

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,
) -> DescribeObservationResponseTypeDef:  # (1)
    ...

1. See DescribeObservationResponseTypeDef

# describe_observation method usage example with argument unpacking

kwargs: DescribeObservationRequestRequestTypeDef = {  # (1)
    "ObservationId": ...,
}

parent.describe_observation(**kwargs)

1. See DescribeObservationRequestRequestTypeDef

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,
) -> DescribeProblemResponseTypeDef:  # (1)
    ...

1. See DescribeProblemResponseTypeDef

# describe_problem method usage example with argument unpacking

kwargs: DescribeProblemRequestRequestTypeDef = {  # (1)
    "ProblemId": ...,
}

parent.describe_problem(**kwargs)

1. See DescribeProblemRequestRequestTypeDef

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

# describe_problem_observations method definition

def describe_problem_observations(
    self,
    *,
    ProblemId: str,
) -> DescribeProblemObservationsResponseTypeDef:  # (1)
    ...

1. See DescribeProblemObservationsResponseTypeDef

# describe_problem_observations method usage example with argument unpacking

kwargs: DescribeProblemObservationsRequestRequestTypeDef = {  # (1)
    "ProblemId": ...,
}

parent.describe_problem_observations(**kwargs)

1. See DescribeProblemObservationsRequestRequestTypeDef

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

# generate_presigned_url method definition

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

# list_applications method definition

def list_applications(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListApplicationsResponseTypeDef:  # (1)
    ...

1. See ListApplicationsResponseTypeDef

# list_applications method usage example with argument unpacking

kwargs: ListApplicationsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_applications(**kwargs)

1. See ListApplicationsRequestRequestTypeDef

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

# list_components method definition

def list_components(
    self,
    *,
    ResourceGroupName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListComponentsResponseTypeDef:  # (1)
    ...

1. See ListComponentsResponseTypeDef

# list_components method usage example with argument unpacking

kwargs: ListComponentsRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
}

parent.list_components(**kwargs)

1. See ListComponentsRequestRequestTypeDef

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

# list_configuration_history method definition

def list_configuration_history(
    self,
    *,
    ResourceGroupName: str = ...,
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    EventStatus: ConfigurationEventStatusType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListConfigurationHistoryResponseTypeDef:  # (2)
    ...

1. See ConfigurationEventStatusType
2. See ListConfigurationHistoryResponseTypeDef

# list_configuration_history method usage example with argument unpacking

kwargs: ListConfigurationHistoryRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
}

parent.list_configuration_history(**kwargs)

1. See ListConfigurationHistoryRequestRequestTypeDef

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

# list_log_pattern_sets method definition

def list_log_pattern_sets(
    self,
    *,
    ResourceGroupName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListLogPatternSetsResponseTypeDef:  # (1)
    ...

1. See ListLogPatternSetsResponseTypeDef

# list_log_pattern_sets method usage example with argument unpacking

kwargs: ListLogPatternSetsRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
}

parent.list_log_pattern_sets(**kwargs)

1. See ListLogPatternSetsRequestRequestTypeDef

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

# list_log_patterns method definition

def list_log_patterns(
    self,
    *,
    ResourceGroupName: str,
    PatternSetName: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListLogPatternsResponseTypeDef:  # (1)
    ...

1. See ListLogPatternsResponseTypeDef

# list_log_patterns method usage example with argument unpacking

kwargs: ListLogPatternsRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
}

parent.list_log_patterns(**kwargs)

1. See ListLogPatternsRequestRequestTypeDef

list_problems

Lists the problems with your application.

Type annotations and code completion for boto3.client("application-insights").list_problems method. boto3 documentation

# list_problems method definition

def list_problems(
    self,
    *,
    ResourceGroupName: str = ...,
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    ComponentName: str = ...,
) -> ListProblemsResponseTypeDef:  # (1)
    ...

1. See ListProblemsResponseTypeDef

# list_problems method usage example with argument unpacking

kwargs: ListProblemsRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
}

parent.list_problems(**kwargs)

1. See ListProblemsRequestRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_application

Updates the application.

Type annotations and code completion for boto3.client("application-insights").update_application method. boto3 documentation

# update_application method definition

def update_application(
    self,
    *,
    ResourceGroupName: str,
    OpsCenterEnabled: bool = ...,
    CWEMonitorEnabled: bool = ...,
    OpsItemSNSTopicArn: str = ...,
    RemoveSNSTopic: bool = ...,
    AutoConfigEnabled: bool = ...,
) -> UpdateApplicationResponseTypeDef:  # (1)
    ...

1. See UpdateApplicationResponseTypeDef

# update_application method usage example with argument unpacking

kwargs: UpdateApplicationRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
}

parent.update_application(**kwargs)

1. See UpdateApplicationRequestRequestTypeDef

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

# update_component method definition

def update_component(
    self,
    *,
    ResourceGroupName: str,
    ComponentName: str,
    NewComponentName: str = ...,
    ResourceList: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...

# update_component method usage example with argument unpacking

kwargs: UpdateComponentRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
    "ComponentName": ...,
}

parent.update_component(**kwargs)

1. See UpdateComponentRequestRequestTypeDef

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

# update_component_configuration method definition

def update_component_configuration(
    self,
    *,
    ResourceGroupName: str,
    ComponentName: str,
    Monitor: bool = ...,
    Tier: TierType = ...,  # (1)
    ComponentConfiguration: str = ...,
    AutoConfigEnabled: bool = ...,
) -> Dict[str, Any]:
    ...

1. See TierType

# update_component_configuration method usage example with argument unpacking

kwargs: UpdateComponentConfigurationRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
    "ComponentName": ...,
}

parent.update_component_configuration(**kwargs)

1. See UpdateComponentConfigurationRequestRequestTypeDef

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

# update_log_pattern method definition

def update_log_pattern(
    self,
    *,
    ResourceGroupName: str,
    PatternSetName: str,
    PatternName: str,
    Pattern: str = ...,
    Rank: int = ...,
) -> UpdateLogPatternResponseTypeDef:  # (1)
    ...

1. See UpdateLogPatternResponseTypeDef

# update_log_pattern method usage example with argument unpacking

kwargs: UpdateLogPatternRequestRequestTypeDef = {  # (1)
    "ResourceGroupName": ...,
    "PatternSetName": ...,
    "PatternName": ...,
}

parent.update_log_pattern(**kwargs)

1. See UpdateLogPatternRequestRequestTypeDef