Skip to content

Type definitions#

Index > Keyspaces > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

SchemaDefinitionUnionTypeDef#

# SchemaDefinitionUnionTypeDef definition

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

TargetTrackingScalingPolicyConfigurationTypeDef#

# TargetTrackingScalingPolicyConfigurationTypeDef definition

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

CapacitySpecificationSummaryTypeDef#

# CapacitySpecificationSummaryTypeDef definition

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

CapacitySpecificationTypeDef#

# CapacitySpecificationTypeDef definition

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

ClientSideTimestampsTypeDef#

# ClientSideTimestampsTypeDef definition

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

ClusteringKeyTypeDef#

# ClusteringKeyTypeDef definition

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

ColumnDefinitionTypeDef#

# ColumnDefinitionTypeDef definition

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

CommentTypeDef#

# CommentTypeDef definition

class CommentTypeDef(TypedDict):
    message: str,

ReplicationSpecificationTypeDef#

# ReplicationSpecificationTypeDef definition

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

TagTypeDef#

# TagTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

EncryptionSpecificationTypeDef#

# EncryptionSpecificationTypeDef definition

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

PointInTimeRecoveryTypeDef#

# PointInTimeRecoveryTypeDef definition

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

TimeToLiveTypeDef#

# TimeToLiveTypeDef definition

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

DeleteKeyspaceRequestRequestTypeDef#

# DeleteKeyspaceRequestRequestTypeDef definition

class DeleteKeyspaceRequestRequestTypeDef(TypedDict):
    keyspaceName: str,

DeleteTableRequestRequestTypeDef#

# DeleteTableRequestRequestTypeDef definition

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

GetKeyspaceRequestRequestTypeDef#

# GetKeyspaceRequestRequestTypeDef definition

class GetKeyspaceRequestRequestTypeDef(TypedDict):
    keyspaceName: str,

GetTableAutoScalingSettingsRequestRequestTypeDef#

# GetTableAutoScalingSettingsRequestRequestTypeDef definition

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

GetTableRequestRequestTypeDef#

# GetTableRequestRequestTypeDef definition

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

PointInTimeRecoverySummaryTypeDef#

# PointInTimeRecoverySummaryTypeDef definition

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

KeyspaceSummaryTypeDef#

# KeyspaceSummaryTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListKeyspacesRequestRequestTypeDef#

# ListKeyspacesRequestRequestTypeDef definition

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

ListTablesRequestRequestTypeDef#

# ListTablesRequestRequestTypeDef definition

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

TableSummaryTypeDef#

# TableSummaryTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

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

PartitionKeyTypeDef#

# PartitionKeyTypeDef definition

class PartitionKeyTypeDef(TypedDict):
    name: str,

StaticColumnTypeDef#

# StaticColumnTypeDef definition

class StaticColumnTypeDef(TypedDict):
    name: str,

AutoScalingPolicyTypeDef#

# AutoScalingPolicyTypeDef definition

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

ReplicaSpecificationSummaryTypeDef#

# ReplicaSpecificationSummaryTypeDef definition

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

CreateKeyspaceRequestRequestTypeDef#

# CreateKeyspaceRequestRequestTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

CreateKeyspaceResponseTypeDef#

# CreateKeyspaceResponseTypeDef definition

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

CreateTableResponseTypeDef#

# CreateTableResponseTypeDef definition

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

GetKeyspaceResponseTypeDef#

# GetKeyspaceResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

RestoreTableResponseTypeDef#

# RestoreTableResponseTypeDef definition

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

UpdateTableResponseTypeDef#

# UpdateTableResponseTypeDef definition

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

ListKeyspacesResponseTypeDef#

# ListKeyspacesResponseTypeDef definition

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

ListKeyspacesRequestListKeyspacesPaginateTypeDef#

# ListKeyspacesRequestListKeyspacesPaginateTypeDef definition

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

ListTablesRequestListTablesPaginateTypeDef#

# ListTablesRequestListTablesPaginateTypeDef definition

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

ListTagsForResourceRequestListTagsForResourcePaginateTypeDef#

# ListTagsForResourceRequestListTagsForResourcePaginateTypeDef definition

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

ListTablesResponseTypeDef#

# ListTablesResponseTypeDef definition

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

SchemaDefinitionOutputTypeDef#

# 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 ColumnDefinitionTypeDef
  2. See PartitionKeyTypeDef
  3. See ClusteringKeyTypeDef
  4. See StaticColumnTypeDef

SchemaDefinitionTypeDef#

# 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 ColumnDefinitionTypeDef
  2. See PartitionKeyTypeDef
  3. See ClusteringKeyTypeDef
  4. See StaticColumnTypeDef

AutoScalingSettingsTypeDef#

# AutoScalingSettingsTypeDef definition

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

GetTableResponseTypeDef#

# GetTableResponseTypeDef definition

class GetTableResponseTypeDef(TypedDict):
    keyspaceName: str,
    tableName: str,
    resourceArn: str,
    creationTimestamp: 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)
    ResponseMetadata: ResponseMetadataTypeDef,  # (10)
  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 ReplicaSpecificationSummaryTypeDef
  10. See ResponseMetadataTypeDef

AutoScalingSpecificationTypeDef#

# AutoScalingSpecificationTypeDef definition

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

ReplicaSpecificationTypeDef#

# ReplicaSpecificationTypeDef definition

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

ReplicaAutoScalingSpecificationTypeDef#

# ReplicaAutoScalingSpecificationTypeDef definition

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

CreateTableRequestRequestTypeDef#

# CreateTableRequestRequestTypeDef definition

class CreateTableRequestRequestTypeDef(TypedDict):
    keyspaceName: str,
    tableName: str,
    schemaDefinition: SchemaDefinitionTypeDef,  # (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)
  1. See SchemaDefinitionTypeDef
  2. See CommentTypeDef
  3. See CapacitySpecificationTypeDef
  4. See EncryptionSpecificationTypeDef
  5. See