Typed dictionaries#
Index > CognitoSync > Typed dictionaries
Auto-generated documentation for CognitoSync type annotations stubs module mypy-boto3-cognito-sync.
BulkPublishRequestRequestTypeDef#
# BulkPublishRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import BulkPublishRequestRequestTypeDef
def get_value() -> BulkPublishRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# BulkPublishRequestRequestTypeDef definition
class BulkPublishRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
BulkPublishResponseTypeDef#
# BulkPublishResponseTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import BulkPublishResponseTypeDef
def get_value() -> BulkPublishResponseTypeDef:
return {
"IdentityPoolId": ...,
"ResponseMetadata": ...,
}
# BulkPublishResponseTypeDef definition
class BulkPublishResponseTypeDef(TypedDict):
IdentityPoolId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CognitoStreamsTypeDef#
# CognitoStreamsTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import CognitoStreamsTypeDef
def get_value() -> CognitoStreamsTypeDef:
return {
"StreamName": ...,
}
# CognitoStreamsTypeDef definition
class CognitoStreamsTypeDef(TypedDict):
StreamName: NotRequired[str],
RoleArn: NotRequired[str],
StreamingStatus: NotRequired[StreamingStatusType], # (1)
DatasetTypeDef#
# DatasetTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import DatasetTypeDef
def get_value() -> DatasetTypeDef:
return {
"IdentityId": ...,
}
# DatasetTypeDef definition
class DatasetTypeDef(TypedDict):
IdentityId: NotRequired[str],
DatasetName: NotRequired[str],
CreationDate: NotRequired[datetime],
LastModifiedDate: NotRequired[datetime],
LastModifiedBy: NotRequired[str],
DataStorage: NotRequired[int],
NumRecords: NotRequired[int],
DeleteDatasetRequestRequestTypeDef#
# DeleteDatasetRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import DeleteDatasetRequestRequestTypeDef
def get_value() -> DeleteDatasetRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
"IdentityId": ...,
"DatasetName": ...,
}
# DeleteDatasetRequestRequestTypeDef definition
class DeleteDatasetRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
DatasetName: str,
DescribeDatasetRequestRequestTypeDef#
# DescribeDatasetRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import DescribeDatasetRequestRequestTypeDef
def get_value() -> DescribeDatasetRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
"IdentityId": ...,
"DatasetName": ...,
}
# DescribeDatasetRequestRequestTypeDef definition
class DescribeDatasetRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
DatasetName: str,
DescribeIdentityPoolUsageRequestRequestTypeDef#
# DescribeIdentityPoolUsageRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import DescribeIdentityPoolUsageRequestRequestTypeDef
def get_value() -> DescribeIdentityPoolUsageRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# DescribeIdentityPoolUsageRequestRequestTypeDef definition
class DescribeIdentityPoolUsageRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityPoolUsageTypeDef#
# IdentityPoolUsageTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import IdentityPoolUsageTypeDef
def get_value() -> IdentityPoolUsageTypeDef:
return {
"IdentityPoolId": ...,
}
# IdentityPoolUsageTypeDef definition
class IdentityPoolUsageTypeDef(TypedDict):
IdentityPoolId: NotRequired[str],
SyncSessionsCount: NotRequired[int],
DataStorage: NotRequired[int],
LastModifiedDate: NotRequired[datetime],
DescribeIdentityUsageRequestRequestTypeDef#
# DescribeIdentityUsageRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import DescribeIdentityUsageRequestRequestTypeDef
def get_value() -> DescribeIdentityUsageRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
"IdentityId": ...,
}
# DescribeIdentityUsageRequestRequestTypeDef definition
class DescribeIdentityUsageRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
IdentityUsageTypeDef#
# IdentityUsageTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import IdentityUsageTypeDef
def get_value() -> IdentityUsageTypeDef:
return {
"IdentityId": ...,
}
# IdentityUsageTypeDef definition
class IdentityUsageTypeDef(TypedDict):
IdentityId: NotRequired[str],
IdentityPoolId: NotRequired[str],
LastModifiedDate: NotRequired[datetime],
DatasetCount: NotRequired[int],
DataStorage: NotRequired[int],
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetBulkPublishDetailsRequestRequestTypeDef#
# GetBulkPublishDetailsRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import GetBulkPublishDetailsRequestRequestTypeDef
def get_value() -> GetBulkPublishDetailsRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# GetBulkPublishDetailsRequestRequestTypeDef definition
class GetBulkPublishDetailsRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
GetBulkPublishDetailsResponseTypeDef#
# GetBulkPublishDetailsResponseTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import GetBulkPublishDetailsResponseTypeDef
def get_value() -> GetBulkPublishDetailsResponseTypeDef:
return {
"IdentityPoolId": ...,
"BulkPublishStartTime": ...,
"BulkPublishCompleteTime": ...,
"BulkPublishStatus": ...,
"FailureMessage": ...,
"ResponseMetadata": ...,
}
# GetBulkPublishDetailsResponseTypeDef definition
class GetBulkPublishDetailsResponseTypeDef(TypedDict):
IdentityPoolId: str,
BulkPublishStartTime: datetime,
BulkPublishCompleteTime: datetime,
BulkPublishStatus: BulkPublishStatusType, # (1)
FailureMessage: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetCognitoEventsRequestRequestTypeDef#
# GetCognitoEventsRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import GetCognitoEventsRequestRequestTypeDef
def get_value() -> GetCognitoEventsRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# GetCognitoEventsRequestRequestTypeDef definition
class GetCognitoEventsRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
GetCognitoEventsResponseTypeDef#
# GetCognitoEventsResponseTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import GetCognitoEventsResponseTypeDef
def get_value() -> GetCognitoEventsResponseTypeDef:
return {
"Events": ...,
"ResponseMetadata": ...,
}
# GetCognitoEventsResponseTypeDef definition
class GetCognitoEventsResponseTypeDef(TypedDict):
Events: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetIdentityPoolConfigurationRequestRequestTypeDef#
# GetIdentityPoolConfigurationRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import GetIdentityPoolConfigurationRequestRequestTypeDef
def get_value() -> GetIdentityPoolConfigurationRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# GetIdentityPoolConfigurationRequestRequestTypeDef definition
class GetIdentityPoolConfigurationRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
PushSyncTypeDef#
# PushSyncTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import PushSyncTypeDef
def get_value() -> PushSyncTypeDef:
return {
"ApplicationArns": ...,
}
# PushSyncTypeDef definition
class PushSyncTypeDef(TypedDict):
ApplicationArns: NotRequired[List[str]],
RoleArn: NotRequired[str],
ListDatasetsRequestRequestTypeDef#
# ListDatasetsRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import ListDatasetsRequestRequestTypeDef
def get_value() -> ListDatasetsRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
"IdentityId": ...,
}
# ListDatasetsRequestRequestTypeDef definition
class ListDatasetsRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListIdentityPoolUsageRequestRequestTypeDef#
# ListIdentityPoolUsageRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import ListIdentityPoolUsageRequestRequestTypeDef
def get_value() -> ListIdentityPoolUsageRequestRequestTypeDef:
return {
"NextToken": ...,
}
# ListIdentityPoolUsageRequestRequestTypeDef definition
class ListIdentityPoolUsageRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListRecordsRequestRequestTypeDef#
# ListRecordsRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import ListRecordsRequestRequestTypeDef
def get_value() -> ListRecordsRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
"IdentityId": ...,
"DatasetName": ...,
}
# ListRecordsRequestRequestTypeDef definition
class ListRecordsRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
DatasetName: str,
LastSyncCount: NotRequired[int],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SyncSessionToken: NotRequired[str],
RecordTypeDef#
# RecordTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import RecordTypeDef
def get_value() -> RecordTypeDef:
return {
"Key": ...,
}
# RecordTypeDef definition
class RecordTypeDef(TypedDict):
Key: NotRequired[str],
Value: NotRequired[str],
SyncCount: NotRequired[int],
LastModifiedDate: NotRequired[datetime],
LastModifiedBy: NotRequired[str],
DeviceLastModifiedDate: NotRequired[datetime],
RecordPatchTypeDef#
# RecordPatchTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import RecordPatchTypeDef
def get_value() -> RecordPatchTypeDef:
return {
"Op": ...,
"Key": ...,
"SyncCount": ...,
}
# RecordPatchTypeDef definition
class RecordPatchTypeDef(TypedDict):
Op: OperationType, # (1)
Key: str,
SyncCount: int,
Value: NotRequired[str],
DeviceLastModifiedDate: NotRequired[Union[datetime, str]],
- See OperationType
RegisterDeviceRequestRequestTypeDef#
# RegisterDeviceRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import RegisterDeviceRequestRequestTypeDef
def get_value() -> RegisterDeviceRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
"IdentityId": ...,
"Platform": ...,
"Token": ...,
}
# RegisterDeviceRequestRequestTypeDef definition
class RegisterDeviceRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
Platform: PlatformType, # (1)
Token: str,
- See PlatformType
RegisterDeviceResponseTypeDef#
# RegisterDeviceResponseTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import RegisterDeviceResponseTypeDef
def get_value() -> RegisterDeviceResponseTypeDef:
return {
"DeviceId": ...,
"ResponseMetadata": ...,
}
# RegisterDeviceResponseTypeDef definition
class RegisterDeviceResponseTypeDef(TypedDict):
DeviceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
SetCognitoEventsRequestRequestTypeDef#
# SetCognitoEventsRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import SetCognitoEventsRequestRequestTypeDef
def get_value() -> SetCognitoEventsRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
"Events": ...,
}
# SetCognitoEventsRequestRequestTypeDef definition
class SetCognitoEventsRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
Events: Mapping[str, str],
SubscribeToDatasetRequestRequestTypeDef#
# SubscribeToDatasetRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import SubscribeToDatasetRequestRequestTypeDef
def get_value() -> SubscribeToDatasetRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
"IdentityId": ...,
"DatasetName": ...,
"DeviceId": ...,
}
# SubscribeToDatasetRequestRequestTypeDef definition
class SubscribeToDatasetRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
DatasetName: str,
DeviceId: str,
UnsubscribeFromDatasetRequestRequestTypeDef#
# UnsubscribeFromDatasetRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import UnsubscribeFromDatasetRequestRequestTypeDef
def get_value() -> UnsubscribeFromDatasetRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
"IdentityId": ...,
"DatasetName": ...,
"DeviceId": ...,
}
# UnsubscribeFromDatasetRequestRequestTypeDef definition
class UnsubscribeFromDatasetRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
DatasetName: str,
DeviceId: str,
DeleteDatasetResponseTypeDef#
# DeleteDatasetResponseTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import DeleteDatasetResponseTypeDef
def get_value() -> DeleteDatasetResponseTypeDef:
return {
"Dataset": ...,
"ResponseMetadata": ...,
}
# DeleteDatasetResponseTypeDef definition
class DeleteDatasetResponseTypeDef(TypedDict):
Dataset: DatasetTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeDatasetResponseTypeDef#
# DescribeDatasetResponseTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import DescribeDatasetResponseTypeDef
def get_value() -> DescribeDatasetResponseTypeDef:
return {
"Dataset": ...,
"ResponseMetadata": ...,
}
# DescribeDatasetResponseTypeDef definition
class DescribeDatasetResponseTypeDef(TypedDict):
Dataset: DatasetTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDatasetsResponseTypeDef#
# ListDatasetsResponseTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import ListDatasetsResponseTypeDef
def get_value() -> ListDatasetsResponseTypeDef:
return {
"Datasets": ...,
"Count": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListDatasetsResponseTypeDef definition
class ListDatasetsResponseTypeDef(TypedDict):
Datasets: List[DatasetTypeDef], # (1)
Count: int,
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeIdentityPoolUsageResponseTypeDef#
# DescribeIdentityPoolUsageResponseTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import DescribeIdentityPoolUsageResponseTypeDef
def get_value() -> DescribeIdentityPoolUsageResponseTypeDef:
return {
"IdentityPoolUsage": ...,
"ResponseMetadata": ...,
}
# DescribeIdentityPoolUsageResponseTypeDef definition
class DescribeIdentityPoolUsageResponseTypeDef(TypedDict):
IdentityPoolUsage: IdentityPoolUsageTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListIdentityPoolUsageResponseTypeDef#
# ListIdentityPoolUsageResponseTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import ListIdentityPoolUsageResponseTypeDef
def get_value() -> ListIdentityPoolUsageResponseTypeDef:
return {
"IdentityPoolUsages": ...,
"MaxResults": ...,
"Count": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListIdentityPoolUsageResponseTypeDef definition
class ListIdentityPoolUsageResponseTypeDef(TypedDict):
IdentityPoolUsages: List[IdentityPoolUsageTypeDef], # (1)
MaxResults: int,
Count: int,
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeIdentityUsageResponseTypeDef#
# DescribeIdentityUsageResponseTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import DescribeIdentityUsageResponseTypeDef
def get_value() -> DescribeIdentityUsageResponseTypeDef:
return {
"IdentityUsage": ...,
"ResponseMetadata": ...,
}
# DescribeIdentityUsageResponseTypeDef definition
class DescribeIdentityUsageResponseTypeDef(TypedDict):
IdentityUsage: IdentityUsageTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetIdentityPoolConfigurationResponseTypeDef#
# GetIdentityPoolConfigurationResponseTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import GetIdentityPoolConfigurationResponseTypeDef
def get_value() -> GetIdentityPoolConfigurationResponseTypeDef:
return {
"IdentityPoolId": ...,
"PushSync": ...,
"CognitoStreams": ...,
"ResponseMetadata": ...,
}
# GetIdentityPoolConfigurationResponseTypeDef definition
class GetIdentityPoolConfigurationResponseTypeDef(TypedDict):
IdentityPoolId: str,
PushSync: PushSyncTypeDef, # (1)
CognitoStreams: CognitoStreamsTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
SetIdentityPoolConfigurationRequestRequestTypeDef#
# SetIdentityPoolConfigurationRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import SetIdentityPoolConfigurationRequestRequestTypeDef
def get_value() -> SetIdentityPoolConfigurationRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# SetIdentityPoolConfigurationRequestRequestTypeDef definition
class SetIdentityPoolConfigurationRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
PushSync: NotRequired[PushSyncTypeDef], # (1)
CognitoStreams: NotRequired[CognitoStreamsTypeDef], # (2)
- See PushSyncTypeDef
- See CognitoStreamsTypeDef
SetIdentityPoolConfigurationResponseTypeDef#
# SetIdentityPoolConfigurationResponseTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import SetIdentityPoolConfigurationResponseTypeDef
def get_value() -> SetIdentityPoolConfigurationResponseTypeDef:
return {
"IdentityPoolId": ...,
"PushSync": ...,
"CognitoStreams": ...,
"ResponseMetadata": ...,
}
# SetIdentityPoolConfigurationResponseTypeDef definition
class SetIdentityPoolConfigurationResponseTypeDef(TypedDict):
IdentityPoolId: str,
PushSync: PushSyncTypeDef, # (1)
CognitoStreams: CognitoStreamsTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ListRecordsResponseTypeDef#
# ListRecordsResponseTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import ListRecordsResponseTypeDef
def get_value() -> ListRecordsResponseTypeDef:
return {
"Records": ...,
"NextToken": ...,
"Count": ...,
"DatasetSyncCount": ...,
"LastModifiedBy": ...,
"MergedDatasetNames": ...,
"DatasetExists": ...,
"DatasetDeletedAfterRequestedSyncCount": ...,
"SyncSessionToken": ...,
"ResponseMetadata": ...,
}
# ListRecordsResponseTypeDef definition
class ListRecordsResponseTypeDef(TypedDict):
Records: List[RecordTypeDef], # (1)
NextToken: str,
Count: int,
DatasetSyncCount: int,
LastModifiedBy: str,
MergedDatasetNames: List[str],
DatasetExists: bool,
DatasetDeletedAfterRequestedSyncCount: bool,
SyncSessionToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See RecordTypeDef
- See ResponseMetadataTypeDef
UpdateRecordsResponseTypeDef#
# UpdateRecordsResponseTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import UpdateRecordsResponseTypeDef
def get_value() -> UpdateRecordsResponseTypeDef:
return {
"Records": ...,
"ResponseMetadata": ...,
}
# UpdateRecordsResponseTypeDef definition
class UpdateRecordsResponseTypeDef(TypedDict):
Records: List[RecordTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See RecordTypeDef
- See ResponseMetadataTypeDef
UpdateRecordsRequestRequestTypeDef#
# UpdateRecordsRequestRequestTypeDef usage example
from mypy_boto3_cognito_sync.type_defs import UpdateRecordsRequestRequestTypeDef
def get_value() -> UpdateRecordsRequestRequestTypeDef:
return {
"IdentityPoolId": ...,
"IdentityId": ...,
"DatasetName": ...,
"SyncSessionToken": ...,
}
# UpdateRecordsRequestRequestTypeDef definition
class UpdateRecordsRequestRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
DatasetName: str,
SyncSessionToken: str,
DeviceId: NotRequired[str],
RecordPatches: NotRequired[Sequence[RecordPatchTypeDef]], # (1)
ClientContext: NotRequired[str],