Skip to content

Type definitions#

Index > Keyspaces > Type definitions

Auto-generated documentation for Keyspaces type annotations stubs module types-boto3-keyspaces.

TimestampTypeDef#

# TimestampTypeDef Union usage example

from types_boto3_keyspaces.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

SchemaDefinitionUnionTypeDef#

# SchemaDefinitionUnionTypeDef Union usage example

from types_boto3_keyspaces.type_defs import SchemaDefinitionUnionTypeDef


def get_value() -> SchemaDefinitionUnionTypeDef:
    return ...


# SchemaDefinitionUnionTypeDef definition

SchemaDefinitionUnionTypeDef = Union[
    SchemaDefinitionTypeDef,  # (1)
    SchemaDefinitionOutputTypeDef,  # (2)
]
  1. See SchemaDefinitionTypeDef
  2. See SchemaDefinitionOutputTypeDef

TargetTrackingScalingPolicyConfigurationTypeDef#

# TargetTrackingScalingPolicyConfigurationTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import TargetTrackingScalingPolicyConfigurationTypeDef


def get_value() -> TargetTrackingScalingPolicyConfigurationTypeDef:
    return {
        "disableScaleIn": ...,
    }


# TargetTrackingScalingPolicyConfigurationTypeDef definition

class TargetTrackingScalingPolicyConfigurationTypeDef(TypedDict):
    targetValue: float,
    disableScaleIn: NotRequired[bool],
    scaleInCooldown: NotRequired[int],
    scaleOutCooldown: NotRequired[int],

CapacitySpecificationSummaryTypeDef#

# CapacitySpecificationSummaryTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import CapacitySpecificationSummaryTypeDef


def get_value() -> CapacitySpecificationSummaryTypeDef:
    return {
        "throughputMode": ...,
    }


# CapacitySpecificationSummaryTypeDef definition

class CapacitySpecificationSummaryTypeDef(TypedDict):
    throughputMode: ThroughputModeType,  # (1)
    readCapacityUnits: NotRequired[int],
    writeCapacityUnits: NotRequired[int],
    lastUpdateToPayPerRequestTimestamp: NotRequired[datetime.datetime],
  1. See ThroughputModeType

CapacitySpecificationTypeDef#

# CapacitySpecificationTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import CapacitySpecificationTypeDef


def get_value() -> CapacitySpecificationTypeDef:
    return {
        "throughputMode": ...,
    }


# CapacitySpecificationTypeDef definition

class CapacitySpecificationTypeDef(TypedDict):
    throughputMode: ThroughputModeType,  # (1)
    readCapacityUnits: NotRequired[int],
    writeCapacityUnits: NotRequired[int],
  1. See ThroughputModeType

CdcSpecificationSummaryTypeDef#

# CdcSpecificationSummaryTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import CdcSpecificationSummaryTypeDef


def get_value() -> CdcSpecificationSummaryTypeDef:
    return {
        "status": ...,
    }


# CdcSpecificationSummaryTypeDef definition

class CdcSpecificationSummaryTypeDef(TypedDict):
    status: CdcStatusType,  # (1)
    viewType: NotRequired[ViewTypeType],  # (2)
  1. See CdcStatusType
  2. See ViewTypeType

TagTypeDef#

# TagTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import TagTypeDef


def get_value() -> TagTypeDef:
    return {
        "key": ...,
    }


# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: str,

ClientSideTimestampsTypeDef#

# ClientSideTimestampsTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ClientSideTimestampsTypeDef


def get_value() -> ClientSideTimestampsTypeDef:
    return {
        "status": ...,
    }


# ClientSideTimestampsTypeDef definition

class ClientSideTimestampsTypeDef(TypedDict):
    status: ClientSideTimestampsStatusType,  # (1)
  1. See ClientSideTimestampsStatusType

ClusteringKeyTypeDef#

# ClusteringKeyTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ClusteringKeyTypeDef


def get_value() -> ClusteringKeyTypeDef:
    return {
        "name": ...,
    }


# ClusteringKeyTypeDef definition

class ClusteringKeyTypeDef(TypedDict):
    name: str,
    orderBy: SortOrderType,  # (1)
  1. See SortOrderType

ColumnDefinitionTypeDef#

# ColumnDefinitionTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ColumnDefinitionTypeDef


def get_value() -> ColumnDefinitionTypeDef:
    return {
        "name": ...,
    }


# ColumnDefinitionTypeDef definition

