Skip to content

Typed dictionaries

Index > Keyspaces > Typed dictionaries

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

CapacitySpecificationSummaryTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import CapacitySpecificationSummaryTypeDef

def get_value() -> CapacitySpecificationSummaryTypeDef:
    return {
        "throughputMode": ...,
    }
Definition
class CapacitySpecificationSummaryTypeDef(TypedDict):
    throughputMode: ThroughputModeType,  # (1)
    readCapacityUnits: NotRequired[int],
    writeCapacityUnits: NotRequired[int],
    lastUpdateToPayPerRequestTimestamp: NotRequired[datetime],
  1. See ThroughputModeType

CapacitySpecificationTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import CapacitySpecificationTypeDef

def get_value() -> CapacitySpecificationTypeDef:
    return {
        "throughputMode": ...,
    }
Definition
class CapacitySpecificationTypeDef(TypedDict):
    throughputMode: ThroughputModeType,  # (1)
    readCapacityUnits: NotRequired[int],
    writeCapacityUnits: NotRequired[int],
  1. See ThroughputModeType

ClusteringKeyTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import ClusteringKeyTypeDef

def get_value() -> ClusteringKeyTypeDef:
    return {
        "name": ...,
        "orderBy": ...,
    }
Definition
class ClusteringKeyTypeDef(TypedDict):
    name: str,
    orderBy: SortOrderType,  # (1)
  1. See SortOrderType

ColumnDefinitionTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import ColumnDefinitionTypeDef

def get_value() -> ColumnDefinitionTypeDef:
    return {
        "name": ...,
        "type": ...,
    }
Definition
class ColumnDefinitionTypeDef(TypedDict):
    name: str,
    type: str,

CommentTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import CommentTypeDef

def get_value() -> CommentTypeDef:
    return {
        "message": ...,
    }
Definition
class CommentTypeDef(TypedDict):
    message: str,

TagTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "key": ...,
        "value": ...,
    }
Definition
class TagTypeDef(TypedDict):
    key: str,
    value: str,

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_keyspaces.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,

EncryptionSpecificationTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import EncryptionSpecificationTypeDef

def get_value() -> EncryptionSpecificationTypeDef:
    return {
        "type": ...,
    }
Definition
class EncryptionSpecificationTypeDef(TypedDict):
    type: EncryptionTypeType,  # (1)
    kmsKeyIdentifier: NotRequired[str],
  1. See EncryptionTypeType

PointInTimeRecoveryTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import PointInTimeRecoveryTypeDef

def get_value() -> PointInTimeRecoveryTypeDef:
    return {
        "status": ...,
    }
Definition
class PointInTimeRecoveryTypeDef(TypedDict):
    status: PointInTimeRecoveryStatusType,  # (1)
  1. See PointInTimeRecoveryStatusType

TimeToLiveTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import TimeToLiveTypeDef

def get_value() -> TimeToLiveTypeDef:
    return {
        "status": ...,
    }
Definition
class TimeToLiveTypeDef(TypedDict):
    status: TimeToLiveStatusType,  # (1)
  1. See TimeToLiveStatusType

DeleteKeyspaceRequestRequestTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import DeleteKeyspaceRequestRequestTypeDef

def get_value() -> DeleteKeyspaceRequestRequestTypeDef:
    return {
        "keyspaceName": ...,
    }
Definition
class DeleteKeyspaceRequestRequestTypeDef(TypedDict):
    keyspaceName: str,

DeleteTableRequestRequestTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import DeleteTableRequestRequestTypeDef

def get_value() -> DeleteTableRequestRequestTypeDef:
    return {
        "keyspaceName": ...,
        "tableName": ...,
    }
Definition
class DeleteTableRequestRequestTypeDef(TypedDict):
    keyspaceName: str,
    tableName: str,

GetKeyspaceRequestRequestTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import GetKeyspaceRequestRequestTypeDef

def get_value() -> GetKeyspaceRequestRequestTypeDef:
    return {
        "keyspaceName": ...,
    }
Definition
class GetKeyspaceRequestRequestTypeDef(TypedDict):
    keyspaceName: str,

GetTableRequestRequestTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import GetTableRequestRequestTypeDef

def get_value() -> GetTableRequestRequestTypeDef:
    return {
        "keyspaceName": ...,
        "tableName": ...,
    }
