Skip to content

CloudWatchInternetMonitorClient

Index > CloudWatchInternetMonitor > CloudWatchInternetMonitorClient

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

CloudWatchInternetMonitorClient

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

Usage example
from boto3.session import Session
from mypy_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.

Usage example
client = boto3.client("internetmonitor")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.BadRequestException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerErrorException,
    client.InternalServerException,
    client.LimitExceededException,
    client.NotFoundException,
    client.ResourceNotFoundException,
    client.ThrottlingException,
    client.TooManyRequestsException,
    client.ValidationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_internetmonitor.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("internetmonitor").can_paginate method. boto3 documentation

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

close

Closes underlying endpoint connections.

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

Method definition
def close(
    self,
) -> None:
    ...

create_monitor

Creates a monitor in Amazon CloudWatch Internet Monitor.

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

Method definition
def create_monitor(
    self,
    *,
    MonitorName: str,
    MaxCityNetworksToMonitor: int,
    Resources: Sequence[str] = ...,
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateMonitorOutputTypeDef:  # (1)
    ...
  1. See CreateMonitorOutputTypeDef
Usage example with kwargs
kwargs: CreateMonitorInputRequestTypeDef = {  # (1)
    "MonitorName": ...,
    "MaxCityNetworksToMonitor": ...,
}

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

Method definition
def delete_monitor(
    self,
    *,
    MonitorName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteMonitorInputRequestTypeDef = {  # (1)
    "MonitorName": ...,
}

parent.delete_monitor(**kwargs)
  1. See DeleteMonitorInputRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_health_event

Gets information the 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

Method definition
def get_health_event(
    self,
    *,
    MonitorName: str,
    EventId: str,
) -> GetHealthEventOutputTypeDef:  # (1)
    ...
  1. See GetHealthEventOutputTypeDef
Usage example with kwargs
kwargs: GetHealthEventInputRequestTypeDef = {  # (1)
    "MonitorName": ...,
    "EventId": ...,
}

parent.get_health_event(**kwargs)
  1. See GetHealthEventInputRequestTypeDef

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

Method definition
def get_monitor(
    self,
    *,
    MonitorName: str,
) -> GetMonitorOutputTypeDef:  # (1)
    ...
  1. See GetMonitorOutputTypeDef
Usage example with kwargs
kwargs: GetMonitorInputRequestTypeDef = {  # (1)
    "MonitorName": ...,
}

parent.get_monitor(**kwargs)
  1. See GetMonitorInputRequestTypeDef

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

Method definition
def list_health_events(
    self,
    *,
    MonitorName: str,
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    EventStatus: HealthEventStatusType = ...,  # (1)
) -> ListHealthEventsOutputTypeDef:  # (2)
    ...
  1. See HealthEventStatusType
  2. See ListHealthEventsOutputTypeDef
Usage example with kwargs
kwargs: ListHealthEventsInputRequestTypeDef = {  # (1)
    "MonitorName": ...,
}

parent.list_health_events(**kwargs)
  1. See ListHealthEventsInputRequestTypeDef

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

Method definition
def list_monitors(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    MonitorStatus: str = ...,
) -> ListMonitorsOutputTypeDef:  # (1)
    ...
  1. See ListMonitorsOutputTypeDef
Usage example with kwargs
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

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceInputRequestTypeDef

tag_resource

Adds a tag to a resource.

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

Method definition
def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def update_monitor(
    self,
    *,
    MonitorName: str,
    ResourcesToAdd: Sequence[str] = ...,
    ResourcesToRemove: Sequence[str] = ...,
    Status: MonitorConfigStateType = ...,  # (1)
    ClientToken: str = ...,
    MaxCityNetworksToMonitor: int = ...,
) -> UpdateMonitorOutputTypeDef:  # (2)
    ...
  1. See MonitorConfigStateType
  2. See UpdateMonitorOutputTypeDef
Usage example with kwargs
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.