class ColumnDefinitionTypeDef(TypedDict):
    name: str,
    type: str,

CommentTypeDef#

# CommentTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import CommentTypeDef


def get_value() -> CommentTypeDef:
    return {
        "message": ...,
    }


# CommentTypeDef definition

class CommentTypeDef(TypedDict):
    message: str,

ReplicationSpecificationTypeDef#

# ReplicationSpecificationTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ReplicationSpecificationTypeDef


def get_value() -> ReplicationSpecificationTypeDef:
    return {
        "replicationStrategy": ...,
    }


# ReplicationSpecificationTypeDef definition

class ReplicationSpecificationTypeDef(TypedDict):
    replicationStrategy: RsType,  # (1)
    regionList: NotRequired[Sequence[str]],
  1. See RsType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_keyspaces.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],

EncryptionSpecificationTypeDef#

# EncryptionSpecificationTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import EncryptionSpecificationTypeDef


def get_value() -> EncryptionSpecificationTypeDef:
    return {
        "type": ...,
    }


# EncryptionSpecificationTypeDef definition

class EncryptionSpecificationTypeDef(TypedDict):
    type: EncryptionTypeType,  # (1)
    kmsKeyIdentifier: NotRequired[str],
  1. See EncryptionTypeType

PointInTimeRecoveryTypeDef#

# PointInTimeRecoveryTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import PointInTimeRecoveryTypeDef


def get_value() -> PointInTimeRecoveryTypeDef:
    return {
        "status": ...,
    }


# PointInTimeRecoveryTypeDef definition

class PointInTimeRecoveryTypeDef(TypedDict):
    status: PointInTimeRecoveryStatusType,  # (1)
  1. See PointInTimeRecoveryStatusType

TimeToLiveTypeDef#

# TimeToLiveTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import TimeToLiveTypeDef


def get_value() -> TimeToLiveTypeDef:
    return {
        "status": ...,
    }


# TimeToLiveTypeDef definition

class TimeToLiveTypeDef(TypedDict):
    status: TimeToLiveStatusType,  # (1)
  1. See TimeToLiveStatusType

FieldDefinitionTypeDef#

# FieldDefinitionTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import FieldDefinitionTypeDef


def get_value() -> FieldDefinitionTypeDef:
    return {
        "name": ...,
    }


# FieldDefinitionTypeDef definition

class FieldDefinitionTypeDef(TypedDict):
    name: str,
    type: str,

DeleteKeyspaceRequestTypeDef#

# DeleteKeyspaceRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import DeleteKeyspaceRequestTypeDef


def get_value() -> DeleteKeyspaceRequestTypeDef:
    return {
        "keyspaceName": ...,
    }


# DeleteKeyspaceRequestTypeDef definition

class DeleteKeyspaceRequestTypeDef(TypedDict):
    keyspaceName: str,

DeleteTableRequestTypeDef#

# DeleteTableRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import DeleteTableRequestTypeDef


def get_value() -> DeleteTableRequestTypeDef:
    return {
        "keyspaceName": ...,
    }


# DeleteTableRequestTypeDef definition

class DeleteTableRequestTypeDef(TypedDict):
    keyspaceName: str,
    tableName: str,

DeleteTypeRequestTypeDef#

# DeleteTypeRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import DeleteTypeRequestTypeDef


def get_value() -> DeleteTypeRequestTypeDef:
    return {
        "keyspaceName": ...,
    }


# DeleteTypeRequestTypeDef definition

class DeleteTypeRequestTypeDef(TypedDict):
    keyspaceName: str,
    typeName: str,

GetKeyspaceRequestTypeDef#

# GetKeyspaceRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import GetKeyspaceRequestTypeDef


def get_value() -> GetKeyspaceRequestTypeDef:
    return {
        "keyspaceName": ...,
    }


# GetKeyspaceRequestTypeDef definition

class GetKeyspaceRequestTypeDef(TypedDict):
    keyspaceName: str,

ReplicationGroupStatusTypeDef#

# ReplicationGroupStatusTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ReplicationGroupStatusTypeDef


def get_value() -> ReplicationGroupStatusTypeDef:
    return {
        "region": ...,
    }


# ReplicationGroupStatusTypeDef definition

class ReplicationGroupStatusTypeDef(TypedDict):
    region: str,
    keyspaceStatus: KeyspaceStatusType,  # (1)
    tablesReplicationProgress: NotRequired[str],
  1. See KeyspaceStatusType

