Keyspaces module#
Index > Keyspaces
Auto-generated documentation for Keyspaces type annotations stubs module mypy-boto3-keyspaces.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and Keyspaces
.
From PyPI with pip#
Install boto3-stubs
for Keyspaces
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[keyspaces]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[keyspaces]'
# standalone installation
python -m pip install mypy-boto3-keyspaces
How to uninstall#
python -m pip uninstall -y mypy-boto3-keyspaces
Usage#
Code samples can be found in Examples.
KeyspacesClient#
Type annotations and code completion for boto3.client("keyspaces")
as KeyspacesClient
boto3 documentation
# KeyspacesClient usage example
from boto3.session import Session
from mypy_boto3_keyspaces.client import KeyspacesClient
def get_client() -> KeyspacesClient:
return Session().client("keyspaces")
Paginators#
Type annotations and code completion for paginators
from boto3.client("keyspaces").get_paginator("...")
.
# ListKeyspacesPaginator usage example
from boto3.session import Session
from mypy_boto3_keyspaces.paginator import ListKeyspacesPaginator
def get_list_keyspaces_paginator() -> ListKeyspacesPaginator:
return Session().client("keyspaces").get_paginator("list_keyspaces"))
Literals#
Type annotations for literals used in methods and schemas.
# ClientSideTimestampsStatusType usage example
from mypy_boto3_keyspaces.literals import ClientSideTimestampsStatusType
def get_value() -> ClientSideTimestampsStatusType:
return "ENABLED"
- ClientSideTimestampsStatusType
- EncryptionTypeType
- ListKeyspacesPaginatorName
- ListTablesPaginatorName
- ListTagsForResourcePaginatorName
- PointInTimeRecoveryStatusType
- SortOrderType
- TableStatusType
- ThroughputModeType
- TimeToLiveStatusType
- KeyspacesServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# CapacitySpecificationSummaryTypeDef usage example
from mypy_boto3_keyspaces.type_defs import CapacitySpecificationSummaryTypeDef
def get_value() -> CapacitySpecificationSummaryTypeDef:
return {
"throughputMode": ...,
}
- CapacitySpecificationSummaryTypeDef
- CapacitySpecificationTypeDef
- ClientSideTimestampsTypeDef
- ClusteringKeyTypeDef
- ColumnDefinitionTypeDef
- CommentTypeDef
- TagTypeDef
- CreateKeyspaceResponseTypeDef
- EncryptionSpecificationTypeDef
- PointInTimeRecoveryTypeDef
- TimeToLiveTypeDef
- CreateTableResponseTypeDef
- DeleteKeyspaceRequestRequestTypeDef
- DeleteTableRequestRequestTypeDef
- GetKeyspaceRequestRequestTypeDef
- GetKeyspaceResponseTypeDef
- GetTableRequestRequestTypeDef
- PointInTimeRecoverySummaryTypeDef
- KeyspaceSummaryTypeDef
- ListKeyspacesRequestListKeyspacesPaginateTypeDef
- ListKeyspacesRequestRequestTypeDef
- ListTablesRequestListTablesPaginateTypeDef
- ListTablesRequestRequestTypeDef
- TableSummaryTypeDef
- ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
- ListTagsForResourceRequestRequestTypeDef
- PaginatorConfigTypeDef
- PartitionKeyTypeDef
- ResponseMetadataTypeDef
- RestoreTableResponseTypeDef
- StaticColumnTypeDef
- UpdateTableResponseTypeDef
- CreateKeyspaceRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- RestoreTableRequestRequestTypeDef
- UpdateTableRequestRequestTypeDef
- ListKeyspacesResponseTypeDef
- ListTablesResponseTypeDef
- SchemaDefinitionTypeDef
- CreateTableRequestRequestTypeDef
- GetTableResponseTypeDef