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

# CloudWatchInternetMonitorClient 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.

# 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 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

# 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("internetmonitor").close method. boto3 documentation

# close 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

# 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

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

# generate_presigned_url method definition

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

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: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    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: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    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)