Type definitions#
Auto-generated documentation for Keyspaces type annotations stubs module mypy-boto3-keyspaces.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
CapacitySpecificationSummaryTypeDef#
# CapacitySpecificationSummaryTypeDef definition
class CapacitySpecificationSummaryTypeDef(TypedDict):
throughputMode: ThroughputModeType, # (1)
readCapacityUnits: NotRequired[int],
writeCapacityUnits: NotRequired[int],
lastUpdateToPayPerRequestTimestamp: NotRequired[datetime],
CapacitySpecificationTypeDef#
# CapacitySpecificationTypeDef definition
class CapacitySpecificationTypeDef(TypedDict):
throughputMode: ThroughputModeType, # (1)
readCapacityUnits: NotRequired[int],
writeCapacityUnits: NotRequired[int],
ClientSideTimestampsTypeDef#
# ClientSideTimestampsTypeDef definition
class ClientSideTimestampsTypeDef(TypedDict):
status: ClientSideTimestampsStatusType, # (1)
ClusteringKeyTypeDef#
# ClusteringKeyTypeDef definition
class ClusteringKeyTypeDef(TypedDict):
name: str,
orderBy: SortOrderType, # (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]],
- See rsType
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
key: str,
value: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
EncryptionSpecificationTypeDef#
# EncryptionSpecificationTypeDef definition
class EncryptionSpecificationTypeDef(TypedDict):
type: EncryptionTypeType, # (1)
kmsKeyIdentifier: NotRequired[str],
PointInTimeRecoveryTypeDef#
# PointInTimeRecoveryTypeDef definition
class PointInTimeRecoveryTypeDef(TypedDict):
status: PointInTimeRecoveryStatusType, # (1)
TimeToLiveTypeDef#
# TimeToLiveTypeDef definition
class TimeToLiveTypeDef(TypedDict):
status: TimeToLiveStatusType, # (1)
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,
GetTableRequestRequestTypeDef#
# GetTableRequestRequestTypeDef definition
class GetTableRequestRequestTypeDef(TypedDict):
keyspaceName: str,
tableName: str,
PointInTimeRecoverySummaryTypeDef#
# PointInTimeRecoverySummaryTypeDef definition
class PointInTimeRecoverySummaryTypeDef(TypedDict):
status: PointInTimeRecoveryStatusType, # (1)
earliestRestorableTimestamp: NotRequired[datetime],
KeyspaceSummaryTypeDef#
# KeyspaceSummaryTypeDef definition
class KeyspaceSummaryTypeDef(TypedDict):
keyspaceName: str,
resourceArn: str,
replicationStrategy: rsType, # (1)
replicationRegions: NotRequired[List[str]],
- 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,
CreateKeyspaceRequestRequestTypeDef#
# CreateKeyspaceRequestRequestTypeDef definition
class CreateKeyspaceRequestRequestTypeDef(TypedDict):
keyspaceName: str,
tags: NotRequired[Sequence[TagTypeDef]], # (1)
replicationSpecification: NotRequired[ReplicationSpecificationTypeDef], # (2)
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateKeyspaceResponseTypeDef#
# CreateKeyspaceResponseTypeDef definition
class CreateKeyspaceResponseTypeDef(TypedDict):
resourceArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateTableResponseTypeDef#
# CreateTableResponseTypeDef definition
class CreateTableResponseTypeDef(TypedDict):
resourceArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetKeyspaceResponseTypeDef#
# GetKeyspaceResponseTypeDef definition
class GetKeyspaceResponseTypeDef(TypedDict):
keyspaceName: str,
resourceArn: str,
replicationStrategy: rsType, # (1)
replicationRegions: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See rsType
- See ResponseMetadataTypeDef
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
nextToken: str,
tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
RestoreTableResponseTypeDef#
# RestoreTableResponseTypeDef definition
class RestoreTableResponseTypeDef(TypedDict):
restoredTableARN: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateTableResponseTypeDef#
# UpdateTableResponseTypeDef definition
class UpdateTableResponseTypeDef(TypedDict):
resourceArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateTableRequestRequestTypeDef#
# UpdateTableRequestRequestTypeDef definition
class UpdateTableRequestRequestTypeDef(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)
- See ColumnDefinitionTypeDef
- See CapacitySpecificationTypeDef
- See EncryptionSpecificationTypeDef
- See PointInTimeRecoveryTypeDef
- See TimeToLiveTypeDef
- See ClientSideTimestampsTypeDef
ListKeyspacesResponseTypeDef#
# ListKeyspacesResponseTypeDef definition
class ListKeyspacesResponseTypeDef(TypedDict):
nextToken: str,
keyspaces: List[KeyspaceSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListKeyspacesRequestListKeyspacesPaginateTypeDef#
# ListKeyspacesRequestListKeyspacesPaginateTypeDef definition
class ListKeyspacesRequestListKeyspacesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTablesRequestListTablesPaginateTypeDef#
# ListTablesRequestListTablesPaginateTypeDef definition
class ListTablesRequestListTablesPaginateTypeDef(TypedDict):
keyspaceName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTagsForResourceRequestListTagsForResourcePaginateTypeDef#
# ListTagsForResourceRequestListTagsForResourcePaginateTypeDef definition
class ListTagsForResourceRequestListTagsForResourcePaginateTypeDef(TypedDict):
resourceArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTablesResponseTypeDef#
# ListTablesResponseTypeDef definition
class ListTablesResponseTypeDef(TypedDict):
nextToken: str,
tables: List[TableSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RestoreTableRequestRequestTypeDef#
# RestoreTableRequestRequestTypeDef definition
class RestoreTableRequestRequestTypeDef(TypedDict):
sourceKeyspaceName: str,
sourceTableName: str,
targetKeyspaceName: str,
targetTableName: str,
restoreTimestamp: NotRequired[Union[datetime, str]],
capacitySpecificationOverride: NotRequired[CapacitySpecificationTypeDef], # (1)
encryptionSpecificationOverride: NotRequired[EncryptionSpecificationTypeDef], # (2)
pointInTimeRecoveryOverride: NotRequired[PointInTimeRecoveryTypeDef], # (3)
tagsOverride: NotRequired[Sequence[TagTypeDef]], # (4)
- See CapacitySpecificationTypeDef
- See EncryptionSpecificationTypeDef
- See PointInTimeRecoveryTypeDef
- See TagTypeDef
SchemaDefinitionTypeDef#
# SchemaDefinitionTypeDef definition
class SchemaDefinitionTypeDef(TypedDict):
allColumns: Sequence[ColumnDefinitionTypeDef], # (1)
partitionKeys: Sequence[PartitionKeyTypeDef], # (2)
clusteringKeys: NotRequired[Sequence[ClusteringKeyTypeDef]], # (3)
staticColumns: NotRequired[Sequence[StaticColumnTypeDef]], # (4)
- See ColumnDefinitionTypeDef
- See PartitionKeyTypeDef
- See ClusteringKeyTypeDef
- See StaticColumnTypeDef
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)
- See SchemaDefinitionTypeDef
- See CommentTypeDef
- See CapacitySpecificationTypeDef
- See EncryptionSpecificationTypeDef
- See PointInTimeRecoveryTypeDef
- See TimeToLiveTypeDef
- See TagTypeDef
- See ClientSideTimestampsTypeDef
GetTableResponseTypeDef#
# GetTableResponseTypeDef definition
class GetTableResponseTypeDef(TypedDict):
keyspaceName: str,
tableName: str,
resourceArn: str,
creationTimestamp: datetime,
status: TableStatusType, # (1)
schemaDefinition: SchemaDefinitionTypeDef, # (2)
capacitySpecification: CapacitySpecificationSummaryTypeDef, # (3)
encryptionSpecification: EncryptionSpecificationTypeDef, # (4)
pointInTimeRecovery: PointInTimeRecoverySummaryTypeDef, # (5)
ttl: TimeToLiveTypeDef, # (6)
defaultTimeToLive: int,
comment: CommentTypeDef, # (7)
clientSideTimestamps: ClientSideTimestampsTypeDef, # (8)
ResponseMetadata: ResponseMetadataTypeDef, # (9)