GetTableAutoScalingSettingsRequestTypeDef#

# GetTableAutoScalingSettingsRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import GetTableAutoScalingSettingsRequestTypeDef


def get_value() -> GetTableAutoScalingSettingsRequestTypeDef:
    return {
        "keyspaceName": ...,
    }


# GetTableAutoScalingSettingsRequestTypeDef definition

class GetTableAutoScalingSettingsRequestTypeDef(TypedDict):
    keyspaceName: str,
    tableName: str,

GetTableRequestTypeDef#

# GetTableRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import GetTableRequestTypeDef


def get_value() -> GetTableRequestTypeDef:
    return {
        "keyspaceName": ...,
    }


# GetTableRequestTypeDef definition

class GetTableRequestTypeDef(TypedDict):
    keyspaceName: str,
    tableName: str,

PointInTimeRecoverySummaryTypeDef#

# PointInTimeRecoverySummaryTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import PointInTimeRecoverySummaryTypeDef


def get_value() -> PointInTimeRecoverySummaryTypeDef:
    return {
        "status": ...,
    }


# PointInTimeRecoverySummaryTypeDef definition

class PointInTimeRecoverySummaryTypeDef(TypedDict):
    status: PointInTimeRecoveryStatusType,  # (1)
    earliestRestorableTimestamp: NotRequired[datetime.datetime],
  1. See PointInTimeRecoveryStatusType

GetTypeRequestTypeDef#

# GetTypeRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import GetTypeRequestTypeDef


def get_value() -> GetTypeRequestTypeDef:
    return {
        "keyspaceName": ...,
    }


# GetTypeRequestTypeDef definition

class GetTypeRequestTypeDef(TypedDict):
    keyspaceName: str,
    typeName: str,

KeyspaceSummaryTypeDef#

# KeyspaceSummaryTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import KeyspaceSummaryTypeDef


def get_value() -> KeyspaceSummaryTypeDef:
    return {
        "keyspaceName": ...,
    }


# KeyspaceSummaryTypeDef definition

class KeyspaceSummaryTypeDef(TypedDict):
    keyspaceName: str,
    resourceArn: str,
    replicationStrategy: RsType,  # (1)
    replicationRegions: NotRequired[List[str]],
  1. See RsType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListKeyspacesRequestTypeDef#

# ListKeyspacesRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ListKeyspacesRequestTypeDef


def get_value() -> ListKeyspacesRequestTypeDef:
    return {
        "nextToken": ...,
    }


# ListKeyspacesRequestTypeDef definition

class ListKeyspacesRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListTablesRequestTypeDef#

# ListTablesRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ListTablesRequestTypeDef


def get_value() -> ListTablesRequestTypeDef:
    return {
        "keyspaceName": ...,
    }


# ListTablesRequestTypeDef definition

class ListTablesRequestTypeDef(TypedDict):
    keyspaceName: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

TableSummaryTypeDef#

# TableSummaryTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import TableSummaryTypeDef


def get_value() -> TableSummaryTypeDef:
    return {
        "keyspaceName": ...,
    }


# TableSummaryTypeDef definition

class TableSummaryTypeDef(TypedDict):
    keyspaceName: str,
    tableName: str,
    resourceArn: str,

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListTypesRequestTypeDef#

# ListTypesRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ListTypesRequestTypeDef


def get_value() -> ListTypesRequestTypeDef:
    return {
        "keyspaceName": ...,
    }


# ListTypesRequestTypeDef definition

class ListTypesRequestTypeDef(TypedDict):
    keyspaceName: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

PartitionKeyTypeDef#

# PartitionKeyTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import PartitionKeyTypeDef


def get_value() -> PartitionKeyTypeDef:
    return {
        "name": ...,
    }


# PartitionKeyTypeDef definition

class PartitionKeyTypeDef(TypedDict):
    name: str,

StaticColumnTypeDef#

# StaticColumnTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import StaticColumnTypeDef


def get_value() -> StaticColumnTypeDef:
    return {
        "name": ...,
    }


# StaticColumnTypeDef definition

class StaticColumnTypeDef(TypedDict):
    name: str,

AutoScalingPolicyTypeDef#

# AutoScalingPolicyTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import AutoScalingPolicyTypeDef


def get_value() -> AutoScalingPolicyTypeDef:
    return {
        "targetTrackingScalingPolicyConfiguration": ...,
    }


# AutoScalingPolicyTypeDef definition

