Skip to content

Type definitions#

Index > CloudWatchRUM > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AppMonitorConfigurationTypeDef#

# AppMonitorConfigurationTypeDef 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#

# AppMonitorDetailsTypeDef definition

class AppMonitorDetailsTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    version: NotRequired[str],

AppMonitorSummaryTypeDef#

# AppMonitorSummaryTypeDef definition

class AppMonitorSummaryTypeDef(TypedDict):
    Created: NotRequired[str],
    Id: NotRequired[str],
    LastModified: NotRequired[str],
    Name: NotRequired[str],
    State: NotRequired[StateEnumType],  # (1)
  1. See StateEnumType

CustomEventsTypeDef#

# CustomEventsTypeDef definition

class CustomEventsTypeDef(TypedDict):
    Status: NotRequired[CustomEventsStatusType],  # (1)
  1. See CustomEventsStatusType

MetricDefinitionRequestTypeDef#

# MetricDefinitionRequestTypeDef definition

class MetricDefinitionRequestTypeDef(TypedDict):
    Name: str,
    DimensionKeys: NotRequired[Mapping[str, str]],
    EventPattern: NotRequired[str],
    Namespace: NotRequired[str],
    UnitLabel: NotRequired[str],
    ValueKey: NotRequired[str],

MetricDefinitionTypeDef#

# MetricDefinitionTypeDef definition

class MetricDefinitionTypeDef(TypedDict):
    MetricDefinitionId: str,
    Name: str,
    DimensionKeys: NotRequired[Dict[str, str]],
    EventPattern: NotRequired[str],
    Namespace: NotRequired[str],
    UnitLabel: NotRequired[str],
    ValueKey: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

BatchDeleteRumMetricDefinitionsErrorTypeDef#

# BatchDeleteRumMetricDefinitionsErrorTypeDef definition

class BatchDeleteRumMetricDefinitionsErrorTypeDef(TypedDict):
    ErrorCode: str,
    ErrorMessage: str,
    MetricDefinitionId: str,

BatchDeleteRumMetricDefinitionsRequestRequestTypeDef#

# BatchDeleteRumMetricDefinitionsRequestRequestTypeDef definition

class BatchDeleteRumMetricDefinitionsRequestRequestTypeDef(TypedDict):
    AppMonitorName: str,
    Destination: MetricDestinationType,  # (1)
    MetricDefinitionIds: Sequence[str],
    DestinationArn: NotRequired[str],
  1. See MetricDestinationType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

BatchGetRumMetricDefinitionsRequestRequestTypeDef#

# BatchGetRumMetricDefinitionsRequestRequestTypeDef definition

class BatchGetRumMetricDefinitionsRequestRequestTypeDef(TypedDict):
    AppMonitorName: str,
    Destination: MetricDestinationType,  # (1)
    DestinationArn: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See MetricDestinationType

CwLogTypeDef#

# CwLogTypeDef definition

class CwLogTypeDef(TypedDict):
    CwLogEnabled: NotRequired[bool],
    CwLogGroup: NotRequired[str],

DeleteAppMonitorRequestRequestTypeDef#

# DeleteAppMonitorRequestRequestTypeDef definition

class DeleteAppMonitorRequestRequestTypeDef(TypedDict):
    Name: str,

DeleteRumMetricsDestinationRequestRequestTypeDef#

# DeleteRumMetricsDestinationRequestRequestTypeDef definition

class DeleteRumMetricsDestinationRequestRequestTypeDef(TypedDict):
    AppMonitorName: str,
    Destination: MetricDestinationType,  # (1)
    DestinationArn: NotRequired[str],
  1. See MetricDestinationType

QueryFilterTypeDef#

# QueryFilterTypeDef definition

class QueryFilterTypeDef(TypedDict):
    Name: NotRequired[str],
    Values: NotRequired[Sequence[str]],

TimeRangeTypeDef#

# TimeRangeTypeDef definition

class TimeRangeTypeDef(TypedDict):
    After: int,
    Before: NotRequired[int],

GetAppMonitorRequestRequestTypeDef#

# GetAppMonitorRequestRequestTypeDef definition

class GetAppMonitorRequestRequestTypeDef(TypedDict):
    Name: str,

ListAppMonitorsRequestRequestTypeDef#

# ListAppMonitorsRequestRequestTypeDef definition

class ListAppMonitorsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListRumMetricsDestinationsRequestRequestTypeDef#

# ListRumMetricsDestinationsRequestRequestTypeDef definition

