CloudWatchRUMClient

Index > CloudWatchRUM > CloudWatchRUMClient

Auto-generated documentation for CloudWatchRUM type annotations stubs module types-aiobotocore-rum.

CloudWatchRUMClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_rum.client import CloudWatchRUMClient

session = Session()
async with session.client("rum") as client:
    client: CloudWatchRUMClient

Exceptions

aioboto3 client exceptions are generated in runtime. This class provides code completion for session.client("rum").exceptions structure.

Usage example

async with session.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)

Type checking example

from types_aiobotocore_rum.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("rum").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 session.client("rum").close method. boto3 documentation

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.client("rum").create_app_monitor method. boto3 documentation

Method definition

await def create_app_monitor(
    self,
    *,
    Domain: str,
    Name: str,
    AppMonitorConfiguration: AppMonitorConfigurationTypeDef = ...,  # (1)
    CwLogEnabled: bool = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateAppMonitorResponseTypeDef:  # (2)
    ...

1. See AppMonitorConfigurationTypeDef
2. See CreateAppMonitorResponseTypeDef

Usage example with kwargs

kwargs: CreateAppMonitorRequestRequestTypeDef = {  # (1)
    "Domain": ...,
    "Name": ...,
}

parent.create_app_monitor(**kwargs)

1. See CreateAppMonitorRequestRequestTypeDef

delete_app_monitor

Deletes an existing app monitor.

Type annotations and code completion for session.client("rum").delete_app_monitor method. boto3 documentation

Method definition

await def delete_app_monitor(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteAppMonitorRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_app_monitor(**kwargs)

1. See DeleteAppMonitorRequestRequestTypeDef

generate_presigned_url

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

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

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.client("rum").get_app_monitor method. boto3 documentation

Method definition

await def get_app_monitor(
    self,
    *,
    Name: str,
) -> GetAppMonitorResponseTypeDef:  # (1)
    ...

1. See GetAppMonitorResponseTypeDef

Usage example with kwargs

kwargs: GetAppMonitorRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_app_monitor(**kwargs)

1. See GetAppMonitorRequestRequestTypeDef

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.client("rum").get_app_monitor_data method. boto3 documentation

Method definition

await def get_app_monitor_data(
    self,
    *,
    Name: str,
    TimeRange: TimeRangeTypeDef,  # (1)
    Filters: Sequence[QueryFilterTypeDef] = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetAppMonitorDataResponseTypeDef:  # (3)
    ...

1. See TimeRangeTypeDef
2. See QueryFilterTypeDef
3. See GetAppMonitorDataResponseTypeDef

Usage example with kwargs

kwargs: GetAppMonitorDataRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "TimeRange": ...,
}

parent.get_app_monitor_data(**kwargs)

1. See GetAppMonitorDataRequestRequestTypeDef

list_app_monitors

Returns a list of the Amazon CloudWatch RUM app monitors in the account.

Type annotations and code completion for session.client("rum").list_app_monitors method. boto3 documentation

Method definition

await def list_app_monitors(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAppMonitorsResponseTypeDef:  # (1)
    ...

1. See ListAppMonitorsResponseTypeDef

Usage example with kwargs

kwargs: ListAppMonitorsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_app_monitors(**kwargs)

1. See ListAppMonitorsRequestRequestTypeDef

list_tags_for_resource

Displays the tags associated with a CloudWatch RUM resource.

Type annotations and code completion for session.client("rum").list_tags_for_resource method. boto3 documentation

Method definition

await def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

put_rum_events

Sends telemetry events about your application performance and user behavior to CloudWatch RUM.

Type annotations and code completion for session.client("rum").put_rum_events method. boto3 documentation

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]:
    ...

1. See AppMonitorDetailsTypeDef
2. See RumEventTypeDef
3. See UserDetailsTypeDef

Usage example with kwargs

kwargs: PutRumEventsRequestRequestTypeDef = {  # (1)
    "AppMonitorDetails": ...,
    "BatchId": ...,
    "Id": ...,
    "RumEvents": ...,
    "UserDetails": ...,
}

parent.put_rum_events(**kwargs)

1. See PutRumEventsRequestRequestTypeDef

tag_resource

Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource.

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

Method definition

await def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes one or more tags from the specified resource.

Type annotations and code completion for session.client("rum").untag_resource method. boto3 documentation

Method definition

await def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_app_monitor

Updates the configuration of an existing app monitor.

Type annotations and code completion for session.client("rum").update_app_monitor method. boto3 documentation

Method definition

await def update_app_monitor(
    self,
    *,
    Name: str,
    AppMonitorConfiguration: AppMonitorConfigurationTypeDef = ...,  # (1)
    CwLogEnabled: bool = ...,
    Domain: str = ...,
) -> Dict[str, Any]:
    ...

1. See AppMonitorConfigurationTypeDef

Usage example with kwargs

kwargs: UpdateAppMonitorRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.update_app_monitor(**kwargs)

1. See UpdateAppMonitorRequestRequestTypeDef

__aenter__

Type annotations and code completion for session.client("rum").__aenter__ method. boto3 documentation

Method definition

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

__aexit__

Type annotations and code completion for session.client("rum").__aexit__ method. boto3 documentation

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("rum").get_paginator method with overloads.

• client.get_paginator("get_app_monitor_data") -> GetAppMonitorDataPaginator
• client.get_paginator("list_app_monitors") -> ListAppMonitorsPaginator