Typed dictionaries

Index > CognitoSync > Typed dictionaries

Auto-generated documentation for CognitoSync type annotations stubs module types-aiobotocore-cognito-sync.

BulkPublishRequestRequestTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import BulkPublishRequestRequestTypeDef

def get_value() -> BulkPublishRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }

Definition

class BulkPublishRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,

ResponseMetadataTypeDef

Usage Example

from types_aiobotocore_cognito_sync.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,

CognitoStreamsTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import CognitoStreamsTypeDef

def get_value() -> CognitoStreamsTypeDef:
    return {
        "StreamName": ...,
    }

Definition

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

1. See StreamingStatusType

DatasetTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import DatasetTypeDef

def get_value() -> DatasetTypeDef:
    return {
        "IdentityId": ...,
    }

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

Usage Example

from types_aiobotocore_cognito_sync.type_defs import DeleteDatasetRequestRequestTypeDef

def get_value() -> DeleteDatasetRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityId": ...,
        "DatasetName": ...,
    }

Definition

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

DescribeDatasetRequestRequestTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import DescribeDatasetRequestRequestTypeDef

def get_value() -> DescribeDatasetRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityId": ...,
        "DatasetName": ...,
    }

Definition

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

DescribeIdentityPoolUsageRequestRequestTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import DescribeIdentityPoolUsageRequestRequestTypeDef

def get_value() -> DescribeIdentityPoolUsageRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }

Definition

class DescribeIdentityPoolUsageRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,

IdentityPoolUsageTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import IdentityPoolUsageTypeDef

def get_value() -> IdentityPoolUsageTypeDef:
    return {
        "IdentityPoolId": ...,
    }

Definition

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

DescribeIdentityUsageRequestRequestTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import DescribeIdentityUsageRequestRequestTypeDef

def get_value() -> DescribeIdentityUsageRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityId": ...,
    }

Definition

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

IdentityUsageTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import IdentityUsageTypeDef

def get_value() -> IdentityUsageTypeDef:
    return {
        "IdentityId": ...,
    }

Definition

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

GetBulkPublishDetailsRequestRequestTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import GetBulkPublishDetailsRequestRequestTypeDef

def get_value() -> GetBulkPublishDetailsRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }

Definition

class GetBulkPublishDetailsRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,

GetCognitoEventsRequestRequestTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import GetCognitoEventsRequestRequestTypeDef

def get_value() -> GetCognitoEventsRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }

Definition

class GetCognitoEventsRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,

GetIdentityPoolConfigurationRequestRequestTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import GetIdentityPoolConfigurationRequestRequestTypeDef

def get_value() -> GetIdentityPoolConfigurationRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }

Definition

class GetIdentityPoolConfigurationRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,

PushSyncTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import PushSyncTypeDef

def get_value() -> PushSyncTypeDef:
    return {
        "ApplicationArns": ...,
    }

Definition

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

ListDatasetsRequestRequestTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import ListDatasetsRequestRequestTypeDef

def get_value() -> ListDatasetsRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityId": ...,
    }

Definition

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

ListIdentityPoolUsageRequestRequestTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import ListIdentityPoolUsageRequestRequestTypeDef

def get_value() -> ListIdentityPoolUsageRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }

Definition

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

ListRecordsRequestRequestTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import ListRecordsRequestRequestTypeDef

def get_value() -> ListRecordsRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityId": ...,
        "DatasetName": ...,
    }

Definition

class ListRecordsRequestRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityId: str,
    DatasetName: str,
    LastSyncCount: NotRequired[int],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    SyncSessionToken: NotRequired[str],

RecordTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import RecordTypeDef

def get_value() -> RecordTypeDef:
    return {
        "Key": ...,
    }

Definition

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

RecordPatchTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import RecordPatchTypeDef

def get_value() -> RecordPatchTypeDef:
    return {
        "Op": ...,
        "Key": ...,
        "SyncCount": ...,
    }

Definition

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

1. See OperationType

RegisterDeviceRequestRequestTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import RegisterDeviceRequestRequestTypeDef

def get_value() -> RegisterDeviceRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityId": ...,
        "Platform": ...,
        "Token": ...,
    }

Definition

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

1. See PlatformType

SetCognitoEventsRequestRequestTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import SetCognitoEventsRequestRequestTypeDef

def get_value() -> SetCognitoEventsRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "Events": ...,
    }

Definition

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

SubscribeToDatasetRequestRequestTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import SubscribeToDatasetRequestRequestTypeDef

def get_value() -> SubscribeToDatasetRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityId": ...,
        "DatasetName": ...,
        "DeviceId": ...,
    }

Definition

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

UnsubscribeFromDatasetRequestRequestTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import UnsubscribeFromDatasetRequestRequestTypeDef

def get_value() -> UnsubscribeFromDatasetRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityId": ...,
        "DatasetName": ...,
        "DeviceId": ...,
    }

Definition

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

BulkPublishResponseTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import BulkPublishResponseTypeDef

def get_value() -> BulkPublishResponseTypeDef:
    return {
        "IdentityPoolId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

GetBulkPublishDetailsResponseTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import GetBulkPublishDetailsResponseTypeDef

def get_value() -> GetBulkPublishDetailsResponseTypeDef:
    return {
        "IdentityPoolId": ...,
        "BulkPublishStartTime": ...,
        "BulkPublishCompleteTime": ...,
        "BulkPublishStatus": ...,
        "FailureMessage": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from types_aiobotocore_cognito_sync.type_defs import GetCognitoEventsResponseTypeDef

def get_value() -> GetCognitoEventsResponseTypeDef:
    return {
        "Events": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

RegisterDeviceResponseTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import RegisterDeviceResponseTypeDef

def get_value() -> RegisterDeviceResponseTypeDef:
    return {
        "DeviceId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

DeleteDatasetResponseTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import DeleteDatasetResponseTypeDef

def get_value() -> DeleteDatasetResponseTypeDef:
    return {
        "Dataset": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See DatasetTypeDef
2. See ResponseMetadataTypeDef

DescribeDatasetResponseTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import DescribeDatasetResponseTypeDef

def get_value() -> DescribeDatasetResponseTypeDef:
    return {
        "Dataset": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See DatasetTypeDef
2. See ResponseMetadataTypeDef

ListDatasetsResponseTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import ListDatasetsResponseTypeDef

def get_value() -> ListDatasetsResponseTypeDef:
    return {
        "Datasets": ...,
        "Count": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See DatasetTypeDef
2. See ResponseMetadataTypeDef

DescribeIdentityPoolUsageResponseTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import DescribeIdentityPoolUsageResponseTypeDef

def get_value() -> DescribeIdentityPoolUsageResponseTypeDef:
    return {
        "IdentityPoolUsage": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See IdentityPoolUsageTypeDef
2. See ResponseMetadataTypeDef

ListIdentityPoolUsageResponseTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import ListIdentityPoolUsageResponseTypeDef

def get_value() -> ListIdentityPoolUsageResponseTypeDef:
    return {
        "IdentityPoolUsages": ...,
        "MaxResults": ...,
        "Count": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See IdentityPoolUsageTypeDef
2. See ResponseMetadataTypeDef

DescribeIdentityUsageResponseTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import DescribeIdentityUsageResponseTypeDef

def get_value() -> DescribeIdentityUsageResponseTypeDef:
    return {
        "IdentityUsage": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See IdentityUsageTypeDef
2. See ResponseMetadataTypeDef

GetIdentityPoolConfigurationResponseTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import GetIdentityPoolConfigurationResponseTypeDef

def get_value() -> GetIdentityPoolConfigurationResponseTypeDef:
    return {
        "IdentityPoolId": ...,
        "PushSync": ...,
        "CognitoStreams": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from types_aiobotocore_cognito_sync.type_defs import SetIdentityPoolConfigurationRequestRequestTypeDef

def get_value() -> SetIdentityPoolConfigurationRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }

Definition

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

1. See PushSyncTypeDef
2. See CognitoStreamsTypeDef

SetIdentityPoolConfigurationResponseTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import SetIdentityPoolConfigurationResponseTypeDef

def get_value() -> SetIdentityPoolConfigurationResponseTypeDef:
    return {
        "IdentityPoolId": ...,
        "PushSync": ...,
        "CognitoStreams": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from types_aiobotocore_cognito_sync.type_defs import ListRecordsResponseTypeDef

def get_value() -> ListRecordsResponseTypeDef:
    return {
        "Records": ...,
        "NextToken": ...,
        "Count": ...,
        "DatasetSyncCount": ...,
        "LastModifiedBy": ...,
        "MergedDatasetNames": ...,
        "DatasetExists": ...,
        "DatasetDeletedAfterRequestedSyncCount": ...,
        "SyncSessionToken": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from types_aiobotocore_cognito_sync.type_defs import UpdateRecordsResponseTypeDef

def get_value() -> UpdateRecordsResponseTypeDef:
    return {
        "Records": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See RecordTypeDef
2. See ResponseMetadataTypeDef

UpdateRecordsRequestRequestTypeDef

Usage Example

from types_aiobotocore_cognito_sync.type_defs import UpdateRecordsRequestRequestTypeDef

def get_value() -> UpdateRecordsRequestRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityId": ...,
        "DatasetName": ...,
        "SyncSessionToken": ...,
    }

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