Type definitions#
Index > CognitoSync > Type definitions
Auto-generated documentation for CognitoSync type annotations stubs module mypy-boto3-cognito-sync.
TimestampTypeDef#
# TimestampTypeDef Union usage example
from mypy_boto3_cognito_sync.type_defs import TimestampTypeDef
def get_value() -> TimestampTypeDef:
return ...
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime.datetime,
str,
]
PushSyncUnionTypeDef#
# PushSyncUnionTypeDef Union usage example
from mypy_boto3_cognito_sync.type_defs import PushSyncUnionTypeDef
def get_value() -> PushSyncUnionTypeDef:
return ...
# PushSyncUnionTypeDef definition
PushSyncUnionTypeDef = Union[
PushSyncTypeDef, # (1)
PushSyncOutputTypeDef, # (2)
]
- See PushSyncTypeDef
- See PushSyncOutputTypeDef
BulkPublishRequestTypeDef#
# BulkPublishRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import BulkPublishRequestTypeDef
def get_value() -> BulkPublishRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# BulkPublishRequestTypeDef definition
class BulkPublishRequestTypeDef(TypedDict):
IdentityPoolId: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
CognitoStreamsTypeDef#
# CognitoStreamsTypeDef TypedDict 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 TypedDict 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.datetime],
LastModifiedDate: NotRequired[datetime.datetime],
LastModifiedBy: NotRequired[str],
DataStorage: NotRequired[int],
NumRecords: NotRequired[int],
DeleteDatasetRequestTypeDef#
# DeleteDatasetRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import DeleteDatasetRequestTypeDef
def get_value() -> DeleteDatasetRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# DeleteDatasetRequestTypeDef definition
class DeleteDatasetRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
DatasetName: str,
DescribeDatasetRequestTypeDef#
# DescribeDatasetRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import DescribeDatasetRequestTypeDef
def get_value() -> DescribeDatasetRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# DescribeDatasetRequestTypeDef definition
class DescribeDatasetRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
DatasetName: str,
DescribeIdentityPoolUsageRequestTypeDef#
# DescribeIdentityPoolUsageRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import DescribeIdentityPoolUsageRequestTypeDef
def get_value() -> DescribeIdentityPoolUsageRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# DescribeIdentityPoolUsageRequestTypeDef definition
class DescribeIdentityPoolUsageRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityPoolUsageTypeDef#
# IdentityPoolUsageTypeDef TypedDict 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.datetime],
DescribeIdentityUsageRequestTypeDef#
# DescribeIdentityUsageRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import DescribeIdentityUsageRequestTypeDef
def get_value() -> DescribeIdentityUsageRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# DescribeIdentityUsageRequestTypeDef definition
class DescribeIdentityUsageRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
IdentityUsageTypeDef#
# IdentityUsageTypeDef TypedDict 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.datetime],
DatasetCount: NotRequired[int],
DataStorage: NotRequired[int],
GetBulkPublishDetailsRequestTypeDef#
# GetBulkPublishDetailsRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import GetBulkPublishDetailsRequestTypeDef
def get_value() -> GetBulkPublishDetailsRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# GetBulkPublishDetailsRequestTypeDef definition
class GetBulkPublishDetailsRequestTypeDef(TypedDict):
IdentityPoolId: str,
GetCognitoEventsRequestTypeDef#
# GetCognitoEventsRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import GetCognitoEventsRequestTypeDef
def get_value() -> GetCognitoEventsRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# GetCognitoEventsRequestTypeDef definition
class GetCognitoEventsRequestTypeDef(TypedDict):
IdentityPoolId: str,
GetIdentityPoolConfigurationRequestTypeDef#
# GetIdentityPoolConfigurationRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import GetIdentityPoolConfigurationRequestTypeDef
def get_value() -> GetIdentityPoolConfigurationRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# GetIdentityPoolConfigurationRequestTypeDef definition
class GetIdentityPoolConfigurationRequestTypeDef(TypedDict):
IdentityPoolId: str,
PushSyncOutputTypeDef#
# PushSyncOutputTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import PushSyncOutputTypeDef
def get_value() -> PushSyncOutputTypeDef:
return {
"ApplicationArns": ...,
}
# PushSyncOutputTypeDef definition
class PushSyncOutputTypeDef(TypedDict):
ApplicationArns: NotRequired[List[str]],
RoleArn: NotRequired[str],
ListDatasetsRequestTypeDef#
# ListDatasetsRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import ListDatasetsRequestTypeDef
def get_value() -> ListDatasetsRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# ListDatasetsRequestTypeDef definition
class ListDatasetsRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListIdentityPoolUsageRequestTypeDef#
# ListIdentityPoolUsageRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import ListIdentityPoolUsageRequestTypeDef
def get_value() -> ListIdentityPoolUsageRequestTypeDef:
return {
"NextToken": ...,
}
# ListIdentityPoolUsageRequestTypeDef definition
class ListIdentityPoolUsageRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListRecordsRequestTypeDef#
# ListRecordsRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import ListRecordsRequestTypeDef
def get_value() -> ListRecordsRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# ListRecordsRequestTypeDef definition
class ListRecordsRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
DatasetName: str,
LastSyncCount: NotRequired[int],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SyncSessionToken: NotRequired[str],
RecordTypeDef#
# RecordTypeDef TypedDict 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.datetime],
LastModifiedBy: NotRequired[str],
DeviceLastModifiedDate: NotRequired[datetime.datetime],
PushSyncTypeDef#
# PushSyncTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import PushSyncTypeDef
def get_value() -> PushSyncTypeDef:
return {
"ApplicationArns": ...,
}
# PushSyncTypeDef definition
class PushSyncTypeDef(TypedDict):
ApplicationArns: NotRequired[Sequence[str]],
RoleArn: NotRequired[str],
RegisterDeviceRequestTypeDef#
# RegisterDeviceRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import RegisterDeviceRequestTypeDef
def get_value() -> RegisterDeviceRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# RegisterDeviceRequestTypeDef definition
class RegisterDeviceRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
Platform: PlatformType, # (1)
Token: str,
- See PlatformType
SetCognitoEventsRequestTypeDef#
# SetCognitoEventsRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import SetCognitoEventsRequestTypeDef
def get_value() -> SetCognitoEventsRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# SetCognitoEventsRequestTypeDef definition
class SetCognitoEventsRequestTypeDef(TypedDict):
IdentityPoolId: str,
Events: Mapping[str, str],
SubscribeToDatasetRequestTypeDef#
# SubscribeToDatasetRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import SubscribeToDatasetRequestTypeDef
def get_value() -> SubscribeToDatasetRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# SubscribeToDatasetRequestTypeDef definition
class SubscribeToDatasetRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
DatasetName: str,
DeviceId: str,
UnsubscribeFromDatasetRequestTypeDef#
# UnsubscribeFromDatasetRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import UnsubscribeFromDatasetRequestTypeDef
def get_value() -> UnsubscribeFromDatasetRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# UnsubscribeFromDatasetRequestTypeDef definition
class UnsubscribeFromDatasetRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
DatasetName: str,
DeviceId: str,
BulkPublishResponseTypeDef#
# BulkPublishResponseTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import BulkPublishResponseTypeDef
def get_value() -> BulkPublishResponseTypeDef:
return {
"IdentityPoolId": ...,
}
# BulkPublishResponseTypeDef definition
class BulkPublishResponseTypeDef(TypedDict):
IdentityPoolId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef TypedDict 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)
GetBulkPublishDetailsResponseTypeDef#
# GetBulkPublishDetailsResponseTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import GetBulkPublishDetailsResponseTypeDef
def get_value() -> GetBulkPublishDetailsResponseTypeDef:
return {
"IdentityPoolId": ...,
}
# GetBulkPublishDetailsResponseTypeDef definition
class GetBulkPublishDetailsResponseTypeDef(TypedDict):
IdentityPoolId: str,
BulkPublishStartTime: datetime.datetime,
BulkPublishCompleteTime: datetime.datetime,
BulkPublishStatus: BulkPublishStatusType, # (1)
FailureMessage: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetCognitoEventsResponseTypeDef#
# GetCognitoEventsResponseTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import GetCognitoEventsResponseTypeDef
def get_value() -> GetCognitoEventsResponseTypeDef:
return {
"Events": ...,
}
# GetCognitoEventsResponseTypeDef definition
class GetCognitoEventsResponseTypeDef(TypedDict):
Events: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RegisterDeviceResponseTypeDef#
# RegisterDeviceResponseTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import RegisterDeviceResponseTypeDef
def get_value() -> RegisterDeviceResponseTypeDef:
return {
"DeviceId": ...,
}
# RegisterDeviceResponseTypeDef definition
class RegisterDeviceResponseTypeDef(TypedDict):
DeviceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteDatasetResponseTypeDef#
# DeleteDatasetResponseTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import DeleteDatasetResponseTypeDef
def get_value() -> DeleteDatasetResponseTypeDef:
return {
"Dataset": ...,
}
# DeleteDatasetResponseTypeDef definition
class DeleteDatasetResponseTypeDef(TypedDict):
Dataset: DatasetTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeDatasetResponseTypeDef#
# DescribeDatasetResponseTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import DescribeDatasetResponseTypeDef
def get_value() -> DescribeDatasetResponseTypeDef:
return {
"Dataset": ...,
}
# DescribeDatasetResponseTypeDef definition
class DescribeDatasetResponseTypeDef(TypedDict):
Dataset: DatasetTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDatasetsResponseTypeDef#
# ListDatasetsResponseTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import ListDatasetsResponseTypeDef
def get_value() -> ListDatasetsResponseTypeDef:
return {
"Datasets": ...,
}
# ListDatasetsResponseTypeDef definition
class ListDatasetsResponseTypeDef(TypedDict):
Datasets: List[DatasetTypeDef], # (1)
Count: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See
List[DatasetTypeDef]
- See ResponseMetadataTypeDef
DescribeIdentityPoolUsageResponseTypeDef#
# DescribeIdentityPoolUsageResponseTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import DescribeIdentityPoolUsageResponseTypeDef
def get_value() -> DescribeIdentityPoolUsageResponseTypeDef:
return {
"IdentityPoolUsage": ...,
}
# DescribeIdentityPoolUsageResponseTypeDef definition
class DescribeIdentityPoolUsageResponseTypeDef(TypedDict):
IdentityPoolUsage: IdentityPoolUsageTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListIdentityPoolUsageResponseTypeDef#
# ListIdentityPoolUsageResponseTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import ListIdentityPoolUsageResponseTypeDef
def get_value() -> ListIdentityPoolUsageResponseTypeDef:
return {
"IdentityPoolUsages": ...,
}
# ListIdentityPoolUsageResponseTypeDef definition
class ListIdentityPoolUsageResponseTypeDef(TypedDict):
IdentityPoolUsages: List[IdentityPoolUsageTypeDef], # (1)
MaxResults: int,
Count: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See
List[IdentityPoolUsageTypeDef]
- See ResponseMetadataTypeDef
DescribeIdentityUsageResponseTypeDef#
# DescribeIdentityUsageResponseTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import DescribeIdentityUsageResponseTypeDef
def get_value() -> DescribeIdentityUsageResponseTypeDef:
return {
"IdentityUsage": ...,
}
# DescribeIdentityUsageResponseTypeDef definition
class DescribeIdentityUsageResponseTypeDef(TypedDict):
IdentityUsage: IdentityUsageTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetIdentityPoolConfigurationResponseTypeDef#
# GetIdentityPoolConfigurationResponseTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import GetIdentityPoolConfigurationResponseTypeDef
def get_value() -> GetIdentityPoolConfigurationResponseTypeDef:
return {
"IdentityPoolId": ...,
}
# GetIdentityPoolConfigurationResponseTypeDef definition
class GetIdentityPoolConfigurationResponseTypeDef(TypedDict):
IdentityPoolId: str,
PushSync: PushSyncOutputTypeDef, # (1)
CognitoStreams: CognitoStreamsTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
SetIdentityPoolConfigurationResponseTypeDef#
# SetIdentityPoolConfigurationResponseTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import SetIdentityPoolConfigurationResponseTypeDef
def get_value() -> SetIdentityPoolConfigurationResponseTypeDef:
return {
"IdentityPoolId": ...,
}
# SetIdentityPoolConfigurationResponseTypeDef definition
class SetIdentityPoolConfigurationResponseTypeDef(TypedDict):
IdentityPoolId: str,
PushSync: PushSyncOutputTypeDef, # (1)
CognitoStreams: CognitoStreamsTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ListRecordsResponseTypeDef#
# ListRecordsResponseTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import ListRecordsResponseTypeDef
def get_value() -> ListRecordsResponseTypeDef:
return {
"Records": ...,
}
# ListRecordsResponseTypeDef definition
class ListRecordsResponseTypeDef(TypedDict):
Records: List[RecordTypeDef], # (1)
Count: int,
DatasetSyncCount: int,
LastModifiedBy: str,
MergedDatasetNames: List[str],
DatasetExists: bool,
DatasetDeletedAfterRequestedSyncCount: bool,
SyncSessionToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See
List[RecordTypeDef]
- See ResponseMetadataTypeDef
UpdateRecordsResponseTypeDef#
# UpdateRecordsResponseTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import UpdateRecordsResponseTypeDef
def get_value() -> UpdateRecordsResponseTypeDef:
return {
"Records": ...,
}
# UpdateRecordsResponseTypeDef definition
class UpdateRecordsResponseTypeDef(TypedDict):
Records: List[RecordTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See
List[RecordTypeDef]
- See ResponseMetadataTypeDef
RecordPatchTypeDef#
# RecordPatchTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import RecordPatchTypeDef
def get_value() -> RecordPatchTypeDef:
return {
"Op": ...,
}
# RecordPatchTypeDef definition
class RecordPatchTypeDef(TypedDict):
Op: OperationType, # (1)
Key: str,
SyncCount: int,
Value: NotRequired[str],
DeviceLastModifiedDate: NotRequired[TimestampTypeDef],
- See OperationType
SetIdentityPoolConfigurationRequestTypeDef#
# SetIdentityPoolConfigurationRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import SetIdentityPoolConfigurationRequestTypeDef
def get_value() -> SetIdentityPoolConfigurationRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# SetIdentityPoolConfigurationRequestTypeDef definition
class SetIdentityPoolConfigurationRequestTypeDef(TypedDict):
IdentityPoolId: str,
PushSync: NotRequired[PushSyncUnionTypeDef], # (1)
CognitoStreams: NotRequired[CognitoStreamsTypeDef], # (2)
UpdateRecordsRequestTypeDef#
# UpdateRecordsRequestTypeDef TypedDict usage example
from mypy_boto3_cognito_sync.type_defs import UpdateRecordsRequestTypeDef
def get_value() -> UpdateRecordsRequestTypeDef:
return {
"IdentityPoolId": ...,
}
# UpdateRecordsRequestTypeDef definition
class UpdateRecordsRequestTypeDef(TypedDict):
IdentityPoolId: str,
IdentityId: str,
DatasetName: str,
SyncSessionToken: str,
DeviceId: NotRequired[str],
RecordPatches: NotRequired[Sequence[RecordPatchTypeDef]], # (1)
ClientContext: NotRequired[str],
- See
Sequence[RecordPatchTypeDef]