Type definitions#
Auto-generated documentation for Keyspaces type annotations stubs module mypy-boto3-keyspaces.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
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],
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,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
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)
FieldDefinitionTypeDef#
# FieldDefinitionTypeDef definition
class FieldDefinitionTypeDef(TypedDict):
name: str,
type: str,
DeleteKeyspaceRequestRequestTypeDef#
# DeleteKeyspaceRequestRequestTypeDef definition
class DeleteKeyspaceRequestRequestTypeDef(TypedDict):
keyspaceName: str,
DeleteTableRequestRequestTypeDef#
# DeleteTableRequestRequestTypeDef definition
class DeleteTableRequestRequestTypeDef(TypedDict):
keyspaceName: str,
tableName: str,
DeleteTypeRequestRequestTypeDef#
# DeleteTypeRequestRequestTypeDef definition
class DeleteTypeRequestRequestTypeDef(TypedDict):
keyspaceName: str,
typeName: str,
GetKeyspaceRequestRequestTypeDef#
# GetKeyspaceRequestRequestTypeDef definition
class GetKeyspaceRequestRequestTypeDef(TypedDict):
keyspaceName: str,
ReplicationGroupStatusTypeDef#
# ReplicationGroupStatusTypeDef definition
class ReplicationGroupStatusTypeDef(TypedDict):
region: str,
keyspaceStatus: KeyspaceStatusType, # (1)
tablesReplicationProgress: NotRequired[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],
GetTypeRequestRequestTypeDef#
# GetTypeRequestRequestTypeDef definition
class GetTypeRequestRequestTypeDef(TypedDict):
keyspaceName: str,
typeName: str,
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],
ListTypesRequestRequestTypeDef#
# ListTypesRequestRequestTypeDef definition
class ListTypesRequestRequestTypeDef(TypedDict):
keyspaceName: 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)
ReplicaSpecificationSummaryTypeDef#
# ReplicaSpecificationSummaryTypeDef definition
class ReplicaSpecificationSummaryTypeDef(TypedDict):
region: NotRequired[str],
status: NotRequired[TableStatusType], # (1)
capacitySpecification: NotRequired[CapacitySpecificationSummaryTypeDef], # (2)
UpdateKeyspaceRequestRequestTypeDef#
# UpdateKeyspaceRequestRequestTypeDef definition
class UpdateKeyspaceRequestRequestTypeDef(TypedDict):
keyspaceName: str,
replicationSpecification: ReplicationSpecificationTypeDef, # (1)
clientSideTimestamps: NotRequired[ClientSideTimestampsTypeDef], # (2)
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)
CreateTypeResponseTypeDef#
# CreateTypeResponseTypeDef definition
class CreateTypeResponseTypeDef(TypedDict):
keyspaceArn: str,
typeName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteTypeResponseTypeDef#
# DeleteTypeResponseTypeDef definition
class DeleteTypeResponseTypeDef(TypedDict):
keyspaceArn: str,
typeName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
- See TagTypeDef
- See ResponseMetadataTypeDef
ListTypesResponseTypeDef#
# ListTypesResponseTypeDef definition
class ListTypesResponseTypeDef(TypedDict):
types: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
nextToken: NotRequired[str],
RestoreTableResponseTypeDef#
# RestoreTableResponseTypeDef definition
class RestoreTableResponseTypeDef(TypedDict):
restoredTableARN: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateKeyspaceResponseTypeDef#
# UpdateKeyspaceResponseTypeDef definition
class UpdateKeyspaceResponseTypeDef(TypedDict):
resourceArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateTableResponseTypeDef#
# UpdateTableResponseTypeDef definition
class UpdateTableResponseTypeDef(TypedDict):
resourceArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateTypeRequestRequestTypeDef#
# CreateTypeRequestRequestTypeDef definition
class CreateTypeRequestRequestTypeDef(TypedDict):
keyspaceName: str,
typeName: str,
fieldDefinitions: Sequence[FieldDefinitionTypeDef], # (1)
GetTypeResponseTypeDef#
# GetTypeResponseTypeDef definition
class GetTypeResponseTypeDef(TypedDict):
keyspaceName: str,
typeName: str,
fieldDefinitions: List[FieldDefinitionTypeDef], # (1)
lastModifiedTimestamp: datetime,
status: TypeStatusType, # (2)
directReferringTables: List[str],
directParentTypes: List[str],
maxNestingDepth: int,
keyspaceArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetKeyspaceResponseTypeDef#
# GetKeyspaceResponseTypeDef definition
class GetKeyspaceResponseTypeDef(TypedDict):
keyspaceName: str,
resourceArn: str,
replicationStrategy: RsType, # (1)
replicationRegions: List[str],
replicationGroupStatuses: List[ReplicationGroupStatusTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ListKeyspacesResponseTypeDef#
# ListKeyspacesResponseTypeDef definition
class ListKeyspacesResponseTypeDef(TypedDict):
keyspaces: List[KeyspaceSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
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)
ListTypesRequestListTypesPaginateTypeDef#
# ListTypesRequestListTypesPaginateTypeDef definition
class ListTypesRequestListTypesPaginateTypeDef(TypedDict):
keyspaceName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTablesResponseTypeDef#
# ListTablesResponseTypeDef definition
class ListTablesResponseTypeDef(TypedDict):
tables: List[TableSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
SchemaDefinitionOutputTypeDef#
# SchemaDefinitionOutputTypeDef definition
class SchemaDefinitionOutputTypeDef(TypedDict):
allColumns: List[ColumnDefinitionTypeDef], # (1)
partitionKeys: List[PartitionKeyTypeDef], # (2)
clusteringKeys: NotRequired[List[ClusteringKeyTypeDef]], # (3)
staticColumns: NotRequired[List[StaticColumnTypeDef]], # (4)
- See ColumnDefinitionTypeDef
- See PartitionKeyTypeDef
- See ClusteringKeyTypeDef
- 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)
- See ColumnDefinitionTypeDef
- See PartitionKeyTypeDef
- See ClusteringKeyTypeDef
- See StaticColumnTypeDef
AutoScalingSettingsTypeDef#
# AutoScalingSettingsTypeDef definition
class AutoScalingSettingsTypeDef(TypedDict):
autoScalingDisabled: NotRequired[bool],
minimumUnits: NotRequired[int],
maximumUnits: NotRequired[int],
scalingPolicy: NotRequired[AutoScalingPolicyTypeDef], # (1)
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)
- See TableStatusType
- See SchemaDefinitionOutputTypeDef
- See CapacitySpecificationSummaryTypeDef
- See EncryptionSpecificationTypeDef
- See PointInTimeRecoverySummaryTypeDef
- See TimeToLiveTypeDef
- See CommentTypeDef
- See ClientSideTimestampsTypeDef
- See ReplicaSpecificationSummaryTypeDef
- See ResponseMetadataTypeDef
AutoScalingSpecificationTypeDef#
# AutoScalingSpecificationTypeDef definition
class AutoScalingSpecificationTypeDef(TypedDict):
writeCapacityAutoScaling: NotRequired[AutoScalingSettingsTypeDef], # (1)
readCapacityAutoScaling: NotRequired[AutoScalingSettingsTypeDef], # (1)
ReplicaSpecificationTypeDef#
# ReplicaSpecificationTypeDef definition
class ReplicaSpecificationTypeDef(TypedDict):
region: str,
readCapacityUnits: NotRequired[int],
readCapacityAutoScaling: NotRequired[AutoScalingSettingsTypeDef], # (1)
ReplicaAutoScalingSpecificationTypeDef#
# ReplicaAutoScalingSpecificationTypeDef definition
class ReplicaAutoScalingSpecificationTypeDef(TypedDict):
region: NotRequired[str],
autoScalingSpecification: NotRequired[AutoScalingSpecificationTypeDef], # (1)
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)
- See SchemaDefinitionTypeDef
- See CommentTypeDef
- See CapacitySpecificationTypeDef
- See EncryptionSpecificationTypeDef
- See PointInTimeRecoveryTypeDef
- See TimeToLiveTypeDef
- See TagTypeDef
- See ClientSideTimestampsTypeDef
- See AutoScalingSpecificationTypeDef
- See ReplicaSpecificationTypeDef
RestoreTableRequestRequestTypeDef#
# RestoreTableRequestRequestTypeDef definition
class RestoreTableRequestRequestTypeDef(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)
- See CapacitySpecificationTypeDef
- See EncryptionSpecificationTypeDef
- See PointInTimeRecoveryTypeDef
- See TagTypeDef
- See AutoScalingSpecificationTypeDef
- See ReplicaSpecificationTypeDef
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)
autoScalingSpecification: NotRequired[AutoScalingSpecificationTypeDef], # (7)
replicaSpecifications: NotRequired[Sequence[ReplicaSpecificationTypeDef]], # (8)
- See ColumnDefinitionTypeDef
- See CapacitySpecificationTypeDef
- See EncryptionSpecificationTypeDef
- See PointInTimeRecoveryTypeDef
- See TimeToLiveTypeDef
- See ClientSideTimestampsTypeDef
- See AutoScalingSpecificationTypeDef
- See ReplicaSpecificationTypeDef
GetTableAutoScalingSettingsResponseTypeDef#
# GetTableAutoScalingSettingsResponseTypeDef definition
class GetTableAutoScalingSettingsResponseTypeDef(TypedDict):
keyspaceName: str,
tableName: str,
resourceArn: str,
autoScalingSpecification: AutoScalingSpecificationTypeDef, # (1)
replicaSpecifications: List[ReplicaAutoScalingSpecificationTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)