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)
- 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)
- See StateEnumType
CustomEventsTypeDef
Usage Example
from mypy_boto3_rum.type_defs import CustomEventsTypeDef
def get_value() -> CustomEventsTypeDef:
return {
"Status": ...,
}
MetricDefinitionRequestTypeDef
Usage Example
from mypy_boto3_rum.type_defs import MetricDefinitionRequestTypeDef
def get_value() -> MetricDefinitionRequestTypeDef:
return {
"Name": ...,
}
Definition
class MetricDefinitionRequestTypeDef(TypedDict):
Name: str,
DimensionKeys: NotRequired[Mapping[str, str]],
EventPattern: NotRequired[str],
Namespace: NotRequired[str],
UnitLabel: NotRequired[str],
ValueKey: NotRequired[str],
MetricDefinitionTypeDef
Usage Example
from mypy_boto3_rum.type_defs import MetricDefinitionTypeDef
def get_value() -> MetricDefinitionTypeDef:
return {
"MetricDefinitionId": ...,
"Name": ...,
}
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
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,
BatchDeleteRumMetricDefinitionsErrorTypeDef
Usage Example
from mypy_boto3_rum.type_defs import BatchDeleteRumMetricDefinitionsErrorTypeDef
def get_value() -> BatchDeleteRumMetricDefinitionsErrorTypeDef:
return {
"ErrorCode": ...,
"ErrorMessage": ...,
"MetricDefinitionId": ...,
}
Definition
class BatchDeleteRumMetricDefinitionsErrorTypeDef(TypedDict):
ErrorCode: str,
ErrorMessage: str,
MetricDefinitionId: str,
BatchDeleteRumMetricDefinitionsRequestRequestTypeDef
Usage Example
from mypy_boto3_rum.type_defs import BatchDeleteRumMetricDefinitionsRequestRequestTypeDef
def get_value() -> BatchDeleteRumMetricDefinitionsRequestRequestTypeDef:
return {
"AppMonitorName": ...,
"Destination": ...,
"MetricDefinitionIds": ...,
}
Definition
class BatchDeleteRumMetricDefinitionsRequestRequestTypeDef(TypedDict):
AppMonitorName: str,
Destination: MetricDestinationType, # (1)
MetricDefinitionIds: Sequence[str],
DestinationArn: NotRequired[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],
BatchGetRumMetricDefinitionsRequestRequestTypeDef
Usage Example
from mypy_boto3_rum.type_defs import BatchGetRumMetricDefinitionsRequestRequestTypeDef
def get_value() -> BatchGetRumMetricDefinitionsRequestRequestTypeDef:
return {
"AppMonitorName": ...,
"Destination": ...,
}
Definition
class BatchGetRumMetricDefinitionsRequestRequestTypeDef(TypedDict):
AppMonitorName: str,
Destination: MetricDestinationType, # (1)
DestinationArn: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
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": ...,
}
DeleteRumMetricsDestinationRequestRequestTypeDef
Usage Example
from mypy_boto3_rum.type_defs import DeleteRumMetricsDestinationRequestRequestTypeDef
def get_value() -> DeleteRumMetricsDestinationRequestRequestTypeDef:
return {
"AppMonitorName": ...,
"Destination": ...,
}
Definition
class DeleteRumMetricsDestinationRequestRequestTypeDef(TypedDict):
AppMonitorName: str,
Destination: MetricDestinationType, # (1)
DestinationArn: 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": ...,
}
GetAppMonitorRequestRequestTypeDef
Usage Example
from mypy_boto3_rum.type_defs import GetAppMonitorRequestRequestTypeDef
def get_value() -> GetAppMonitorRequestRequestTypeDef:
return {
"Name": ...,
}
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],
ListRumMetricsDestinationsRequestRequestTypeDef
Usage Example
from mypy_boto3_rum.type_defs import ListRumMetricsDestinationsRequestRequestTypeDef
def get_value() -> ListRumMetricsDestinationsRequestRequestTypeDef:
return {
"AppMonitorName": ...,
}
Definition
class ListRumMetricsDestinationsRequestRequestTypeDef(TypedDict):
AppMonitorName: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
MetricDestinationSummaryTypeDef
Usage Example
from mypy_boto3_rum.type_defs import MetricDestinationSummaryTypeDef
def get_value() -> MetricDestinationSummaryTypeDef:
return {
"Destination": ...,
}
Definition
class MetricDestinationSummaryTypeDef(TypedDict):
Destination: NotRequired[MetricDestinationType], # (1)
DestinationArn: NotRequired[str],
IamRoleArn: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_rum.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
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],
PutRumMetricsDestinationRequestRequestTypeDef
Usage Example
from mypy_boto3_rum.type_defs import PutRumMetricsDestinationRequestRequestTypeDef
def get_value() -> PutRumMetricsDestinationRequestRequestTypeDef:
return {
"AppMonitorName": ...,
"Destination": ...,
}
Definition
class PutRumMetricsDestinationRequestRequestTypeDef(TypedDict):
AppMonitorName: str,
Destination: MetricDestinationType, # (1)
DestinationArn: NotRequired[str],
IamRoleArn: 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)
CustomEvents: NotRequired[CustomEventsTypeDef], # (2)
CwLogEnabled: NotRequired[bool],
Tags: NotRequired[Mapping[str, str]],
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)
CustomEvents: NotRequired[CustomEventsTypeDef], # (2)
CwLogEnabled: NotRequired[bool],
Domain: NotRequired[str],
BatchCreateRumMetricDefinitionsErrorTypeDef
Usage Example
from mypy_boto3_rum.type_defs import BatchCreateRumMetricDefinitionsErrorTypeDef
def get_value() -> BatchCreateRumMetricDefinitionsErrorTypeDef:
return {
"ErrorCode": ...,
"ErrorMessage": ...,
"MetricDefinition": ...,
}
Definition
class BatchCreateRumMetricDefinitionsErrorTypeDef(TypedDict):
ErrorCode: str,
ErrorMessage: str,
MetricDefinition: MetricDefinitionRequestTypeDef, # (1)
BatchCreateRumMetricDefinitionsRequestRequestTypeDef
Usage Example
from mypy_boto3_rum.type_defs import BatchCreateRumMetricDefinitionsRequestRequestTypeDef
def get_value() -> BatchCreateRumMetricDefinitionsRequestRequestTypeDef:
return {
"AppMonitorName": ...,
"Destination": ...,
"MetricDefinitions": ...,
}
Definition
class BatchCreateRumMetricDefinitionsRequestRequestTypeDef(TypedDict):
AppMonitorName: str,
Destination: MetricDestinationType, # (1)
MetricDefinitions: Sequence[MetricDefinitionRequestTypeDef], # (2)
DestinationArn: NotRequired[str],
UpdateRumMetricDefinitionRequestRequestTypeDef
Usage Example
from mypy_boto3_rum.type_defs import UpdateRumMetricDefinitionRequestRequestTypeDef
def get_value() -> UpdateRumMetricDefinitionRequestRequestTypeDef:
return {
"AppMonitorName": ...,
"Destination": ...,
"MetricDefinition": ...,
"MetricDefinitionId": ...,
}
Definition
class UpdateRumMetricDefinitionRequestRequestTypeDef(TypedDict):
AppMonitorName: str,
Destination: MetricDestinationType, # (1)
MetricDefinition: MetricDefinitionRequestTypeDef, # (2)
MetricDefinitionId: str,
DestinationArn: NotRequired[str],
BatchGetRumMetricDefinitionsResponseTypeDef
Usage Example
from mypy_boto3_rum.type_defs import BatchGetRumMetricDefinitionsResponseTypeDef
def get_value() -> BatchGetRumMetricDefinitionsResponseTypeDef:
return {
"MetricDefinitions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class BatchGetRumMetricDefinitionsResponseTypeDef(TypedDict):
MetricDefinitions: List[MetricDefinitionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
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)
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)
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)
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)
BatchDeleteRumMetricDefinitionsResponseTypeDef
Usage Example
from mypy_boto3_rum.type_defs import BatchDeleteRumMetricDefinitionsResponseTypeDef
def get_value() -> BatchDeleteRumMetricDefinitionsResponseTypeDef:
return {
"Errors": ...,
"MetricDefinitionIds": ...,
"ResponseMetadata": ...,
}
Definition
class BatchDeleteRumMetricDefinitionsResponseTypeDef(TypedDict):
Errors: List[BatchDeleteRumMetricDefinitionsErrorTypeDef], # (1)
MetricDefinitionIds: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchGetRumMetricDefinitionsRequestBatchGetRumMetricDefinitionsPaginateTypeDef
Usage Example
from mypy_boto3_rum.type_defs import BatchGetRumMetricDefinitionsRequestBatchGetRumMetricDefinitionsPaginateTypeDef
def get_value() -> BatchGetRumMetricDefinitionsRequestBatchGetRumMetricDefinitionsPaginateTypeDef:
return {
"AppMonitorName": ...,
"Destination": ...,
}
Definition
class BatchGetRumMetricDefinitionsRequestBatchGetRumMetricDefinitionsPaginateTypeDef(TypedDict):
AppMonitorName: str,
Destination: MetricDestinationType, # (1)
DestinationArn: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
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)
ListRumMetricsDestinationsRequestListRumMetricsDestinationsPaginateTypeDef
Usage Example
from mypy_boto3_rum.type_defs import ListRumMetricsDestinationsRequestListRumMetricsDestinationsPaginateTypeDef
def get_value() -> ListRumMetricsDestinationsRequestListRumMetricsDestinationsPaginateTypeDef:
return {
"AppMonitorName": ...,
}
Definition
class ListRumMetricsDestinationsRequestListRumMetricsDestinationsPaginateTypeDef(TypedDict):
AppMonitorName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DataStorageTypeDef
Usage Example
from mypy_boto3_rum.type_defs import DataStorageTypeDef
def get_value() -> DataStorageTypeDef:
return {
"CwLog": ...,
}
- See CwLogTypeDef
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)
- See TimeRangeTypeDef
- See QueryFilterTypeDef
- 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],
- See TimeRangeTypeDef
- See QueryFilterTypeDef
ListRumMetricsDestinationsResponseTypeDef
Usage Example
from mypy_boto3_rum.type_defs import ListRumMetricsDestinationsResponseTypeDef
def get_value() -> ListRumMetricsDestinationsResponseTypeDef:
return {
"Destinations": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListRumMetricsDestinationsResponseTypeDef(TypedDict):
Destinations: List[MetricDestinationSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
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)
BatchCreateRumMetricDefinitionsResponseTypeDef
Usage Example
from mypy_boto3_rum.type_defs import BatchCreateRumMetricDefinitionsResponseTypeDef
def get_value() -> BatchCreateRumMetricDefinitionsResponseTypeDef:
return {
"Errors": ...,
"MetricDefinitions": ...,
"ResponseMetadata": ...,
}
Definition
class BatchCreateRumMetricDefinitionsResponseTypeDef(TypedDict):
Errors: List[BatchCreateRumMetricDefinitionsErrorTypeDef], # (1)
MetricDefinitions: List[MetricDefinitionTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See BatchCreateRumMetricDefinitionsErrorTypeDef
- See MetricDefinitionTypeDef
- See ResponseMetadataTypeDef
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],
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]],
GetAppMonitorResponseTypeDef
Usage Example
from mypy_boto3_rum.type_defs import GetAppMonitorResponseTypeDef
def get_value() -> GetAppMonitorResponseTypeDef:
return {
"AppMonitor": ...,
"ResponseMetadata": ...,
}