CloudWatchRUMClient#
Index > CloudWatchRUM > CloudWatchRUMClient
Auto-generated documentation for CloudWatchRUM type annotations stubs module types-aiobotocore-rum.
CloudWatchRUMClient#
Type annotations and code completion for session.create_client("rum")
boto3 documentation
CloudWatchRUMClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_rum.client import CloudWatchRUMClient
session = get_session()
async with session.create_client("rum") as client:
client: CloudWatchRUMClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("rum").exceptions
structure.
CloudWatchRUMClient.exceptions usage example
async with session.create_client("rum") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
CloudWatchRUMClient usage type checking example
from types_aiobotocore_rum.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
batch_create_rum_metric_definitions#
Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination.
Type annotations and code completion for session.create_client("rum").batch_create_rum_metric_definitions
method.
boto3 documentation
# batch_create_rum_metric_definitions method definition
await def batch_create_rum_metric_definitions(
self,
*,
AppMonitorName: str,
Destination: MetricDestinationType, # (1)
MetricDefinitions: Sequence[MetricDefinitionRequestTypeDef], # (2)
DestinationArn: str = ...,
) -> BatchCreateRumMetricDefinitionsResponseTypeDef: # (3)
...
- See MetricDestinationType
- See MetricDefinitionRequestTypeDef
- See BatchCreateRumMetricDefinitionsResponseTypeDef
# batch_create_rum_metric_definitions method usage example with argument unpacking
kwargs: BatchCreateRumMetricDefinitionsRequestRequestTypeDef = { # (1)
"AppMonitorName": ...,
"Destination": ...,
"MetricDefinitions": ...,
}
parent.batch_create_rum_metric_definitions(**kwargs)
batch_delete_rum_metric_definitions#
Removes the specified metrics from being sent to an extended metrics destination.
Type annotations and code completion for session.create_client("rum").batch_delete_rum_metric_definitions
method.
boto3 documentation
# batch_delete_rum_metric_definitions method definition
await def batch_delete_rum_metric_definitions(
self,
*,
AppMonitorName: str,
Destination: MetricDestinationType, # (1)
MetricDefinitionIds: Sequence[str],
DestinationArn: str = ...,
) -> BatchDeleteRumMetricDefinitionsResponseTypeDef: # (2)
...
# batch_delete_rum_metric_definitions method usage example with argument unpacking
kwargs: BatchDeleteRumMetricDefinitionsRequestRequestTypeDef = { # (1)
"AppMonitorName": ...,
"Destination": ...,
"MetricDefinitionIds": ...,
}
parent.batch_delete_rum_metric_definitions(**kwargs)
batch_get_rum_metric_definitions#
Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.
Type annotations and code completion for session.create_client("rum").batch_get_rum_metric_definitions
method.
boto3 documentation
# batch_get_rum_metric_definitions method definition
await def batch_get_rum_metric_definitions(
self,
*,
AppMonitorName: str,
Destination: MetricDestinationType, # (1)
DestinationArn: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> BatchGetRumMetricDefinitionsResponseTypeDef: # (2)
...
# batch_get_rum_metric_definitions method usage example with argument unpacking
kwargs: BatchGetRumMetricDefinitionsRequestRequestTypeDef = { # (1)
"AppMonitorName": ...,
"Destination": ...,
}
parent.batch_get_rum_metric_definitions(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.create_client("rum").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("rum").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_app_monitor#
Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM.
Type annotations and code completion for session.create_client("rum").create_app_monitor
method.
boto3 documentation
# create_app_monitor method definition
await def create_app_monitor(
self,
*,
Domain: str,
Name: str,
AppMonitorConfiguration: AppMonitorConfigurationTypeDef = ..., # (1)
CustomEvents: CustomEventsTypeDef = ..., # (2)
CwLogEnabled: bool = ...,
Tags: Mapping[str, str] = ...,
) -> CreateAppMonitorResponseTypeDef: # (3)
...
# create_app_monitor method usage example with argument unpacking
kwargs: CreateAppMonitorRequestRequestTypeDef = { # (1)
"Domain": ...,
"Name": ...,
}
parent.create_app_monitor(**kwargs)
delete_app_monitor#
Deletes an existing app monitor.
Type annotations and code completion for session.create_client("rum").delete_app_monitor
method.
boto3 documentation
# delete_app_monitor method definition
await def delete_app_monitor(
self,
*,
Name: str,
) -> Dict[str, Any]:
...
# delete_app_monitor method usage example with argument unpacking
kwargs: DeleteAppMonitorRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_app_monitor(**kwargs)
delete_rum_metrics_destination#
Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.
Type annotations and code completion for session.create_client("rum").delete_rum_metrics_destination
method.
boto3 documentation
# delete_rum_metrics_destination method definition
await def delete_rum_metrics_destination(
self,
*,
AppMonitorName: str,
Destination: MetricDestinationType, # (1)
DestinationArn: str = ...,
) -> Dict[str, Any]:
...
# delete_rum_metrics_destination method usage example with argument unpacking
kwargs: DeleteRumMetricsDestinationRequestRequestTypeDef = { # (1)
"AppMonitorName": ...,
"Destination": ...,
}
parent.delete_rum_metrics_destination(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("rum").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_app_monitor#
Retrieves the complete configuration information for one app monitor.
Type annotations and code completion for session.create_client("rum").get_app_monitor
method.
boto3 documentation
# get_app_monitor method definition
await def get_app_monitor(
self,
*,
Name: str,
) -> GetAppMonitorResponseTypeDef: # (1)
...
# get_app_monitor method usage example with argument unpacking
kwargs: GetAppMonitorRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_app_monitor(**kwargs)
get_app_monitor_data#
Retrieves the raw performance events that RUM has collected from your web application, so that you can do your own processing or analysis of this data.
Type annotations and code completion for session.create_client("rum").get_app_monitor_data
method.
boto3 documentation
# get_app_monitor_data method definition
await def get_app_monitor_data(
self,
*,
Name: str,
TimeRange: TimeRangeTypeDef, # (1)
Filters: Sequence[QueryFilterTypeDef] = ..., # (2)
MaxResults: int = ...,
NextToken: str = ...,
) -> GetAppMonitorDataResponseTypeDef: # (3)
...
# get_app_monitor_data method usage example with argument unpacking
kwargs: GetAppMonitorDataRequestRequestTypeDef = { # (1)
"Name": ...,
"TimeRange": ...,
}
parent.get_app_monitor_data(**kwargs)
list_app_monitors#
Returns a list of the Amazon CloudWatch RUM app monitors in the account.
Type annotations and code completion for session.create_client("rum").list_app_monitors
method.
boto3 documentation
# list_app_monitors method definition
await def list_app_monitors(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAppMonitorsResponseTypeDef: # (1)
...
# list_app_monitors method usage example with argument unpacking
kwargs: ListAppMonitorsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_app_monitors(**kwargs)
list_rum_metrics_destinations#
Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor.
Type annotations and code completion for session.create_client("rum").list_rum_metrics_destinations
method.
boto3 documentation
# list_rum_metrics_destinations method definition
await def list_rum_metrics_destinations(
self,
*,
AppMonitorName: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListRumMetricsDestinationsResponseTypeDef: # (1)
...
# list_rum_metrics_destinations method usage example with argument unpacking
kwargs: ListRumMetricsDestinationsRequestRequestTypeDef = { # (1)
"AppMonitorName": ...,
}
parent.list_rum_metrics_destinations(**kwargs)
list_tags_for_resource#
Displays the tags associated with a CloudWatch RUM resource.
Type annotations and code completion for session.create_client("rum").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
put_rum_events#
Sends telemetry events about your application performance and user behavior to CloudWatch RUM.
Type annotations and code completion for session.create_client("rum").put_rum_events
method.
boto3 documentation
# put_rum_events method definition
await def put_rum_events(
self,
*,
AppMonitorDetails: AppMonitorDetailsTypeDef, # (1)
BatchId: str,
Id: str,
RumEvents: Sequence[RumEventTypeDef], # (2)
UserDetails: UserDetailsTypeDef, # (3)
) -> Dict[str, Any]:
...
# put_rum_events method usage example with argument unpacking
kwargs: PutRumEventsRequestRequestTypeDef = { # (1)
"AppMonitorDetails": ...,
"BatchId": ...,
"Id": ...,
"RumEvents": ...,
"UserDetails": ...,
}
parent.put_rum_events(**kwargs)
put_rum_metrics_destination#
Creates or updates a destination to receive extended metrics from CloudWatch RUM.
Type annotations and code completion for session.create_client("rum").put_rum_metrics_destination
method.
boto3 documentation
# put_rum_metrics_destination method definition
await def put_rum_metrics_destination(
self,
*,
AppMonitorName: str,
Destination: MetricDestinationType, # (1)
DestinationArn: str = ...,
IamRoleArn: str = ...,
) -> Dict[str, Any]:
...
# put_rum_metrics_destination method usage example with argument unpacking
kwargs: PutRumMetricsDestinationRequestRequestTypeDef = { # (1)
"AppMonitorName": ...,
"Destination": ...,
}
parent.put_rum_metrics_destination(**kwargs)
tag_resource#
Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource.
Type annotations and code completion for session.create_client("rum").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: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes one or more tags from the specified resource.
Type annotations and code completion for session.create_client("rum").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: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_app_monitor#
Updates the configuration of an existing app monitor.
Type annotations and code completion for session.create_client("rum").update_app_monitor
method.
boto3 documentation
# update_app_monitor method definition
await def update_app_monitor(
self,
*,
Name: str,
AppMonitorConfiguration: AppMonitorConfigurationTypeDef = ..., # (1)
CustomEvents: CustomEventsTypeDef = ..., # (2)
CwLogEnabled: bool = ...,
Domain: str = ...,
) -> Dict[str, Any]:
...
# update_app_monitor method usage example with argument unpacking
kwargs: UpdateAppMonitorRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.update_app_monitor(**kwargs)
update_rum_metric_definition#
Modifies one existing metric definition for CloudWatch RUM extended metrics.
Type annotations and code completion for session.create_client("rum").update_rum_metric_definition
method.
boto3 documentation
# update_rum_metric_definition method definition
await def update_rum_metric_definition(
self,
*,
AppMonitorName: str,
Destination: MetricDestinationType, # (1)
MetricDefinition: MetricDefinitionRequestTypeDef, # (2)
MetricDefinitionId: str,
DestinationArn: str = ...,
) -> Dict[str, Any]:
...
# update_rum_metric_definition method usage example with argument unpacking
kwargs: UpdateRumMetricDefinitionRequestRequestTypeDef = { # (1)
"AppMonitorName": ...,
"Destination": ...,
"MetricDefinition": ...,
"MetricDefinitionId": ...,
}
parent.update_rum_metric_definition(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("rum").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> CloudWatchRUMClient:
...
__aexit__#
Type annotations and code completion for session.create_client("rum").__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("rum").get_paginator
method with overloads.
client.get_paginator("batch_get_rum_metric_definitions")
-> BatchGetRumMetricDefinitionsPaginatorclient.get_paginator("get_app_monitor_data")
-> GetAppMonitorDataPaginatorclient.get_paginator("list_app_monitors")
-> ListAppMonitorsPaginatorclient.get_paginator("list_rum_metrics_destinations")
-> ListRumMetricsDestinationsPaginator