Skip to content

Typed dictionaries

Index > CloudWatchRUM > Typed dictionaries

Auto-generated documentation for CloudWatchRUM type annotations stubs module mypy-boto3-rum.

AppMonitorConfigurationTypeDef

Usage Example
from mypy_boto3_rum.type_defs import AppMonitorConfigurationTypeDef

def get_value() -> AppMonitorConfigurationTypeDef:
    return {
        "AllowCookies": ...,
    }
Definition
class AppMonitorConfigurationTypeDef(TypedDict):
    AllowCookies: NotRequired[bool],
    EnableXRay: NotRequired[bool],
    ExcludedPages: NotRequired[Sequence[str]],
    FavoritePages: NotRequired[Sequence[str]],
    GuestRoleArn: NotRequired[str],
    IdentityPoolId: NotRequired[str],
    IncludedPages: NotRequired[Sequence[str]],
    SessionSampleRate: NotRequired[float],
    Telemetries: NotRequired[Sequence[TelemetryType]],  # (1)
  1. See TelemetryType

AppMonitorDetailsTypeDef

Usage Example
from mypy_boto3_rum.type_defs import AppMonitorDetailsTypeDef

def get_value() -> AppMonitorDetailsTypeDef:
    return {
        "id": ...,
    }
Definition
class AppMonitorDetailsTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    version: NotRequired[str],

AppMonitorSummaryTypeDef

Usage Example
from mypy_boto3_rum.type_defs import AppMonitorSummaryTypeDef

def get_value() -> AppMonitorSummaryTypeDef:
    return {
        "Created": ...,
    }
Definition
class AppMonitorSummaryTypeDef(TypedDict):
    Created: NotRequired[str],
    Id: NotRequired[str],
    LastModified: NotRequired[str],
    Name: NotRequired[str],
    State: NotRequired[StateEnumType],  # (1)
  1. See StateEnumType

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_rum.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CwLogTypeDef

Usage Example
from mypy_boto3_rum.type_defs import CwLogTypeDef

def get_value() -> CwLogTypeDef:
    return {
        "CwLogEnabled": ...,
    }
Definition
class CwLogTypeDef(TypedDict):
    CwLogEnabled: NotRequired[bool],
    CwLogGroup: NotRequired[str],

DeleteAppMonitorRequestRequestTypeDef

Usage Example
from mypy_boto3_rum.type_defs import DeleteAppMonitorRequestRequestTypeDef

def get_value() -> DeleteAppMonitorRequestRequestTypeDef:
    return {
        "Name": ...,
    }
Definition
class DeleteAppMonitorRequestRequestTypeDef(TypedDict):
    Name: str,

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_rum.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

QueryFilterTypeDef

Usage Example
from mypy_boto3_rum.type_defs import QueryFilterTypeDef

def get_value() -> QueryFilterTypeDef:
    return {
        "Name": ...,
    }
Definition
class QueryFilterTypeDef(TypedDict):
    Name: NotRequired[str],
    Values: NotRequired[Sequence[str]],

TimeRangeTypeDef

Usage Example
from mypy_boto3_rum.type_defs import TimeRangeTypeDef

def get_value() -> TimeRangeTypeDef:
    return {
        "After": ...,
    }
Definition
class TimeRangeTypeDef(TypedDict):
    After: int,
    Before: NotRequired[int],

GetAppMonitorRequestRequestTypeDef

Usage Example
from mypy_boto3_rum.type_defs import GetAppMonitorRequestRequestTypeDef

def get_value() -> GetAppMonitorRequestRequestTypeDef:
    return {
        "Name": ...,
    }
Definition
class GetAppMonitorRequestRequestTypeDef(TypedDict):
    Name: str,

ListAppMonitorsRequestRequestTypeDef

Usage Example
from mypy_boto3_rum.type_defs import ListAppMonitorsRequestRequestTypeDef

def get_value() -> ListAppMonitorsRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }
Definition
class ListAppMonitorsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_rum.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

RumEventTypeDef

Usage Example
from mypy_boto3_rum.type_defs import RumEventTypeDef

def get_value() -> RumEventTypeDef:
    return {
        "details": ...,
        "id": ...,
        "timestamp": ...,
        "type": ...,
    }
Definition
class RumEventTypeDef(TypedDict):
    details: str,
    id: str,
    timestamp: Union[datetime, str],
    type: str,
    metadata: NotRequired[str],

UserDetailsTypeDef

Usage Example
from mypy_boto3_rum.type_defs import UserDetailsTypeDef

def get_value() -> UserDetailsTypeDef:
    return {
        "sessionId": ...,
    }
Definition
class UserDetailsTypeDef(TypedDict):
    sessionId: NotRequired[str],
    userId: NotRequired[str],

TagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_rum.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
    }
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_rum.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

CreateAppMonitorRequestRequestTypeDef

Usage Example
from mypy_boto3_rum.type_defs import CreateAppMonitorRequestRequestTypeDef

def get_value() -> CreateAppMonitorRequestRequestTypeDef:
    return {
        "Domain": ...,
        "Name": ...,
    }
Definition
class CreateAppMonitorRequestRequestTypeDef(TypedDict):
    Domain: str,
    Name: str,
    AppMonitorConfiguration: NotRequired[AppMonitorConfigurationTypeDef],  # (1)
    CwLogEnabled: NotRequired[bool],
    Tags: NotRequired[Mapping[str, str]],
  1. See AppMonitorConfigurationTypeDef

UpdateAppMonitorRequestRequestTypeDef

Usage Example
from mypy_boto3_rum.type_defs import UpdateAppMonitorRequestRequestTypeDef

def get_value() -> UpdateAppMonitorRequestRequestTypeDef:
    return {
        "Name": ...,
    }