Definition
class GetTableRequestRequestTypeDef(TypedDict):
    keyspaceName: str,
    tableName: str,

PointInTimeRecoverySummaryTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import PointInTimeRecoverySummaryTypeDef

def get_value() -> PointInTimeRecoverySummaryTypeDef:
    return {
        "status": ...,
    }
Definition
class PointInTimeRecoverySummaryTypeDef(TypedDict):
    status: PointInTimeRecoveryStatusType,  # (1)
    earliestRestorableTimestamp: NotRequired[datetime],
  1. See PointInTimeRecoveryStatusType

KeyspaceSummaryTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import KeyspaceSummaryTypeDef

def get_value() -> KeyspaceSummaryTypeDef:
    return {
        "keyspaceName": ...,
        "resourceArn": ...,
    }
Definition
class KeyspaceSummaryTypeDef(TypedDict):
    keyspaceName: str,
    resourceArn: str,

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListKeyspacesRequestRequestTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import ListKeyspacesRequestRequestTypeDef

def get_value() -> ListKeyspacesRequestRequestTypeDef:
    return {
        "nextToken": ...,
    }
Definition
class ListKeyspacesRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListTablesRequestRequestTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import ListTablesRequestRequestTypeDef

def get_value() -> ListTablesRequestRequestTypeDef:
    return {
        "keyspaceName": ...,
    }
Definition
class ListTablesRequestRequestTypeDef(TypedDict):
    keyspaceName: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

TableSummaryTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import TableSummaryTypeDef

def get_value() -> TableSummaryTypeDef:
    return {
        "keyspaceName": ...,
        "tableName": ...,
        "resourceArn": ...,
    }
Definition
class TableSummaryTypeDef(TypedDict):
    keyspaceName: str,
    tableName: str,
    resourceArn: str,

ListTagsForResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
    }
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

PartitionKeyTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import PartitionKeyTypeDef

def get_value() -> PartitionKeyTypeDef:
    return {
        "name": ...,
    }
Definition
class PartitionKeyTypeDef(TypedDict):
    name: str,

StaticColumnTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import StaticColumnTypeDef

def get_value() -> StaticColumnTypeDef:
    return {
        "name": ...,
    }
Definition
class StaticColumnTypeDef(TypedDict):
    name: str,

CreateKeyspaceRequestRequestTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import CreateKeyspaceRequestRequestTypeDef

def get_value() -> CreateKeyspaceRequestRequestTypeDef:
    return {
        "keyspaceName": ...,
    }
Definition
class CreateKeyspaceRequestRequestTypeDef(TypedDict):
    keyspaceName: str,
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

TagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tags": ...,
    }
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

UntagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tags": ...,
    }
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateKeyspaceResponseTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import CreateKeyspaceResponseTypeDef

