CloudWatchInternetMonitorClient

Index > CloudWatchInternetMonitor > CloudWatchInternetMonitorClient

Auto-generated documentation for CloudWatchInternetMonitor type annotations stubs module types-boto3-internetmonitor.

CloudWatchInternetMonitorClient

Type annotations and code completion for boto3.client("internetmonitor"). boto3 documentation

# CloudWatchInternetMonitorClient usage example

from boto3.session import Session
from types_boto3_internetmonitor.client import CloudWatchInternetMonitorClient

def get_internetmonitor_client() -> CloudWatchInternetMonitorClient:
    return Session().client("internetmonitor")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("internetmonitor").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("internetmonitor")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerErrorException,
    client.exceptions.InternalServerException,
    client.exceptions.LimitExceededException,
    client.exceptions.NotFoundException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.TooManyRequestsException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_internetmonitor.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("internetmonitor").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("internetmonitor").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:
    ...

create_monitor

Creates a monitor in Amazon CloudWatch Internet Monitor.

Type annotations and code completion for boto3.client("internetmonitor").create_monitor method. boto3 documentation

# create_monitor method definition

def create_monitor(
    self,
    *,
    MonitorName: str,
    Resources: Sequence[str] = ...,
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
    MaxCityNetworksToMonitor: int = ...,
    InternetMeasurementsLogDelivery: InternetMeasurementsLogDeliveryTypeDef = ...,  # (1)
    TrafficPercentageToMonitor: int = ...,
    HealthEventsConfig: HealthEventsConfigTypeDef = ...,  # (2)
) -> CreateMonitorOutputTypeDef:  # (3)
    ...

1. See InternetMeasurementsLogDeliveryTypeDef
2. See HealthEventsConfigTypeDef
3. See CreateMonitorOutputTypeDef

# create_monitor method usage example with argument unpacking

kwargs: CreateMonitorInputRequestTypeDef = {  # (1)
    "MonitorName": ...,
}

parent.create_monitor(**kwargs)

1. See CreateMonitorInputRequestTypeDef

delete_monitor

Deletes a monitor in Amazon CloudWatch Internet Monitor.

Type annotations and code completion for boto3.client("internetmonitor").delete_monitor method. boto3 documentation

# delete_monitor method definition

def delete_monitor(
    self,
    *,
    MonitorName: str,
) -> dict[str, Any]:
    ...

# delete_monitor method usage example with argument unpacking

kwargs: DeleteMonitorInputRequestTypeDef = {  # (1)
    "MonitorName": ...,
}

parent.delete_monitor(**kwargs)

1. See DeleteMonitorInputRequestTypeDef

get_health_event

Gets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor.

Type annotations and code completion for boto3.client("internetmonitor").get_health_event method. boto3 documentation

# get_health_event method definition

def get_health_event(
    self,
    *,
    MonitorName: str,
    EventId: str,
    LinkedAccountId: str = ...,
) -> GetHealthEventOutputTypeDef:  # (1)
    ...

1. See GetHealthEventOutputTypeDef

# get_health_event method usage example with argument unpacking

kwargs: GetHealthEventInputRequestTypeDef = {  # (1)
    "MonitorName": ...,
    "EventId": ...,
}

parent.get_health_event(**kwargs)

1. See GetHealthEventInputRequestTypeDef

get_internet_event

Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event.

Type annotations and code completion for boto3.client("internetmonitor").get_internet_event method. boto3 documentation

# get_internet_event method definition

def get_internet_event(
    self,
    *,
    EventId: str,
) -> GetInternetEventOutputTypeDef:  # (1)
    ...

1. See GetInternetEventOutputTypeDef

# get_internet_event method usage example with argument unpacking

kwargs: GetInternetEventInputRequestTypeDef = {  # (1)
    "EventId": ...,
}

parent.get_internet_event(**kwargs)

1. See GetInternetEventInputRequestTypeDef

get_monitor

Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name.

Type annotations and code completion for boto3.client("internetmonitor").get_monitor method. boto3 documentation

# get_monitor method definition

def get_monitor(
    self,
    *,
    MonitorName: str,
    LinkedAccountId: str = ...,
) -> GetMonitorOutputTypeDef:  # (1)
    ...

1. See GetMonitorOutputTypeDef

# get_monitor method usage example with argument unpacking

kwargs: GetMonitorInputRequestTypeDef = {  # (1)
    "MonitorName": ...,
}

parent.get_monitor(**kwargs)

1. See GetMonitorInputRequestTypeDef

get_query_results

Return the data for a query with the Amazon CloudWatch Internet Monitor query interface.

Type annotations and code completion for boto3.client("internetmonitor").get_query_results method. boto3 documentation

# get_query_results method definition

