DynamoDB module#
Index > DynamoDB
Auto-generated documentation for DynamoDB type annotations stubs module types-aiobotocore-dynamodb.
How to install#
From PyPI with pip#
Install types-aiobotocore
for DynamoDB
service.
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[dynamodb]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[dynamodb]'
# standalone installation
python -m pip install types-aiobotocore-dynamodb
How to uninstall#
python -m pip uninstall -y types-aiobotocore-dynamodb
Usage#
Code samples can be found in Examples.
DynamoDBClient#
Type annotations and code completion for session.create_client("dynamodb")
as DynamoDBClient
boto3 documentation
# DynamoDBClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_dynamodb.client import DynamoDBClient
session = get_session()
async with session.create_client("dynamodb") as client:
client: DynamoDBClient
Paginators#
Type annotations and code completion for
paginators
from session.create_client("dynamodb").get_paginator("...")
.
# ListBackupsPaginator usage example
from types_aiobotocore_dynamodb.paginator import ListBackupsPaginator
def get_list_backups_paginator() -> ListBackupsPaginator:
return client.get_paginator("list_backups"))
Waiters#
Type annotations and code completion for
waiters
from session.create_client("dynamodb").get_waiter("...")
.
# TableExistsWaiter usage example
from types_aiobotocore_dynamodb.waiter import TableExistsWaiter
def get_table_exists_waiter() -> TableExistsWaiter:
return Session().client("dynamodb").get_waiter("table_exists")
DynamoDBServiceResource#
Type annotations and code completion for session.resource("dynamodb")
as
DynamoDBServiceResource
boto3 documentation
# DynamoDBServiceResource usage example
from types_aiobotocore_dynamodb.service_resource import DynamoDBServiceResource
Collections#
Type annotations and code completion for collections
from session.resource("dynamodb").*
.
# ServiceResourceTablesCollection usage example
from types_aiobotocore_dynamodb.service_resource import ServiceResourceTablesCollection
def get_collection() -> ServiceResourceTablesCollection:
return resource.tables
Resources#
Type annotations and code completion for additional resources
from session.resource("dynamodb").*
.
# Table usage example
from types_aiobotocore_dynamodb.service_resource import Table
def get_resource() -> Table:
return resource.Table(...)
Literals#
Type annotations for literals used in methods and schema.
# AttributeActionType usage example
from types_aiobotocore_dynamodb.literals import AttributeActionType
def get_value() -> AttributeActionType:
return "ADD"
- AttributeActionType
- BackupStatusType
- BackupTypeFilterType
- BackupTypeType
- BatchStatementErrorCodeEnumType
- BillingModeType
- ComparisonOperatorType
- ConditionalOperatorType
- ContinuousBackupsStatusType
- ContributorInsightsActionType
- ContributorInsightsStatusType
- DestinationStatusType
- ExportFormatType
- ExportStatusType
- GlobalTableStatusType
- ImportStatusType
- IndexStatusType
- InputCompressionTypeType
- InputFormatType
- KeyTypeType
- ListBackupsPaginatorName
- ListTablesPaginatorName
- ListTagsOfResourcePaginatorName
- PointInTimeRecoveryStatusType
- ProjectionTypeType
- QueryPaginatorName
- ReplicaStatusType
- ReturnConsumedCapacityType
- ReturnItemCollectionMetricsType
- ReturnValueType
- ReturnValuesOnConditionCheckFailureType
- S3SseAlgorithmType
- SSEStatusType
- SSETypeType
- ScalarAttributeTypeType
- ScanPaginatorName
- SelectType
- StreamViewTypeType
- TableClassType
- TableExistsWaiterName
- TableNotExistsWaiterName
- TableStatusType
- TimeToLiveStatusType
- DynamoDBServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- ResponseMetadataTypeDef
- ArchivalSummaryTypeDef
- AttributeDefinitionTypeDef
- AttributeValueTypeDef
- TableAttributeValueTypeDef
- AutoScalingTargetTrackingScalingPolicyConfigurationDescriptionTypeDef
- AutoScalingTargetTrackingScalingPolicyConfigurationUpdateTypeDef
- BackupDetailsTypeDef
- BackupSummaryTypeDef
- BillingModeSummaryTypeDef
- CapacityTypeDef
- ConditionBaseImportTypeDef
- PointInTimeRecoveryDescriptionTypeDef
- ContributorInsightsSummaryTypeDef
- CreateBackupInputRequestTypeDef
- KeySchemaElementTypeDef
- ProjectionTableTypeDef
- ProvisionedThroughputTypeDef
- ProjectionTypeDef
- ReplicaTypeDef
- CreateReplicaActionTypeDef
- ProvisionedThroughputOverrideTypeDef
- SSESpecificationTypeDef
- StreamSpecificationTypeDef
- TagTypeDef
- CsvOptionsTypeDef
- DeleteBackupInputRequestTypeDef
- DeleteGlobalSecondaryIndexActionTypeDef
- DeleteReplicaActionTypeDef
- DeleteReplicationGroupMemberActionTypeDef
- DeleteTableInputRequestTypeDef
- DescribeBackupInputRequestTypeDef
- DescribeContinuousBackupsInputRequestTypeDef
- DescribeContributorInsightsInputRequestTypeDef
- FailureExceptionTypeDef
- EndpointTypeDef
- DescribeExportInputRequestTypeDef
- ExportDescriptionTypeDef
- DescribeGlobalTableInputRequestTypeDef
- DescribeGlobalTableSettingsInputRequestTypeDef
- DescribeImportInputRequestTypeDef
- DescribeKinesisStreamingDestinationInputRequestTypeDef
- KinesisDataStreamDestinationTypeDef
- DescribeTableInputRequestTypeDef
- WaiterConfigTypeDef
- DescribeTableReplicaAutoScalingInputRequestTypeDef
- DescribeTimeToLiveInputRequestTypeDef
- TimeToLiveDescriptionTypeDef
- ExportSummaryTypeDef
- TimestampTypeDef
- ProvisionedThroughputDescriptionTypeDef
- S3BucketSourceTypeDef
- KinesisStreamingDestinationInputRequestTypeDef
- PaginatorConfigTypeDef
- ListContributorInsightsInputRequestTypeDef
- ListExportsInputRequestTypeDef
- ListGlobalTablesInputRequestTypeDef
- ListImportsInputRequestTypeDef
- ListTablesInputRequestTypeDef
- ListTagsOfResourceInputRequestTypeDef
- PointInTimeRecoverySpecificationTypeDef
- TableClassSummaryTypeDef
- RestoreSummaryTypeDef
- SSEDescriptionTypeDef
- TableBatchWriterRequestTypeDef
- TimeToLiveSpecificationTypeDef
- UntagResourceInputRequestTypeDef
- UpdateContributorInsightsInputRequestTypeDef
- ArchivalSummaryResponseTypeDef
- BillingModeSummaryResponseTypeDef
- DescribeLimitsOutputTypeDef
- EmptyResponseMetadataTypeDef
- KinesisStreamingDestinationOutputTypeDef
- ListTablesOutputTypeDef
- ProvisionedThroughputDescriptionResponseTypeDef
- RestoreSummaryResponseTypeDef
- SSEDescriptionResponseTypeDef
- StreamSpecificationResponseTypeDef
- TableClassSummaryResponseTypeDef
- UpdateContributorInsightsOutputTypeDef
- BatchStatementErrorTypeDef
- ItemCollectionMetricsTypeDef
- ItemResponseTypeDef
- UniversalAttributeValueTypeDef
- AttributeValueUpdateTableTypeDef
- ConditionTableTypeDef
- DeleteRequestServiceResourceTypeDef
- ExpectedAttributeValueTableTypeDef
- GetItemInputTableGetItemTypeDef
- ItemCollectionMetricsServiceResourceTypeDef
- ItemCollectionMetricsTableTypeDef
- KeysAndAttributesServiceResourceTypeDef
- PutRequestServiceResourceTypeDef
- AutoScalingPolicyDescriptionTypeDef
- AutoScalingPolicyUpdateTypeDef
- CreateBackupOutputTypeDef
- ListBackupsOutputTypeDef
- ConsumedCapacityTypeDef
- ContinuousBackupsDescriptionTypeDef
- ListContributorInsightsOutputTypeDef
- LocalSecondaryIndexDescriptionTableTypeDef
- CreateGlobalSecondaryIndexActionTableTypeDef
- SourceTableDetailsTypeDef
- UpdateGlobalSecondaryIndexActionTypeDef
- CreateGlobalSecondaryIndexActionTypeDef
- GlobalSecondaryIndexInfoTypeDef
- GlobalSecondaryIndexTypeDef
- LocalSecondaryIndexDescriptionTypeDef
- LocalSecondaryIndexInfoTypeDef
- LocalSecondaryIndexTypeDef
- CreateGlobalTableInputRequestTypeDef
- GlobalTableTypeDef
- ReplicaGlobalSecondaryIndexDescriptionTypeDef
- ReplicaGlobalSecondaryIndexTypeDef
- ListTagsOfResourceOutputTypeDef
- TagResourceInputRequestTypeDef
- InputFormatOptionsTypeDef
- ReplicaUpdateTypeDef
- DescribeContributorInsightsOutputTypeDef
- DescribeEndpointsResponseTypeDef
- DescribeExportOutputTypeDef
- ExportTableToPointInTimeOutputTypeDef
- DescribeKinesisStreamingDestinationOutputTypeDef
- DescribeTableInputTableExistsWaitTypeDef
- DescribeTableInputTableNotExistsWaitTypeDef
- DescribeTimeToLiveOutputTypeDef
- ListExportsOutputTypeDef
- ExportTableToPointInTimeInputRequestTypeDef
- ListBackupsInputRequestTypeDef
- GlobalSecondaryIndexDescriptionTableTypeDef
- GlobalSecondaryIndexDescriptionTypeDef
- ImportSummaryTypeDef
- ListBackupsInputListBackupsPaginateTypeDef
- ListTablesInputListTablesPaginateTypeDef
- ListTagsOfResourceInputListTagsOfResourcePaginateTypeDef
- UpdateContinuousBackupsInputRequestTypeDef
- UpdateTimeToLiveInputRequestTypeDef
- UpdateTimeToLiveOutputTypeDef
- BatchStatementResponseTypeDef
- AttributeValueUpdateTypeDef
- BatchStatementRequestTypeDef
- ConditionCheckTypeDef
- ConditionTypeDef
- DeleteRequestTypeDef
- DeleteTypeDef
- ExecuteStatementInputRequestTypeDef
- ExpectedAttributeValueTypeDef
- GetItemInputRequestTypeDef
- GetTypeDef
- KeysAndAttributesTypeDef
- ParameterizedStatementTypeDef
- PutRequestTypeDef
- PutTypeDef
- UpdateTypeDef
- QueryInputQueryPaginateTypeDef
- QueryInputTableQueryTypeDef
- ScanInputScanPaginateTypeDef
- ScanInputTableScanTypeDef
- DeleteItemInputTableDeleteItemTypeDef
- PutItemInputTablePutItemTypeDef
- UpdateItemInputTableUpdateItemTypeDef
- BatchGetItemInputServiceResourceBatchGetItemTypeDef
- WriteRequestServiceResourceTypeDef
- AutoScalingSettingsDescriptionTypeDef
- AutoScalingSettingsUpdateTypeDef
- BatchGetItemOutputServiceResourceTypeDef
- DeleteItemOutputTableTypeDef
- DeleteItemOutputTypeDef
- ExecuteStatementOutputTypeDef
- ExecuteTransactionOutputTypeDef
- GetItemOutputTableTypeDef
- GetItemOutputTypeDef
- PutItemOutputTableTypeDef
- PutItemOutputTypeDef
- QueryOutputTableTypeDef
- QueryOutputTypeDef
- ScanOutputTableTypeDef
- ScanOutputTypeDef
- TransactGetItemsOutputTypeDef
- TransactWriteItemsOutputTypeDef
- UpdateItemOutputTableTypeDef
- UpdateItemOutputTypeDef
- DescribeContinuousBackupsOutputTypeDef
- UpdateContinuousBackupsOutputTypeDef
- GlobalSecondaryIndexUpdateTableTypeDef
- GlobalSecondaryIndexUpdateTypeDef
- TableCreationParametersTypeDef
- SourceTableFeatureDetailsTypeDef
- CreateTableInputRequestTypeDef
- CreateTableInputServiceResourceCreateTableTypeDef
- RestoreTableFromBackupInputRequestTypeDef
- RestoreTableToPointInTimeInputRequestTypeDef
- ListGlobalTablesOutputTypeDef
- ReplicaDescriptionTypeDef
- CreateReplicationGroupMemberActionTypeDef
- UpdateReplicationGroupMemberActionTypeDef
- UpdateGlobalTableInputRequestTypeDef
- ListImportsOutputTypeDef
- BatchExecuteStatementOutputTypeDef
- BatchExecuteStatementInputRequestTypeDef
- QueryInputRequestTypeDef
- ScanInputRequestTypeDef
- DeleteItemInputRequestTypeDef
- PutItemInputRequestTypeDef
- UpdateItemInputRequestTypeDef
- TransactGetItemTypeDef
- BatchGetItemInputRequestTypeDef
- BatchGetItemOutputTypeDef
- ExecuteTransactionInputRequestTypeDef
- WriteRequestTypeDef
- TransactWriteItemTypeDef
- BatchWriteItemInputServiceResourceBatchWriteItemTypeDef
- BatchWriteItemOutputServiceResourceTypeDef
- ReplicaGlobalSecondaryIndexAutoScalingDescriptionTypeDef
- ReplicaGlobalSecondaryIndexSettingsDescriptionTypeDef
- GlobalSecondaryIndexAutoScalingUpdateTypeDef
- GlobalTableGlobalSecondaryIndexSettingsUpdateTypeDef
- ReplicaGlobalSecondaryIndexAutoScalingUpdateTypeDef
- ReplicaGlobalSecondaryIndexSettingsUpdateTypeDef
- ImportTableDescriptionTypeDef
- ImportTableInputRequestTypeDef
- BackupDescriptionTypeDef
- GlobalTableDescriptionTypeDef
- TableDescriptionTableTypeDef
- TableDescriptionTypeDef
- ReplicationGroupUpdateTypeDef
- TransactGetItemsInputRequestTypeDef
- BatchWriteItemInputRequestTypeDef
- BatchWriteItemOutputTypeDef
- TransactWriteItemsInputRequestTypeDef
- ReplicaAutoScalingDescriptionTypeDef
- ReplicaSettingsDescriptionTypeDef
- ReplicaAutoScalingUpdateTypeDef
- ReplicaSettingsUpdateTypeDef
- DescribeImportOutputTypeDef
- ImportTableOutputTypeDef
- DeleteBackupOutputTypeDef
- DescribeBackupOutputTypeDef
- CreateGlobalTableOutputTypeDef
- DescribeGlobalTableOutputTypeDef
- UpdateGlobalTableOutputTypeDef
- DeleteTableOutputTableTypeDef
- CreateTableOutputTypeDef
- DeleteTableOutputTypeDef
- DescribeTableOutputTypeDef
- RestoreTableFromBackupOutputTypeDef
- RestoreTableToPointInTimeOutputTypeDef
- UpdateTableOutputTypeDef
- UpdateTableInputRequestTypeDef
- UpdateTableInputTableUpdateTypeDef
- TableAutoScalingDescriptionTypeDef
- DescribeGlobalTableSettingsOutputTypeDef
- UpdateGlobalTableSettingsOutputTypeDef
- UpdateTableReplicaAutoScalingInputRequestTypeDef
- UpdateGlobalTableSettingsInputRequestTypeDef
- DescribeTableReplicaAutoScalingOutputTypeDef
- UpdateTableReplicaAutoScalingOutputTypeDef