class AutoScalingPolicyTypeDef(TypedDict):
    targetTrackingScalingPolicyConfiguration: NotRequired[TargetTrackingScalingPolicyConfigurationTypeDef],  # (1)
  1. See TargetTrackingScalingPolicyConfigurationTypeDef

ReplicaSpecificationSummaryTypeDef#

# ReplicaSpecificationSummaryTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ReplicaSpecificationSummaryTypeDef


def get_value() -> ReplicaSpecificationSummaryTypeDef:
    return {
        "region": ...,
    }


# ReplicaSpecificationSummaryTypeDef definition

class ReplicaSpecificationSummaryTypeDef(TypedDict):
    region: NotRequired[str],
    status: NotRequired[TableStatusType],  # (1)
    capacitySpecification: NotRequired[CapacitySpecificationSummaryTypeDef],  # (2)
  1. See TableStatusType
  2. See CapacitySpecificationSummaryTypeDef

CdcSpecificationTypeDef#

# CdcSpecificationTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import CdcSpecificationTypeDef


def get_value() -> CdcSpecificationTypeDef:
    return {
        "status": ...,
    }


# CdcSpecificationTypeDef definition

class CdcSpecificationTypeDef(TypedDict):
    status: CdcStatusType,  # (1)
    viewType: NotRequired[ViewTypeType],  # (2)
    tags: NotRequired[Sequence[TagTypeDef]],  # (3)
    propagateTags: NotRequired[CdcPropagateTagsType],  # (4)
  1. See CdcStatusType
  2. See ViewTypeType
  3. See Sequence[TagTypeDef]
  4. See CdcPropagateTagsType

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See Sequence[TagTypeDef]

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See Sequence[TagTypeDef]

CreateKeyspaceRequestTypeDef#

# CreateKeyspaceRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import CreateKeyspaceRequestTypeDef


def get_value() -> CreateKeyspaceRequestTypeDef:
    return {
        "keyspaceName": ...,
    }


# CreateKeyspaceRequestTypeDef definition

class CreateKeyspaceRequestTypeDef(TypedDict):
    keyspaceName: str,
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    replicationSpecification: NotRequired[ReplicationSpecificationTypeDef],  # (2)
  1. See Sequence[TagTypeDef]
  2. See ReplicationSpecificationTypeDef

UpdateKeyspaceRequestTypeDef#

# UpdateKeyspaceRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import UpdateKeyspaceRequestTypeDef


def get_value() -> UpdateKeyspaceRequestTypeDef:
    return {
        "keyspaceName": ...,
    }


# UpdateKeyspaceRequestTypeDef definition

class UpdateKeyspaceRequestTypeDef(TypedDict):
    keyspaceName: str,
    replicationSpecification: ReplicationSpecificationTypeDef,  # (1)
    clientSideTimestamps: NotRequired[ClientSideTimestampsTypeDef],  # (2)
  1. See ReplicationSpecificationTypeDef
  2. See ClientSideTimestampsTypeDef

CreateKeyspaceResponseTypeDef#

# CreateKeyspaceResponseTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import CreateKeyspaceResponseTypeDef


def get_value() -> CreateKeyspaceResponseTypeDef:
    return {
        "resourceArn": ...,
    }


# CreateKeyspaceResponseTypeDef definition

class CreateKeyspaceResponseTypeDef(TypedDict):
    resourceArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTableResponseTypeDef#

# CreateTableResponseTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import CreateTableResponseTypeDef


def get_value() -> CreateTableResponseTypeDef:
    return {
        "resourceArn": ...,
    }


# CreateTableResponseTypeDef definition

class CreateTableResponseTypeDef(TypedDict):
    resourceArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTypeResponseTypeDef#

# CreateTypeResponseTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import CreateTypeResponseTypeDef


def get_value() -> CreateTypeResponseTypeDef:
    return {
        "keyspaceArn": ...,
    }


# CreateTypeResponseTypeDef definition

class CreateTypeResponseTypeDef(TypedDict):
    keyspaceArn: str,
    typeName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteTypeResponseTypeDef#

# DeleteTypeResponseTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import DeleteTypeResponseTypeDef


def get_value() -> DeleteTypeResponseTypeDef:
    return {
        "keyspaceArn": ...,
    }


# DeleteTypeResponseTypeDef definition

class DeleteTypeResponseTypeDef(TypedDict):
    keyspaceArn: str,
    typeName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "nextToken": ...,
    }


# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[TagTypeDef]
  2. See ResponseMetadataTypeDef

ListTypesResponseTypeDef#

# ListTypesResponseTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ListTypesResponseTypeDef


def get_value() -> ListTypesResponseTypeDef:
    return {
        "nextToken": ...,
    }


# ListTypesResponseTypeDef definition

class ListTypesResponseTypeDef(TypedDict):
    types: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    nextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

RestoreTableResponseTypeDef#

# RestoreTableResponseTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import RestoreTableResponseTypeDef


def get_value() -> RestoreTableResponseTypeDef:
    return {
        "restoredTableARN": ...,
    }


# RestoreTableResponseTypeDef definition

class RestoreTableResponseTypeDef(TypedDict):
    restoredTableARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateKeyspaceResponseTypeDef#

# UpdateKeyspaceResponseTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import UpdateKeyspaceResponseTypeDef


def get_value() -> UpdateKeyspaceResponseTypeDef:
    return {
        "resourceArn": ...,
    }


# UpdateKeyspaceResponseTypeDef definition

class UpdateKeyspaceResponseTypeDef(TypedDict):
    resourceArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateTableResponseTypeDef#

# UpdateTableResponseTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import UpdateTableResponseTypeDef


def get_value() -> UpdateTableResponseTypeDef:
    return {
        "resourceArn": ...,
    }


# UpdateTableResponseTypeDef definition

class UpdateTableResponseTypeDef(TypedDict):
    resourceArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTypeRequestTypeDef#

# CreateTypeRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import CreateTypeRequestTypeDef


def get_value() -> CreateTypeRequestTypeDef:
    return {
        "keyspaceName": ...,
    }


# CreateTypeRequestTypeDef definition

class CreateTypeRequestTypeDef(TypedDict):
    keyspaceName: str,
    typeName: str,
    fieldDefinitions: Sequence[FieldDefinitionTypeDef],  # (1)
  1. See Sequence[FieldDefinitionTypeDef]

GetTypeResponseTypeDef#

# GetTypeResponseTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import GetTypeResponseTypeDef


def get_value() -> GetTypeResponseTypeDef:
    return {
        "keyspaceName": ...,
    }


# GetTypeResponseTypeDef definition

class GetTypeResponseTypeDef(TypedDict):
    keyspaceName: str,
    typeName: str,
    fieldDefinitions: List[FieldDefinitionTypeDef],  # (1)
    lastModifiedTimestamp: datetime.datetime,
    status: TypeStatusType,  # (2)
    directReferringTables: List[str],
    directParentTypes: List[str],
    maxNestingDepth: int,
    keyspaceArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See List[FieldDefinitionTypeDef]
  2. See TypeStatusType
  3. See ResponseMetadataTypeDef

GetKeyspaceResponseTypeDef#

# GetKeyspaceResponseTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import GetKeyspaceResponseTypeDef


def get_value() -> GetKeyspaceResponseTypeDef:
    return {
        "keyspaceName": ...,
    }


# GetKeyspaceResponseTypeDef definition

