CloudWatchInternetMonitorClient#
Index > CloudWatchInternetMonitor > CloudWatchInternetMonitorClient
Auto-generated documentation for CloudWatchInternetMonitor type annotations stubs module types-aiobotocore-internetmonitor.
CloudWatchInternetMonitorClient#
Type annotations and code completion for session.client("internetmonitor")
boto3 documentation
# CloudWatchInternetMonitorClient usage example
from aioboto3.session import Session
from types_aiobotocore_internetmonitor.client import CloudWatchInternetMonitorClient
session = Session()
async with session.client("internetmonitor") as client:
client: CloudWatchInternetMonitorClient
Exceptions#
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("internetmonitor").exceptions
structure.
# CloudWatchInternetMonitorClient.exceptions usage example
async with session.client("internetmonitor") as client:
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)
# CloudWatchInternetMonitorClient.exceptions 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.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.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.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)
...
- See InternetMeasurementsLogDeliveryTypeDef
- See HealthEventsConfigTypeDef
- See CreateMonitorOutputTypeDef
# create_monitor method usage example with argument unpacking
kwargs: CreateMonitorInputRequestTypeDef = { # (1)
"MonitorName": ...,
}
parent.create_monitor(**kwargs)
delete_monitor#
Deletes a monitor in Amazon CloudWatch Internet Monitor.
Type annotations and code completion for session.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)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.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.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)
...
# get_health_event method usage example with argument unpacking
kwargs: GetHealthEventInputRequestTypeDef = { # (1)
"MonitorName": ...,
"EventId": ...,
}
parent.get_health_event(**kwargs)
get_monitor#
Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name.
Type annotations and code completion for session.client("internetmonitor").get_monitor
method.
boto3 documentation
# get_monitor method definition
await def get_monitor(
self,
*,
MonitorName: str,
) -> GetMonitorOutputTypeDef: # (1)
...
# get_monitor method usage example with argument unpacking
kwargs: GetMonitorInputRequestTypeDef = { # (1)
"MonitorName": ...,
}
parent.get_monitor(**kwargs)
get_query_results#
Return the data for a query with the Amazon CloudWatch Internet Monitor query interface.
Type annotations and code completion for session.client("internetmonitor").get_query_results
method.
boto3 documentation
# get_query_results method definition
await def get_query_results(
self,
*,
MonitorName: str,
QueryId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> GetQueryResultsOutputTypeDef: # (1)
...
# get_query_results method usage example with argument unpacking
kwargs: GetQueryResultsInputRequestTypeDef = { # (1)
"MonitorName": ...,
"QueryId": ...,
}
parent.get_query_results(**kwargs)
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 session.client("internetmonitor").get_query_status
method.
boto3 documentation
# get_query_status method definition
await def get_query_status(
self,
*,
MonitorName: str,
QueryId: str,
) -> GetQueryStatusOutputTypeDef: # (1)
...
# get_query_status method usage example with argument unpacking
kwargs: GetQueryStatusInputRequestTypeDef = { # (1)
"MonitorName": ...,
"QueryId": ...,
}
parent.get_query_status(**kwargs)
list_health_events#
Lists all health events for a monitor in Amazon CloudWatch Internet Monitor.
Type annotations and code completion for session.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)
...
# list_health_events method usage example with argument unpacking
kwargs: ListHealthEventsInputRequestTypeDef = { # (1)
"MonitorName": ...,
}
parent.list_health_events(**kwargs)
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.client("internetmonitor").list_monitors
method.
boto3 documentation
# list_monitors method definition
await def list_monitors(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
MonitorStatus: str = ...,
) -> ListMonitorsOutputTypeDef: # (1)
...
# list_monitors method usage example with argument unpacking
kwargs: ListMonitorsInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_monitors(**kwargs)
list_tags_for_resource#
Lists the tags for a resource.
Type annotations and code completion for session.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)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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 session.client("internetmonitor").start_query
method.
boto3 documentation
# start_query method definition
await def start_query(
self,
*,
MonitorName: str,
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
QueryType: QueryTypeType, # (1)
FilterParameters: Sequence[FilterParameterTypeDef] = ..., # (2)
) -> StartQueryOutputTypeDef: # (3)
...
# start_query method usage example with argument unpacking
kwargs: StartQueryInputRequestTypeDef = { # (1)
"MonitorName": ...,
"StartTime": ...,
"EndTime": ...,
"QueryType": ...,
}
parent.start_query(**kwargs)
stop_query#
Stop a query that is progress for a specific monitor.
Type annotations and code completion for session.client("internetmonitor").stop_query
method.
boto3 documentation
# stop_query method definition
await 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)
tag_resource#
Adds a tag to a resource.
Type annotations and code completion for session.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)
untag_resource#
Removes a tag from a resource.
Type annotations and code completion for session.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)
update_monitor#
Updates a monitor.
Type annotations and code completion for session.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)
...
- See MonitorConfigStateType
- See InternetMeasurementsLogDeliveryTypeDef
- See HealthEventsConfigTypeDef
- See UpdateMonitorOutputTypeDef
# update_monitor method usage example with argument unpacking
kwargs: UpdateMonitorInputRequestTypeDef = { # (1)
"MonitorName": ...,
}
parent.update_monitor(**kwargs)
__aenter__#
Type annotations and code completion for session.client("internetmonitor").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> CloudWatchInternetMonitorClient:
...
__aexit__#
Type annotations and code completion for session.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.client("internetmonitor").get_paginator
method with overloads.
client.get_paginator("list_health_events")
-> ListHealthEventsPaginatorclient.get_paginator("list_monitors")
-> ListMonitorsPaginator