def get_value() -> CreateKeyspaceResponseTypeDef:
    return {
        "resourceArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateKeyspaceResponseTypeDef(TypedDict):
    resourceArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTableResponseTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import CreateTableResponseTypeDef

def get_value() -> CreateTableResponseTypeDef:
    return {
        "resourceArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateTableResponseTypeDef(TypedDict):
    resourceArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetKeyspaceResponseTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import GetKeyspaceResponseTypeDef

def get_value() -> GetKeyspaceResponseTypeDef:
    return {
        "keyspaceName": ...,
        "resourceArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetKeyspaceResponseTypeDef(TypedDict):
    keyspaceName: str,
    resourceArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "nextToken": ...,
        "tags": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
    nextToken: str,
    tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

RestoreTableResponseTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import RestoreTableResponseTypeDef

def get_value() -> RestoreTableResponseTypeDef:
    return {
        "restoredTableARN": ...,
        "ResponseMetadata": ...,
    }
Definition
class RestoreTableResponseTypeDef(TypedDict):
    restoredTableARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateTableResponseTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import UpdateTableResponseTypeDef

def get_value() -> UpdateTableResponseTypeDef:
    return {
        "resourceArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateTableResponseTypeDef(TypedDict):
    resourceArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RestoreTableRequestRequestTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import RestoreTableRequestRequestTypeDef

def get_value() -> RestoreTableRequestRequestTypeDef:
    return {
        "sourceKeyspaceName": ...,
        "sourceTableName": ...,
        "targetKeyspaceName": ...,
        "targetTableName": ...,
    }
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)
  1. See CapacitySpecificationTypeDef
  2. See EncryptionSpecificationTypeDef
  3. See PointInTimeRecoveryTypeDef
  4. See TagTypeDef

UpdateTableRequestRequestTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import UpdateTableRequestRequestTypeDef

def get_value() -> UpdateTableRequestRequestTypeDef:
    return {
        "keyspaceName": ...,
        "tableName": ...,
    }
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],
  1. See ColumnDefinitionTypeDef
  2. See CapacitySpecificationTypeDef
  3. See EncryptionSpecificationTypeDef
  4. See PointInTimeRecoveryTypeDef
  5. See TimeToLiveTypeDef

ListKeyspacesResponseTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import ListKeyspacesResponseTypeDef

def get_value() -> ListKeyspacesResponseTypeDef:
    return {
        "nextToken": ...,
        "keyspaces": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListKeyspacesResponseTypeDef(TypedDict):
    nextToken: str,
    keyspaces: List[KeyspaceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KeyspaceSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListKeyspacesRequestListKeyspacesPaginateTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import ListKeyspacesRequestListKeyspacesPaginateTypeDef

def get_value() -> ListKeyspacesRequestListKeyspacesPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
Definition
class ListKeyspacesRequestListKeyspacesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTablesRequestListTablesPaginateTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import ListTablesRequestListTablesPaginateTypeDef

def get_value() -> ListTablesRequestListTablesPaginateTypeDef:
    return {
        "keyspaceName": ...,
    }
Definition
class ListTablesRequestListTablesPaginateTypeDef(TypedDict):
    keyspaceName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTagsForResourceRequestListTagsForResourcePaginateTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import ListTagsForResourceRequestListTagsForResourcePaginateTypeDef

def get_value() -> ListTagsForResourceRequestListTagsForResourcePaginateTypeDef:
    return {
        "resourceArn": ...,
    }
Definition
class ListTagsForResourceRequestListTagsForResourcePaginateTypeDef(TypedDict):
    resourceArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTablesResponseTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import ListTablesResponseTypeDef

def get_value() -> ListTablesResponseTypeDef:
    return {
        "nextToken": ...,
        "tables": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTablesResponseTypeDef(TypedDict):
    nextToken: str,
    tables: List[TableSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TableSummaryTypeDef
  2. See ResponseMetadataTypeDef

SchemaDefinitionTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import SchemaDefinitionTypeDef

def get_value() -> SchemaDefinitionTypeDef:
    return {
        "allColumns": ...,
        "partitionKeys": ...,
    }
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

CreateTableRequestRequestTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import CreateTableRequestRequestTypeDef

def get_value() -> CreateTableRequestRequestTypeDef:
    return {
        "keyspaceName": ...,
        "tableName": ...,
        "schemaDefinition": ...,
    }
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)
  1. See SchemaDefinitionTypeDef
  2. See CommentTypeDef
  3. See CapacitySpecificationTypeDef
  4. See EncryptionSpecificationTypeDef
  5. See PointInTimeRecoveryTypeDef
  6. See TimeToLiveTypeDef
  7. See TagTypeDef

GetTableResponseTypeDef

Usage Example
from mypy_boto3_keyspaces.type_defs import GetTableResponseTypeDef

def get_value() -> GetTableResponseTypeDef:
    return {
        "keyspaceName": ...,
        "tableName": ...,
        "resourceArn": ...,
        "creationTimestamp": ...,
        "status": ...,
        "schemaDefinition": ...,
        "capacitySpecification": ...,
        "encryptionSpecification": ...,
        "pointInTimeRecovery": ...,
        "ttl": ...,
        "defaultTimeToLive": ...,
        "comment": ...,
        "ResponseMetadata": ...,
    }
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)
    ResponseMetadata: ResponseMetadataTypeDef,  # (8)
  1. See TableStatusType
  2. See SchemaDefinitionTypeDef
  3. See CapacitySpecificationSummaryTypeDef
  4. See EncryptionSpecificationTypeDef
  5. See PointInTimeRecoverySummaryTypeDef
  6. See TimeToLiveTypeDef
  7. See CommentTypeDef
  8. See ResponseMetadataTypeDef