class GetKeyspaceResponseTypeDef(TypedDict):
    keyspaceName: str,
    resourceArn: str,
    replicationStrategy: RsType,  # (1)
    replicationRegions: List[str],
    replicationGroupStatuses: List[ReplicationGroupStatusTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RsType
  2. See List[ReplicationGroupStatusTypeDef]
  3. See ResponseMetadataTypeDef

ListKeyspacesResponseTypeDef#

# ListKeyspacesResponseTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ListKeyspacesResponseTypeDef


def get_value() -> ListKeyspacesResponseTypeDef:
    return {
        "nextToken": ...,
    }


# ListKeyspacesResponseTypeDef definition

class ListKeyspacesResponseTypeDef(TypedDict):
    keyspaces: List[KeyspaceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[KeyspaceSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListKeyspacesRequestPaginateTypeDef#

# ListKeyspacesRequestPaginateTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ListKeyspacesRequestPaginateTypeDef


def get_value() -> ListKeyspacesRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListKeyspacesRequestPaginateTypeDef definition

class ListKeyspacesRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTablesRequestPaginateTypeDef#

# ListTablesRequestPaginateTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ListTablesRequestPaginateTypeDef


def get_value() -> ListTablesRequestPaginateTypeDef:
    return {
        "keyspaceName": ...,
    }


# ListTablesRequestPaginateTypeDef definition

class ListTablesRequestPaginateTypeDef(TypedDict):
    keyspaceName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTagsForResourceRequestPaginateTypeDef#

# ListTagsForResourceRequestPaginateTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ListTagsForResourceRequestPaginateTypeDef


def get_value() -> ListTagsForResourceRequestPaginateTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceRequestPaginateTypeDef definition

class ListTagsForResourceRequestPaginateTypeDef(TypedDict):
    resourceArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTypesRequestPaginateTypeDef#

# ListTypesRequestPaginateTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ListTypesRequestPaginateTypeDef


def get_value() -> ListTypesRequestPaginateTypeDef:
    return {
        "keyspaceName": ...,
    }


# ListTypesRequestPaginateTypeDef definition

class ListTypesRequestPaginateTypeDef(TypedDict):
    keyspaceName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTablesResponseTypeDef#

# ListTablesResponseTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ListTablesResponseTypeDef


def get_value() -> ListTablesResponseTypeDef:
    return {
        "nextToken": ...,
    }


# ListTablesResponseTypeDef definition

class ListTablesResponseTypeDef(TypedDict):
    tables: List[TableSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[TableSummaryTypeDef]
  2. See ResponseMetadataTypeDef

SchemaDefinitionOutputTypeDef#

# SchemaDefinitionOutputTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import SchemaDefinitionOutputTypeDef


def get_value() -> SchemaDefinitionOutputTypeDef:
    return {
        "allColumns": ...,
    }


# SchemaDefinitionOutputTypeDef definition

class SchemaDefinitionOutputTypeDef(TypedDict):
    allColumns: List[ColumnDefinitionTypeDef],  # (1)
    partitionKeys: List[PartitionKeyTypeDef],  # (2)
    clusteringKeys: NotRequired[List[ClusteringKeyTypeDef]],  # (3)
    staticColumns: NotRequired[List[StaticColumnTypeDef]],  # (4)
  1. See List[ColumnDefinitionTypeDef]
  2. See List[PartitionKeyTypeDef]
  3. See List[ClusteringKeyTypeDef]
  4. See List[StaticColumnTypeDef]

SchemaDefinitionTypeDef#

# SchemaDefinitionTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import SchemaDefinitionTypeDef


def get_value() -> SchemaDefinitionTypeDef:
    return {
        "allColumns": ...,
    }


# SchemaDefinitionTypeDef definition

class SchemaDefinitionTypeDef(TypedDict):
    allColumns: Sequence[ColumnDefinitionTypeDef],  # (1)
    partitionKeys: Sequence[PartitionKeyTypeDef],  # (2)
    clusteringKeys: NotRequired[Sequence[ClusteringKeyTypeDef]],  # (3)
    staticColumns: NotRequired[Sequence[StaticColumnTypeDef]],  # (4)
  1. See Sequence[ColumnDefinitionTypeDef]
  2. See Sequence[PartitionKeyTypeDef]
  3. See Sequence[ClusteringKeyTypeDef]
  4. See Sequence[StaticColumnTypeDef]

AutoScalingSettingsTypeDef#

# AutoScalingSettingsTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import AutoScalingSettingsTypeDef


def get_value() -> AutoScalingSettingsTypeDef:
    return {
        "autoScalingDisabled": ...,
    }


# AutoScalingSettingsTypeDef definition

class AutoScalingSettingsTypeDef(TypedDict):
    autoScalingDisabled: NotRequired[bool],
    minimumUnits: NotRequired[int],
    maximumUnits: NotRequired[int],
    scalingPolicy: NotRequired[AutoScalingPolicyTypeDef],  # (1)
  1. See AutoScalingPolicyTypeDef

GetTableResponseTypeDef#

# GetTableResponseTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import GetTableResponseTypeDef


def get_value() -> GetTableResponseTypeDef:
    return {
        "keyspaceName": ...,
    }


# GetTableResponseTypeDef definition

class GetTableResponseTypeDef(TypedDict):
    keyspaceName: str,
    tableName: str,
    resourceArn: str,
    creationTimestamp: datetime.datetime,
    status: TableStatusType,  # (1)
    schemaDefinition: SchemaDefinitionOutputTypeDef,  # (2)
    capacitySpecification: CapacitySpecificationSummaryTypeDef,  # (3)
    encryptionSpecification: EncryptionSpecificationTypeDef,  # (4)
    pointInTimeRecovery: PointInTimeRecoverySummaryTypeDef,  # (5)
    ttl: TimeToLiveTypeDef,  # (6)
    defaultTimeToLive: int,
    comment: CommentTypeDef,  # (7)
    clientSideTimestamps: ClientSideTimestampsTypeDef,  # (8)
    replicaSpecifications: List[ReplicaSpecificationSummaryTypeDef],  # (9)
    latestStreamArn: str,
    cdcSpecification: CdcSpecificationSummaryTypeDef,  # (10)
    ResponseMetadata: ResponseMetadataTypeDef,  # (11)
  1. See TableStatusType
  2. See SchemaDefinitionOutputTypeDef
  3. See CapacitySpecificationSummaryTypeDef
  4. See EncryptionSpecificationTypeDef
  5. See PointInTimeRecoverySummaryTypeDef
  6. See TimeToLiveTypeDef
  7. See CommentTypeDef
  8. See ClientSideTimestampsTypeDef
  9. See List[ReplicaSpecificationSummaryTypeDef]
  10. See CdcSpecificationSummaryTypeDef
  11. See ResponseMetadataTypeDef

AutoScalingSpecificationTypeDef#

# AutoScalingSpecificationTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import AutoScalingSpecificationTypeDef


def get_value() -> AutoScalingSpecificationTypeDef:
    return {
        "writeCapacityAutoScaling": ...,
    }


# AutoScalingSpecificationTypeDef definition

class AutoScalingSpecificationTypeDef(TypedDict):
    writeCapacityAutoScaling: NotRequired[AutoScalingSettingsTypeDef],  # (1)
    readCapacityAutoScaling: NotRequired[AutoScalingSettingsTypeDef],  # (1)
  1. See AutoScalingSettingsTypeDef
  2. See AutoScalingSettingsTypeDef

ReplicaSpecificationTypeDef#

# ReplicaSpecificationTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ReplicaSpecificationTypeDef


def get_value() -> ReplicaSpecificationTypeDef:
    return {
        "region": ...,
    }


# ReplicaSpecificationTypeDef definition

class ReplicaSpecificationTypeDef(TypedDict):
    region: str,
    readCapacityUnits: NotRequired[int],
    readCapacityAutoScaling: NotRequired[AutoScalingSettingsTypeDef],  # (1)
  1. See AutoScalingSettingsTypeDef

ReplicaAutoScalingSpecificationTypeDef#

# ReplicaAutoScalingSpecificationTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import ReplicaAutoScalingSpecificationTypeDef


def get_value() -> ReplicaAutoScalingSpecificationTypeDef:
    return {
        "region": ...,
    }


# ReplicaAutoScalingSpecificationTypeDef definition

class ReplicaAutoScalingSpecificationTypeDef(TypedDict):
    region: NotRequired[str],
    autoScalingSpecification: NotRequired[AutoScalingSpecificationTypeDef],  # (1)
  1. See AutoScalingSpecificationTypeDef

CreateTableRequestTypeDef#

# CreateTableRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import CreateTableRequestTypeDef


def get_value() -> CreateTableRequestTypeDef:
    return {
        "keyspaceName": ...,
    }


# CreateTableRequestTypeDef definition

class CreateTableRequestTypeDef(TypedDict):
    keyspaceName: str,
    tableName: str,
    schemaDefinition: SchemaDefinitionUnionTypeDef,  # (1)
    comment: NotRequired[CommentTypeDef],  # (2)
    capacitySpecification: NotRequired[CapacitySpecificationTypeDef],  # (3)
    encryptionSpecification: NotRequired[EncryptionSpecificationTypeDef],  # (4)
    pointInTimeRecovery: NotRequired[PointInTimeRecoveryTypeDef],  # (5)
    ttl: NotRequired[TimeToLiveTypeDef],  # (6)
    defaultTimeToLive: NotRequired[int],
    tags: NotRequired[Sequence[TagTypeDef]],  # (7)
    clientSideTimestamps: NotRequired[ClientSideTimestampsTypeDef],  # (8)
    autoScalingSpecification: NotRequired[AutoScalingSpecificationTypeDef],  # (9)
    replicaSpecifications: NotRequired[Sequence[ReplicaSpecificationTypeDef]],  # (10)
    cdcSpecification: NotRequired[CdcSpecificationTypeDef],  # (11)
  1. See SchemaDefinitionUnionTypeDef
  2. See CommentTypeDef
  3. See CapacitySpecificationTypeDef
  4. See EncryptionSpecificationTypeDef
  5. See PointInTimeRecoveryTypeDef
  6. See TimeToLiveTypeDef
  7. See Sequence[TagTypeDef]
  8. See ClientSideTimestampsTypeDef
  9. See AutoScalingSpecificationTypeDef
  10. See Sequence[ReplicaSpecificationTypeDef]
  11. See CdcSpecificationTypeDef

RestoreTableRequestTypeDef#

# RestoreTableRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import RestoreTableRequestTypeDef


def get_value() -> RestoreTableRequestTypeDef:
    return {
        "sourceKeyspaceName": ...,
    }


# RestoreTableRequestTypeDef definition

class RestoreTableRequestTypeDef(TypedDict):
    sourceKeyspaceName: str,
    sourceTableName: str,
    targetKeyspaceName: str,
    targetTableName: str,
    restoreTimestamp: NotRequired[TimestampTypeDef],
    capacitySpecificationOverride: NotRequired[CapacitySpecificationTypeDef],  # (1)
    encryptionSpecificationOverride: NotRequired[EncryptionSpecificationTypeDef],  # (2)
    pointInTimeRecoveryOverride: NotRequired[PointInTimeRecoveryTypeDef],  # (3)
    tagsOverride: NotRequired[Sequence[TagTypeDef]],  # (4)
    autoScalingSpecification: NotRequired[AutoScalingSpecificationTypeDef],  # (5)
    replicaSpecifications: NotRequired[Sequence[ReplicaSpecificationTypeDef]],  # (6)
  1. See CapacitySpecificationTypeDef
  2. See EncryptionSpecificationTypeDef
  3. See PointInTimeRecoveryTypeDef
  4. See Sequence[TagTypeDef]
  5. See AutoScalingSpecificationTypeDef
  6. See Sequence[ReplicaSpecificationTypeDef]

UpdateTableRequestTypeDef#

# UpdateTableRequestTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import UpdateTableRequestTypeDef


def get_value() -> UpdateTableRequestTypeDef:
    return {
        "keyspaceName": ...,
    }


# UpdateTableRequestTypeDef definition

class UpdateTableRequestTypeDef(TypedDict):
    keyspaceName: str,
    tableName: str,
    addColumns: NotRequired[Sequence[ColumnDefinitionTypeDef]],  # (1)
    capacitySpecification: NotRequired[CapacitySpecificationTypeDef],  # (2)
    encryptionSpecification: NotRequired[EncryptionSpecificationTypeDef],  # (3)
    pointInTimeRecovery: NotRequired[PointInTimeRecoveryTypeDef],  # (4)
    ttl: NotRequired[TimeToLiveTypeDef],  # (5)
    defaultTimeToLive: NotRequired[int],
    clientSideTimestamps: NotRequired[ClientSideTimestampsTypeDef],  # (6)
    autoScalingSpecification: NotRequired[AutoScalingSpecificationTypeDef],  # (7)
    replicaSpecifications: NotRequired[Sequence[ReplicaSpecificationTypeDef]],  # (8)
    cdcSpecification: NotRequired[CdcSpecificationTypeDef],  # (9)
  1. See Sequence[ColumnDefinitionTypeDef]
  2. See CapacitySpecificationTypeDef
  3. See EncryptionSpecificationTypeDef
  4. See PointInTimeRecoveryTypeDef
  5. See TimeToLiveTypeDef
  6. See ClientSideTimestampsTypeDef
  7. See AutoScalingSpecificationTypeDef
  8. See Sequence[ReplicaSpecificationTypeDef]
  9. See CdcSpecificationTypeDef

GetTableAutoScalingSettingsResponseTypeDef#

# GetTableAutoScalingSettingsResponseTypeDef TypedDict usage example

from types_boto3_keyspaces.type_defs import GetTableAutoScalingSettingsResponseTypeDef


def get_value() -> GetTableAutoScalingSettingsResponseTypeDef:
    return {
        "keyspaceName": ...,
    }


# GetTableAutoScalingSettingsResponseTypeDef definition

class GetTableAutoScalingSettingsResponseTypeDef(TypedDict):
    keyspaceName: str,
    tableName: str,
    resourceArn: str,
    autoScalingSpecification: AutoScalingSpecificationTypeDef,  # (1)
    replicaSpecifications: List[ReplicaAutoScalingSpecificationTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AutoScalingSpecificationTypeDef
  2. See List[ReplicaAutoScalingSpecificationTypeDef]
  3. See ResponseMetadataTypeDef