Type definitions

Index > CognitoSync > Type definitions

Auto-generated documentation for CognitoSync type annotations stubs module mypy-boto3-cognito-sync.

TimestampTypeDef

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

BulkPublishRequestRequestTypeDef

# BulkPublishRequestRequestTypeDef definition

class BulkPublishRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,

ResponseMetadataTypeDef

# ResponseMetadataTypeDef definition

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

CognitoStreamsTypeDef

# CognitoStreamsTypeDef definition

class CognitoStreamsTypeDef(TypedDict):
    StreamName: NotRequired[str],
    RoleArn: NotRequired[str],
    StreamingStatus: NotRequired[StreamingStatusType],  # (1)

1. See StreamingStatusType

DatasetTypeDef

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

class DeleteDatasetRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityId: str,
    DatasetName: str,

DescribeDatasetRequestRequestTypeDef

# DescribeDatasetRequestRequestTypeDef definition

class DescribeDatasetRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityId: str,
    DatasetName: str,

DescribeIdentityPoolUsageRequestRequestTypeDef

# DescribeIdentityPoolUsageRequestRequestTypeDef definition

class DescribeIdentityPoolUsageRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,

IdentityPoolUsageTypeDef

# IdentityPoolUsageTypeDef definition

class IdentityPoolUsageTypeDef(TypedDict):
    IdentityPoolId: NotRequired[str],
    SyncSessionsCount: NotRequired[int],
    DataStorage: NotRequired[int],
    LastModifiedDate: NotRequired[datetime],

DescribeIdentityUsageRequestRequestTypeDef

# DescribeIdentityUsageRequestRequestTypeDef definition

class DescribeIdentityUsageRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityId: str,

IdentityUsageTypeDef

# IdentityUsageTypeDef definition

class IdentityUsageTypeDef(TypedDict):
    IdentityId: NotRequired[str],
    IdentityPoolId: NotRequired[str],
    LastModifiedDate: NotRequired[datetime],
    DatasetCount: NotRequired[int],
    DataStorage: NotRequired[int],

GetBulkPublishDetailsRequestRequestTypeDef

# GetBulkPublishDetailsRequestRequestTypeDef definition

class GetBulkPublishDetailsRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,

GetCognitoEventsRequestRequestTypeDef

# GetCognitoEventsRequestRequestTypeDef definition

class GetCognitoEventsRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,

GetIdentityPoolConfigurationRequestRequestTypeDef

# GetIdentityPoolConfigurationRequestRequestTypeDef definition

class GetIdentityPoolConfigurationRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,

PushSyncTypeDef

# PushSyncTypeDef definition

class PushSyncTypeDef(TypedDict):
    ApplicationArns: NotRequired[List[str]],
    RoleArn: NotRequired[str],

ListDatasetsRequestRequestTypeDef

# ListDatasetsRequestRequestTypeDef definition

class ListDatasetsRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListIdentityPoolUsageRequestRequestTypeDef

# ListIdentityPoolUsageRequestRequestTypeDef definition

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

ListRecordsRequestRequestTypeDef

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

class RecordTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],
    SyncCount: NotRequired[int],
    LastModifiedDate: NotRequired[datetime],
    LastModifiedBy: NotRequired[str],
    DeviceLastModifiedDate: NotRequired[datetime],

RegisterDeviceRequestRequestTypeDef

# RegisterDeviceRequestRequestTypeDef definition

class RegisterDeviceRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityId: str,
    Platform: PlatformType,  # (1)
    Token: str,

1. See PlatformType

SetCognitoEventsRequestRequestTypeDef

# SetCognitoEventsRequestRequestTypeDef definition

class SetCognitoEventsRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    Events: Mapping[str, str],

SubscribeToDatasetRequestRequestTypeDef

# SubscribeToDatasetRequestRequestTypeDef definition

class SubscribeToDatasetRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityId: str,
    DatasetName: str,
    DeviceId: str,

UnsubscribeFromDatasetRequestRequestTypeDef

# UnsubscribeFromDatasetRequestRequestTypeDef definition

class UnsubscribeFromDatasetRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityId: str,
    DatasetName: str,
    DeviceId: str,

BulkPublishResponseTypeDef

# BulkPublishResponseTypeDef definition

class BulkPublishResponseTypeDef(TypedDict):
    IdentityPoolId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetBulkPublishDetailsResponseTypeDef

# GetBulkPublishDetailsResponseTypeDef definition

class GetBulkPublishDetailsResponseTypeDef(TypedDict):
    IdentityPoolId: str,
    BulkPublishStartTime: datetime,
    BulkPublishCompleteTime: datetime,
    BulkPublishStatus: BulkPublishStatusType,  # (1)
    FailureMessage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See BulkPublishStatusType
