CloudWatchInternetMonitorClient

Index > CloudWatchInternetMonitor > CloudWatchInternetMonitorClient

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

CloudWatchInternetMonitorClient

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

CloudWatchInternetMonitorClient usage example

from aiobotocore.session import get_session
from types_aiobotocore_internetmonitor.client import CloudWatchInternetMonitorClient

session = get_session()
async with session.create_client("internetmonitor") as client:
    client: CloudWatchInternetMonitorClient

Exceptions

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

CloudWatchInternetMonitorClient.exceptions usage example

async with session.create_client("internetmonitor") as client:
    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)

CloudWatchInternetMonitorClient usage type checking example

from types_aiobotocore_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 session.create_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 session.create_client("internetmonitor").close method. boto3 documentation

# close method definition

await def close(
    self,
) -> None:
    ...

create_monitor

Creates a monitor in Amazon CloudWatch Internet Monitor.

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

# create_monitor method definition

await 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 session.create_client("internetmonitor").delete_monitor method. boto3 documentation

# delete_monitor method definition

await 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 session.create_client("internetmonitor").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

await 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 session.create_client("internetmonitor").get_health_event method. boto3 documentation

# get_health_event method definition

await def get_health_event(
    self,
    *,
    MonitorName: str,
    EventId: 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_monitor

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

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

# get_monitor method definition

await def get_monitor(
    self,
    *,
    MonitorName: 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

list_health_events

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

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

# list_health_events method definition

await 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

# list_health_events method usage example with argument unpacking

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 session.create_client("internetmonitor").list_monitors method. boto3 documentation

# list_monitors method definition

await def list_monitors(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    MonitorStatus: str = ...,
) -> 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 session.create_client("internetmonitor").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

await 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

tag_resource

Adds a tag to a resource.

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

# tag_resource method definition

await 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 session.create_client("internetmonitor").untag_resource method. boto3 documentation

# untag_resource method definition

await 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 session.create_client("internetmonitor").update_monitor method. boto3 documentation

# update_monitor method definition

await 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

__aenter__

Type annotations and code completion for session.create_client("internetmonitor").__aenter__ method. boto3 documentation

# __aenter__ method definition

await def __aenter__(
    self,
) -> CloudWatchInternetMonitorClient:
    ...

__aexit__

Type annotations and code completion for session.create_client("internetmonitor").__aexit__ method. boto3 documentation

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

Type annotations and code completion for session.create_client("internetmonitor").get_paginator method with overloads.

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