def get_query_results(
    self,
    *,
    MonitorName: str,
    QueryId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetQueryResultsOutputTypeDef:  # (1)
    ...

1. See GetQueryResultsOutputTypeDef

# get_query_results method usage example with argument unpacking

kwargs: GetQueryResultsInputRequestTypeDef = {  # (1)
    "MonitorName": ...,
    "QueryId": ...,
}

parent.get_query_results(**kwargs)

1. See GetQueryResultsInputRequestTypeDef

get_query_status

Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor.

Type annotations and code completion for boto3.client("internetmonitor").get_query_status method. boto3 documentation

# get_query_status method definition

def get_query_status(
    self,
    *,
    MonitorName: str,
    QueryId: str,
) -> GetQueryStatusOutputTypeDef:  # (1)
    ...

1. See GetQueryStatusOutputTypeDef

# get_query_status method usage example with argument unpacking

kwargs: GetQueryStatusInputRequestTypeDef = {  # (1)
    "MonitorName": ...,
    "QueryId": ...,
}

parent.get_query_status(**kwargs)

1. See GetQueryStatusInputRequestTypeDef

list_health_events

Lists all health events for a monitor in Amazon CloudWatch Internet Monitor.

Type annotations and code completion for boto3.client("internetmonitor").list_health_events method. boto3 documentation

# list_health_events method definition

def list_health_events(
    self,
    *,
    MonitorName: str,
    StartTime: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    EventStatus: HealthEventStatusType = ...,  # (1)
    LinkedAccountId: str = ...,
) -> ListHealthEventsOutputTypeDef:  # (2)
    ...

1. See HealthEventStatusType
2. See ListHealthEventsOutputTypeDef

# list_health_events method usage example with argument unpacking

kwargs: ListHealthEventsInputRequestTypeDef = {  # (1)
    "MonitorName": ...,
}

parent.list_health_events(**kwargs)

1. See ListHealthEventsInputRequestTypeDef

list_internet_events

Lists internet events that cause performance or availability issues for client locations.

Type annotations and code completion for boto3.client("internetmonitor").list_internet_events method. boto3 documentation

# list_internet_events method definition

def list_internet_events(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    StartTime: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    EventStatus: str = ...,
    EventType: str = ...,
) -> ListInternetEventsOutputTypeDef:  # (1)
    ...

1. See ListInternetEventsOutputTypeDef

# list_internet_events method usage example with argument unpacking

kwargs: ListInternetEventsInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_internet_events(**kwargs)

1. See ListInternetEventsInputRequestTypeDef

list_monitors

Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.

Type annotations and code completion for boto3.client("internetmonitor").list_monitors method. boto3 documentation

# list_monitors method definition

def list_monitors(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    MonitorStatus: str = ...,
    IncludeLinkedAccounts: bool = ...,
) -> ListMonitorsOutputTypeDef:  # (1)
    ...

1. See ListMonitorsOutputTypeDef

# list_monitors method usage example with argument unpacking

kwargs: ListMonitorsInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_monitors(**kwargs)

1. See ListMonitorsInputRequestTypeDef

list_tags_for_resource

Lists the tags for a resource.

Type annotations and code completion for boto3.client("internetmonitor").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...

1. See ListTagsForResourceOutputTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputRequestTypeDef

start_query

Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface.

Type annotations and code completion for boto3.client("internetmonitor").start_query method. boto3 documentation

# start_query method definition

def start_query(
    self,
    *,
    MonitorName: str,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    QueryType: QueryTypeType,  # (1)
    FilterParameters: Sequence[FilterParameterTypeDef] = ...,  # (2)
    LinkedAccountId: str = ...,
) -> StartQueryOutputTypeDef:  # (3)
    ...

1. See QueryTypeType
2. See FilterParameterTypeDef
3. See StartQueryOutputTypeDef

# start_query method usage example with argument unpacking

kwargs: StartQueryInputRequestTypeDef = {  # (1)
    "MonitorName": ...,
    "StartTime": ...,
    "EndTime": ...,
    "QueryType": ...,
}

parent.start_query(**kwargs)

1. See StartQueryInputRequestTypeDef

stop_query

Stop a query that is progress for a specific monitor.

Type annotations and code completion for boto3.client("internetmonitor").stop_query method. boto3 documentation

# stop_query method definition

def stop_query(
    self,
    *,
    MonitorName: str,
    QueryId: str,
) -> dict[str, Any]:
    ...

# stop_query method usage example with argument unpacking

kwargs: StopQueryInputRequestTypeDef = {  # (1)
    "MonitorName": ...,
    "QueryId": ...,
}

parent.stop_query(**kwargs)

1. See StopQueryInputRequestTypeDef

tag_resource

Adds a tag to a resource.

Type annotations and code completion for boto3.client("internetmonitor").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceInputRequestTypeDef

untag_resource

Removes a tag from a resource.

Type annotations and code completion for boto3.client("internetmonitor").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: UntagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceInputRequestTypeDef

update_monitor

Updates a monitor.

Type annotations and code completion for boto3.client("internetmonitor").update_monitor method. boto3 documentation

# update_monitor method definition

def update_monitor(
    self,
    *,
    MonitorName: str,
    ResourcesToAdd: Sequence[str] = ...,
    ResourcesToRemove: Sequence[str] = ...,
    Status: MonitorConfigStateType = ...,  # (1)
    ClientToken: str = ...,
    MaxCityNetworksToMonitor: int = ...,
    InternetMeasurementsLogDelivery: InternetMeasurementsLogDeliveryTypeDef = ...,  # (2)
    TrafficPercentageToMonitor: int = ...,
    HealthEventsConfig: HealthEventsConfigTypeDef = ...,  # (3)
) -> UpdateMonitorOutputTypeDef:  # (4)
    ...

1. See MonitorConfigStateType
2. See InternetMeasurementsLogDeliveryTypeDef
3. See HealthEventsConfigTypeDef
4. See UpdateMonitorOutputTypeDef

# update_monitor method usage example with argument unpacking

kwargs: UpdateMonitorInputRequestTypeDef = {  # (1)
    "MonitorName": ...,
}

parent.update_monitor(**kwargs)

1. See UpdateMonitorInputRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("internetmonitor").get_paginator method with overloads.

• client.get_paginator("list_health_events") -> ListHealthEventsPaginator
• client.get_paginator("list_internet_events") -> ListInternetEventsPaginator
• client.get_paginator("list_monitors") -> ListMonitorsPaginator