class ListRumMetricsDestinationsRequestRequestTypeDef(TypedDict):
    AppMonitorName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

MetricDestinationSummaryTypeDef#

# MetricDestinationSummaryTypeDef definition

class MetricDestinationSummaryTypeDef(TypedDict):
    Destination: NotRequired[MetricDestinationType],  # (1)
    DestinationArn: NotRequired[str],
    IamRoleArn: NotRequired[str],
  1. See MetricDestinationType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

UserDetailsTypeDef#

# UserDetailsTypeDef definition

class UserDetailsTypeDef(TypedDict):
    sessionId: NotRequired[str],
    userId: NotRequired[str],

PutRumMetricsDestinationRequestRequestTypeDef#

# PutRumMetricsDestinationRequestRequestTypeDef definition

class PutRumMetricsDestinationRequestRequestTypeDef(TypedDict):
    AppMonitorName: str,
    Destination: MetricDestinationType,  # (1)
    DestinationArn: NotRequired[str],
    IamRoleArn: NotRequired[str],
  1. See MetricDestinationType

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

CreateAppMonitorRequestRequestTypeDef#

# CreateAppMonitorRequestRequestTypeDef definition

class CreateAppMonitorRequestRequestTypeDef(TypedDict):
    Domain: str,
    Name: str,
    AppMonitorConfiguration: NotRequired[AppMonitorConfigurationTypeDef],  # (1)
    CustomEvents: NotRequired[CustomEventsTypeDef],  # (2)
    CwLogEnabled: NotRequired[bool],
    Tags: NotRequired[Mapping[str, str]],
  1. See AppMonitorConfigurationTypeDef
  2. See CustomEventsTypeDef

UpdateAppMonitorRequestRequestTypeDef#

# UpdateAppMonitorRequestRequestTypeDef definition

class UpdateAppMonitorRequestRequestTypeDef(TypedDict):
    Name: str,
    AppMonitorConfiguration: NotRequired[AppMonitorConfigurationTypeDef],  # (1)
    CustomEvents: NotRequired[CustomEventsTypeDef],  # (2)
    CwLogEnabled: NotRequired[bool],
    Domain: NotRequired[str],
  1. See AppMonitorConfigurationTypeDef
  2. See CustomEventsTypeDef

BatchCreateRumMetricDefinitionsErrorTypeDef#

# BatchCreateRumMetricDefinitionsErrorTypeDef definition

class BatchCreateRumMetricDefinitionsErrorTypeDef(TypedDict):
    ErrorCode: str,
    ErrorMessage: str,
    MetricDefinition: MetricDefinitionRequestTypeDef,  # (1)
  1. See MetricDefinitionRequestTypeDef

BatchCreateRumMetricDefinitionsRequestRequestTypeDef#

# BatchCreateRumMetricDefinitionsRequestRequestTypeDef definition

class BatchCreateRumMetricDefinitionsRequestRequestTypeDef(TypedDict):
    AppMonitorName: str,
    Destination: MetricDestinationType,  # (1)
    MetricDefinitions: Sequence[MetricDefinitionRequestTypeDef],  # (2)
    DestinationArn: NotRequired[str],
  1. See MetricDestinationType
  2. See MetricDefinitionRequestTypeDef

UpdateRumMetricDefinitionRequestRequestTypeDef#

# UpdateRumMetricDefinitionRequestRequestTypeDef definition

class UpdateRumMetricDefinitionRequestRequestTypeDef(TypedDict):
    AppMonitorName: str,
    Destination: MetricDestinationType,  # (1)
    MetricDefinition: MetricDefinitionRequestTypeDef,  # (2)
    MetricDefinitionId: str,
    DestinationArn: NotRequired[str],
  1. See MetricDestinationType
  2. See MetricDefinitionRequestTypeDef

BatchGetRumMetricDefinitionsResponseTypeDef#

# BatchGetRumMetricDefinitionsResponseTypeDef definition