Definition
class UpdateAppMonitorRequestRequestTypeDef(TypedDict):
    Name: str,
    AppMonitorConfiguration: NotRequired[AppMonitorConfigurationTypeDef],  # (1)
    CwLogEnabled: NotRequired[bool],
    Domain: NotRequired[str],
  1. See AppMonitorConfigurationTypeDef

CreateAppMonitorResponseTypeDef

Usage Example
from mypy_boto3_rum.type_defs import CreateAppMonitorResponseTypeDef

def get_value() -> CreateAppMonitorResponseTypeDef:
    return {
        "Id": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateAppMonitorResponseTypeDef(TypedDict):
    Id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetAppMonitorDataResponseTypeDef

Usage Example
from mypy_boto3_rum.type_defs import GetAppMonitorDataResponseTypeDef

def get_value() -> GetAppMonitorDataResponseTypeDef:
    return {
        "Events": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetAppMonitorDataResponseTypeDef(TypedDict):
    Events: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListAppMonitorsResponseTypeDef

Usage Example
from mypy_boto3_rum.type_defs import ListAppMonitorsResponseTypeDef

def get_value() -> ListAppMonitorsResponseTypeDef:
    return {
        "AppMonitorSummaries": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListAppMonitorsResponseTypeDef(TypedDict):
    AppMonitorSummaries: List[AppMonitorSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AppMonitorSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

Usage Example
from mypy_boto3_rum.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DataStorageTypeDef

Usage Example
from mypy_boto3_rum.type_defs import DataStorageTypeDef

def get_value() -> DataStorageTypeDef:
    return {
        "CwLog": ...,
    }
Definition
class DataStorageTypeDef(TypedDict):
    CwLog: NotRequired[CwLogTypeDef],  # (1)
  1. See CwLogTypeDef

ListAppMonitorsRequestListAppMonitorsPaginateTypeDef

Usage Example
from mypy_boto3_rum.type_defs import ListAppMonitorsRequestListAppMonitorsPaginateTypeDef

def get_value() -> ListAppMonitorsRequestListAppMonitorsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
Definition
class ListAppMonitorsRequestListAppMonitorsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetAppMonitorDataRequestGetAppMonitorDataPaginateTypeDef

Usage Example
from mypy_boto3_rum.type_defs import GetAppMonitorDataRequestGetAppMonitorDataPaginateTypeDef

def get_value() -> GetAppMonitorDataRequestGetAppMonitorDataPaginateTypeDef:
    return {
        "Name": ...,
        "TimeRange": ...,
    }
Definition
class GetAppMonitorDataRequestGetAppMonitorDataPaginateTypeDef(TypedDict):
    Name: str,
    TimeRange: TimeRangeTypeDef,  # (1)
    Filters: NotRequired[Sequence[QueryFilterTypeDef]],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See TimeRangeTypeDef
  2. See QueryFilterTypeDef
  3. See PaginatorConfigTypeDef

GetAppMonitorDataRequestRequestTypeDef

Usage Example
from mypy_boto3_rum.type_defs import GetAppMonitorDataRequestRequestTypeDef

def get_value() -> GetAppMonitorDataRequestRequestTypeDef:
    return {
        "Name": ...,
        "TimeRange": ...,
    }
Definition
class GetAppMonitorDataRequestRequestTypeDef(TypedDict):
    Name: str,
    TimeRange: TimeRangeTypeDef,  # (1)
    Filters: NotRequired[Sequence[QueryFilterTypeDef]],  # (2)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See TimeRangeTypeDef
  2. See QueryFilterTypeDef

PutRumEventsRequestRequestTypeDef

Usage Example
from mypy_boto3_rum.type_defs import PutRumEventsRequestRequestTypeDef

def get_value() -> PutRumEventsRequestRequestTypeDef:
    return {
        "AppMonitorDetails": ...,
        "BatchId": ...,
        "Id": ...,
        "RumEvents": ...,
        "UserDetails": ...,
    }
Definition
class PutRumEventsRequestRequestTypeDef(TypedDict):
    AppMonitorDetails: AppMonitorDetailsTypeDef,  # (1)
    BatchId: str,
    Id: str,
    RumEvents: Sequence[RumEventTypeDef],  # (2)
    UserDetails: UserDetailsTypeDef,  # (3)
  1. See AppMonitorDetailsTypeDef
  2. See RumEventTypeDef
  3. See UserDetailsTypeDef

AppMonitorTypeDef

Usage Example
from mypy_boto3_rum.type_defs import AppMonitorTypeDef

def get_value() -> AppMonitorTypeDef:
    return {
        "AppMonitorConfiguration": ...,
    }
Definition
class AppMonitorTypeDef(TypedDict):
    AppMonitorConfiguration: NotRequired[AppMonitorConfigurationTypeDef],  # (1)
    Created: NotRequired[str],
    DataStorage: NotRequired[DataStorageTypeDef],  # (2)
    Domain: NotRequired[str],
    Id: NotRequired[str],
    LastModified: NotRequired[str],
    Name: NotRequired[str],
    State: NotRequired[StateEnumType],  # (3)
    Tags: NotRequired[Dict[str, str]],
  1. See AppMonitorConfigurationTypeDef
  2. See DataStorageTypeDef
  3. See StateEnumType

GetAppMonitorResponseTypeDef

Usage Example
from mypy_boto3_rum.type_defs import GetAppMonitorResponseTypeDef

def get_value() -> GetAppMonitorResponseTypeDef:
    return {
        "AppMonitor": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetAppMonitorResponseTypeDef(TypedDict):
    AppMonitor: AppMonitorTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AppMonitorTypeDef
  2. See ResponseMetadataTypeDef