2. See ResponseMetadataTypeDef

GetCognitoEventsResponseTypeDef

# GetCognitoEventsResponseTypeDef definition

class GetCognitoEventsResponseTypeDef(TypedDict):
    Events: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

RegisterDeviceResponseTypeDef

# RegisterDeviceResponseTypeDef definition

class RegisterDeviceResponseTypeDef(TypedDict):
    DeviceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

DeleteDatasetResponseTypeDef

# DeleteDatasetResponseTypeDef definition

class DeleteDatasetResponseTypeDef(TypedDict):
    Dataset: DatasetTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DatasetTypeDef
2. See ResponseMetadataTypeDef

DescribeDatasetResponseTypeDef

# DescribeDatasetResponseTypeDef definition

class DescribeDatasetResponseTypeDef(TypedDict):
    Dataset: DatasetTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DatasetTypeDef
2. See ResponseMetadataTypeDef

ListDatasetsResponseTypeDef

# ListDatasetsResponseTypeDef definition

class ListDatasetsResponseTypeDef(TypedDict):
    Datasets: List[DatasetTypeDef],  # (1)
    Count: int,
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DatasetTypeDef
2. See ResponseMetadataTypeDef

DescribeIdentityPoolUsageResponseTypeDef

# DescribeIdentityPoolUsageResponseTypeDef definition

class DescribeIdentityPoolUsageResponseTypeDef(TypedDict):
    IdentityPoolUsage: IdentityPoolUsageTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See IdentityPoolUsageTypeDef
2. See ResponseMetadataTypeDef

ListIdentityPoolUsageResponseTypeDef

# ListIdentityPoolUsageResponseTypeDef definition

class ListIdentityPoolUsageResponseTypeDef(TypedDict):
    IdentityPoolUsages: List[IdentityPoolUsageTypeDef],  # (1)
    MaxResults: int,
    Count: int,
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See IdentityPoolUsageTypeDef
2. See ResponseMetadataTypeDef

DescribeIdentityUsageResponseTypeDef

# DescribeIdentityUsageResponseTypeDef definition

class DescribeIdentityUsageResponseTypeDef(TypedDict):
    IdentityUsage: IdentityUsageTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See IdentityUsageTypeDef
2. See ResponseMetadataTypeDef

GetIdentityPoolConfigurationResponseTypeDef

# GetIdentityPoolConfigurationResponseTypeDef definition

class GetIdentityPoolConfigurationResponseTypeDef(TypedDict):
    IdentityPoolId: str,
    PushSync: PushSyncTypeDef,  # (1)
    CognitoStreams: CognitoStreamsTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See PushSyncTypeDef
2. See CognitoStreamsTypeDef
3. See ResponseMetadataTypeDef

SetIdentityPoolConfigurationRequestRequestTypeDef

# SetIdentityPoolConfigurationRequestRequestTypeDef definition

class SetIdentityPoolConfigurationRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    PushSync: NotRequired[PushSyncTypeDef],  # (1)
    CognitoStreams: NotRequired[CognitoStreamsTypeDef],  # (2)

1. See PushSyncTypeDef
2. See CognitoStreamsTypeDef

SetIdentityPoolConfigurationResponseTypeDef

# SetIdentityPoolConfigurationResponseTypeDef definition

class SetIdentityPoolConfigurationResponseTypeDef(TypedDict):
    IdentityPoolId: str,
    PushSync: PushSyncTypeDef,  # (1)
    CognitoStreams: CognitoStreamsTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See PushSyncTypeDef
2. See CognitoStreamsTypeDef
3. See ResponseMetadataTypeDef

ListRecordsResponseTypeDef

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

1. See RecordTypeDef
2. See ResponseMetadataTypeDef

UpdateRecordsResponseTypeDef

# UpdateRecordsResponseTypeDef definition

class UpdateRecordsResponseTypeDef(TypedDict):
    Records: List[RecordTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RecordTypeDef
2. See ResponseMetadataTypeDef

RecordPatchTypeDef

# RecordPatchTypeDef definition

class RecordPatchTypeDef(TypedDict):
    Op: OperationType,  # (1)
    Key: str,
    SyncCount: int,
    Value: NotRequired[str],
    DeviceLastModifiedDate: NotRequired[Union[datetime, str]],

1. See OperationType

UpdateRecordsRequestRequestTypeDef

# UpdateRecordsRequestRequestTypeDef definition

class UpdateRecordsRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityId: str,
    DatasetName: str,
    SyncSessionToken: str,
    DeviceId: NotRequired[str],
    RecordPatches: NotRequired[Sequence[RecordPatchTypeDef]],  # (1)
    ClientContext: NotRequired[str],

1. See RecordPatchTypeDef