class BatchGetRumMetricDefinitionsResponseTypeDef(TypedDict):
    MetricDefinitions: List[MetricDefinitionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MetricDefinitionTypeDef
  2. See ResponseMetadataTypeDef

CreateAppMonitorResponseTypeDef#

# CreateAppMonitorResponseTypeDef definition

class CreateAppMonitorResponseTypeDef(TypedDict):
    Id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetAppMonitorDataResponseTypeDef#

# GetAppMonitorDataResponseTypeDef definition

class GetAppMonitorDataResponseTypeDef(TypedDict):
    Events: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListAppMonitorsResponseTypeDef#

# ListAppMonitorsResponseTypeDef definition

class ListAppMonitorsResponseTypeDef(TypedDict):
    AppMonitorSummaries: List[AppMonitorSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AppMonitorSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

BatchDeleteRumMetricDefinitionsResponseTypeDef#

# BatchDeleteRumMetricDefinitionsResponseTypeDef definition

class BatchDeleteRumMetricDefinitionsResponseTypeDef(TypedDict):
    Errors: List[BatchDeleteRumMetricDefinitionsErrorTypeDef],  # (1)
    MetricDefinitionIds: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchDeleteRumMetricDefinitionsErrorTypeDef
  2. See ResponseMetadataTypeDef

BatchGetRumMetricDefinitionsRequestBatchGetRumMetricDefinitionsPaginateTypeDef#

# BatchGetRumMetricDefinitionsRequestBatchGetRumMetricDefinitionsPaginateTypeDef definition

class BatchGetRumMetricDefinitionsRequestBatchGetRumMetricDefinitionsPaginateTypeDef(TypedDict):
    AppMonitorName: str,
    Destination: MetricDestinationType,  # (1)
    DestinationArn: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See MetricDestinationType
  2. See PaginatorConfigTypeDef

ListAppMonitorsRequestListAppMonitorsPaginateTypeDef#

# ListAppMonitorsRequestListAppMonitorsPaginateTypeDef definition

class ListAppMonitorsRequestListAppMonitorsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRumMetricsDestinationsRequestListRumMetricsDestinationsPaginateTypeDef#

# ListRumMetricsDestinationsRequestListRumMetricsDestinationsPaginateTypeDef definition

class ListRumMetricsDestinationsRequestListRumMetricsDestinationsPaginateTypeDef(TypedDict):
    AppMonitorName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DataStorageTypeDef#

# DataStorageTypeDef definition

class DataStorageTypeDef(TypedDict):
    CwLog: NotRequired[CwLogTypeDef],  # (1)
  1. See CwLogTypeDef

GetAppMonitorDataRequestGetAppMonitorDataPaginateTypeDef#

# GetAppMonitorDataRequestGetAppMonitorDataPaginateTypeDef 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#

# GetAppMonitorDataRequestRequestTypeDef 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

ListRumMetricsDestinationsResponseTypeDef#

# ListRumMetricsDestinationsResponseTypeDef definition

class ListRumMetricsDestinationsResponseTypeDef(TypedDict):
    Destinations: List[MetricDestinationSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MetricDestinationSummaryTypeDef
  2. See ResponseMetadataTypeDef

RumEventTypeDef#

# RumEventTypeDef definition

class RumEventTypeDef(TypedDict):
    details: str,
    id: str,
    timestamp: Union[datetime, str],
    type: str,
    metadata: NotRequired[str],

BatchCreateRumMetricDefinitionsResponseTypeDef#

# BatchCreateRumMetricDefinitionsResponseTypeDef definition

class BatchCreateRumMetricDefinitionsResponseTypeDef(TypedDict):
    Errors: List[BatchCreateRumMetricDefinitionsErrorTypeDef],  # (1)
    MetricDefinitions: List[MetricDefinitionTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See BatchCreateRumMetricDefinitionsErrorTypeDef
  2. See MetricDefinitionTypeDef
  3. See ResponseMetadataTypeDef

AppMonitorTypeDef#

# AppMonitorTypeDef definition

class AppMonitorTypeDef(TypedDict):
    AppMonitorConfiguration: NotRequired[AppMonitorConfigurationTypeDef],  # (1)
    Created: NotRequired[str],
    CustomEvents: NotRequired[CustomEventsTypeDef],  # (2)
    DataStorage: NotRequired[DataStorageTypeDef],  # (3)
    Domain: NotRequired[str],
    Id: NotRequired[str],
    LastModified: NotRequired[str],
    Name: NotRequired[str],
    State: NotRequired[StateEnumType],  # (4)
    Tags: NotRequired[Dict[str, str]],
  1. See AppMonitorConfigurationTypeDef
  2. See CustomEventsTypeDef
  3. See DataStorageTypeDef
  4. See StateEnumType

PutRumEventsRequestRequestTypeDef#

# PutRumEventsRequestRequestTypeDef 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

GetAppMonitorResponseTypeDef#

# GetAppMonitorResponseTypeDef definition

class GetAppMonitorResponseTypeDef(TypedDict):
    AppMonitor: AppMonitorTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AppMonitorTypeDef
  2. See ResponseMetadataTypeDef