Type annotations for boto3.DynamoDB 1.20.49 service generated by mypy-boto3-builder 6.4.2
Project description
mypy-boto3-dynamodb
Type annotations for boto3.DynamoDB 1.20.49 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.
Generated by mypy-boto3-builder 6.4.2.
More information can be found on boto3-stubs page and in mypy-boto3-dynamodb docs
See how it helps to find and fix potential bugs:
- mypy-boto3-dynamodb
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 DynamoDB
.
From PyPI with pip
Install boto3-stubs
for DynamoDB
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[dynamodb]'
# 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[dynamodb]'
# standalone installation
python -m pip install mypy-boto3-dynamodb
From conda-forge
Installing mypy-boto3-dynamodb
from the conda-forge
channel can be achieved
by adding conda-forge
to your channels with:
conda config --add channels conda-forge
conda config --set channel_priority strict
Once the conda-forge
channel has been enabled, mypy-boto3-dynamodb
can be
installed with:
conda install mypy-boto3-dynamodb
It is possible to list all of the versions of mypy-boto3-dynamodb
available
on your platform with:
conda search mypy-boto3-dynamodb --channel conda-forge
Usage
VSCode
- Install Python extension
- Install Pylance extension
- Set
Pylance
as your Python Language Server - Install
boto3-stubs[dynamodb]
in your environment:python -m pip install 'boto3-stubs[dynamodb]'
Both type checking and auto-complete should work for DynamoDB
service. No
explicit type annotations required, write your boto3
code as usual.
PyCharm
- Install
boto3-stubs[dynamodb]
in your environment:python -m pip install 'boto3-stubs[dynamodb]'
Both type checking and auto-complete should work for DynamoDB
service. No
explicit type annotations required, write your boto3
code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed
boto3-stubs
submodules.
Other IDEs
Not tested, but as long as your IDE supports mypy
or pyright
, everything
should work.
mypy
- Install
mypy
:python -m pip install mypy
- Install
boto3-stubs[dynamodb]
in your environment:python -m pip install 'boto3-stubs[dynamodb]'
- Run
mypy
as usual
Type checking should work for DynamoDB
service. No explicit type annotations
required, write your boto3
code as usual.
pyright
- Install
pyright
:yarn global add pyright
- Install
boto3-stubs[dynamodb]
in your environment:python -m pip install 'boto3-stubs[dynamodb]'
- Optionally, you can install
boto3-stubs
totypings
folder.
Type checking should work for DynamoDB
service. No explicit type annotations
required, write your boto3
code as usual.
Explicit type annotations
Client annotations
DynamoDBClient
provides annotations for boto3.client("dynamodb")
.
from boto3.session import Session
from mypy_boto3_dynamodb import DynamoDBClient
client: DynamoDBClient = Session().client("dynamodb")
# now client usage is checked by mypy and IDE should provide code auto-complete
Paginators annotations
mypy_boto3_dynamodb.paginator
module contains type annotations for all
paginators.
from boto3.session import Session
from mypy_boto3_dynamodb import DynamoDBClient
from mypy_boto3_dynamodb.paginator import (
ListBackupsPaginator,
ListTablesPaginator,
ListTagsOfResourcePaginator,
QueryPaginator,
ScanPaginator,
)
client: DynamoDBClient = Session().client("dynamodb")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_backups_paginator: ListBackupsPaginator = client.get_paginator("list_backups")
list_tables_paginator: ListTablesPaginator = client.get_paginator("list_tables")
list_tags_of_resource_paginator: ListTagsOfResourcePaginator = client.get_paginator("list_tags_of_resource")
query_paginator: QueryPaginator = client.get_paginator("query")
scan_paginator: ScanPaginator = client.get_paginator("scan")
Waiters annotations
mypy_boto3_dynamodb.waiter
module contains type annotations for all waiters.
from boto3.session import Session
from mypy_boto3_dynamodb import DynamoDBClient
from mypy_boto3_dynamodb.waiter import (
TableExistsWaiter,
TableNotExistsWaiter,
)
client: DynamoDBClient = Session().client("dynamodb")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
table_exists_waiter: TableExistsWaiter = client.get_waiter("table_exists")
table_not_exists_waiter: TableNotExistsWaiter = client.get_waiter("table_not_exists")
Service Resource annotations
DynamoDBServiceResource
provides annotations for
boto3.resource("dynamodb")
.
from boto3.session import Session
from mypy_boto3_dynamodb import DynamoDBServiceResource
resource: DynamoDBServiceResource = Session().resource("dynamodb")
# now resource usage is checked by mypy and IDE should provide code auto-complete
Other resources annotations
mypy_boto3_dynamodb.service_resource
module contains type annotations for all
resources.
from boto3.session import Session
from mypy_boto3_dynamodb import DynamoDBServiceResource
from mypy_boto3_dynamodb.service_resource import (
Table,
)
resource: DynamoDBServiceResource = Session().resource("dynamodb")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
my_table: Table = resource.Table(...)
Collections annotations
mypy_boto3_dynamodb.service_resource
module contains type annotations for all
DynamoDBServiceResource
collections.
from boto3.session import Session
from mypy_boto3_dynamodb import DynamoDBServiceResource
from mypy_boto3_dynamodb.service_resource import (
ServiceResourceTablesCollection,
)
resource: DynamoDBServiceResource = Session().resource("dynamodb")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
tables: dynamodb_resources.ServiceResourceTablesCollection = resource.tables
Literals
mypy_boto3_dynamodb.literals
module contains literals extracted from shapes
that can be used in user code for type checking.
from mypy_boto3_dynamodb.literals import (
AttributeActionType,
BackupStatusType,
BackupTypeFilterType,
BackupTypeType,
BatchStatementErrorCodeEnumType,
BillingModeType,
ComparisonOperatorType,
ConditionalOperatorType,
ContinuousBackupsStatusType,
ContributorInsightsActionType,
ContributorInsightsStatusType,
DestinationStatusType,
ExportFormatType,
ExportStatusType,
GlobalTableStatusType,
IndexStatusType,
KeyTypeType,
ListBackupsPaginatorName,
ListTablesPaginatorName,
ListTagsOfResourcePaginatorName,
PointInTimeRecoveryStatusType,
ProjectionTypeType,
QueryPaginatorName,
ReplicaStatusType,
ReturnConsumedCapacityType,
ReturnItemCollectionMetricsType,
ReturnValueType,
ReturnValuesOnConditionCheckFailureType,
S3SseAlgorithmType,
SSEStatusType,
SSETypeType,
ScalarAttributeTypeType,
ScanPaginatorName,
SelectType,
StreamViewTypeType,
TableClassType,
TableExistsWaiterName,
TableNotExistsWaiterName,
TableStatusType,
TimeToLiveStatusType,
ServiceName,
PaginatorName,
WaiterName,
)
def check_value(value: AttributeActionType) -> bool:
...
Typed dictionaries
mypy_boto3_dynamodb.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
from mypy_boto3_dynamodb.type_defs import (
ArchivalSummaryResponseMetadataTypeDef,
ArchivalSummaryTypeDef,
AttributeDefinitionTypeDef,
AttributeValueUpdateTypeDef,
AutoScalingPolicyDescriptionTypeDef,
AutoScalingPolicyUpdateTypeDef,
AutoScalingSettingsDescriptionTypeDef,
AutoScalingSettingsUpdateTypeDef,
AutoScalingTargetTrackingScalingPolicyConfigurationDescriptionTypeDef,
AutoScalingTargetTrackingScalingPolicyConfigurationUpdateTypeDef,
BackupDescriptionTypeDef,
BackupDetailsTypeDef,
BackupSummaryTypeDef,
BatchExecuteStatementInputRequestTypeDef,
BatchExecuteStatementOutputTypeDef,
BatchGetItemInputRequestTypeDef,
BatchGetItemInputServiceResourceTypeDef,
BatchGetItemOutputTypeDef,
BatchStatementErrorTypeDef,
BatchStatementRequestTypeDef,
BatchStatementResponseTypeDef,
BatchWriteItemInputRequestTypeDef,
BatchWriteItemInputServiceResourceTypeDef,
BatchWriteItemOutputTypeDef,
BillingModeSummaryResponseMetadataTypeDef,
BillingModeSummaryTypeDef,
CapacityTypeDef,
ConditionCheckTypeDef,
ConditionTypeDef,
ConsumedCapacityTypeDef,
ContinuousBackupsDescriptionTypeDef,
ContributorInsightsSummaryTypeDef,
CreateBackupInputRequestTypeDef,
CreateBackupOutputTypeDef,
CreateGlobalSecondaryIndexActionTypeDef,
CreateGlobalTableInputRequestTypeDef,
CreateGlobalTableOutputTypeDef,
CreateReplicaActionTypeDef,
CreateReplicationGroupMemberActionTypeDef,
CreateTableInputRequestTypeDef,
CreateTableInputServiceResourceTypeDef,
CreateTableOutputTypeDef,
DeleteBackupInputRequestTypeDef,
DeleteBackupOutputTypeDef,
DeleteGlobalSecondaryIndexActionTypeDef,
DeleteItemInputRequestTypeDef,
DeleteItemInputTableTypeDef,
DeleteItemOutputTypeDef,
DeleteReplicaActionTypeDef,
DeleteReplicationGroupMemberActionTypeDef,
DeleteRequestTypeDef,
DeleteTableInputRequestTypeDef,
DeleteTableOutputTypeDef,
DeleteTypeDef,
DescribeBackupInputRequestTypeDef,
DescribeBackupOutputTypeDef,
DescribeContinuousBackupsInputRequestTypeDef,
DescribeContinuousBackupsOutputTypeDef,
DescribeContributorInsightsInputRequestTypeDef,
DescribeContributorInsightsOutputTypeDef,
DescribeEndpointsResponseTypeDef,
DescribeExportInputRequestTypeDef,
DescribeExportOutputTypeDef,
DescribeGlobalTableInputRequestTypeDef,
DescribeGlobalTableOutputTypeDef,
DescribeGlobalTableSettingsInputRequestTypeDef,
DescribeGlobalTableSettingsOutputTypeDef,
DescribeKinesisStreamingDestinationInputRequestTypeDef,
DescribeKinesisStreamingDestinationOutputTypeDef,
DescribeLimitsOutputTypeDef,
DescribeTableInputRequestTypeDef,
DescribeTableOutputTypeDef,
DescribeTableReplicaAutoScalingInputRequestTypeDef,
DescribeTableReplicaAutoScalingOutputTypeDef,
DescribeTimeToLiveInputRequestTypeDef,
DescribeTimeToLiveOutputTypeDef,
EndpointTypeDef,
ExecuteStatementInputRequestTypeDef,
ExecuteStatementOutputTypeDef,
ExecuteTransactionInputRequestTypeDef,
ExecuteTransactionOutputTypeDef,
ExpectedAttributeValueTypeDef,
ExportDescriptionTypeDef,
ExportSummaryTypeDef,
ExportTableToPointInTimeInputRequestTypeDef,
ExportTableToPointInTimeOutputTypeDef,
FailureExceptionTypeDef,
GetItemInputRequestTypeDef,
GetItemInputTableTypeDef,
GetItemOutputTypeDef,
GetTypeDef,
GlobalSecondaryIndexAutoScalingUpdateTypeDef,
GlobalSecondaryIndexDescriptionTypeDef,
GlobalSecondaryIndexInfoTypeDef,
GlobalSecondaryIndexTypeDef,
GlobalSecondaryIndexUpdateTypeDef,
GlobalTableDescriptionTypeDef,
GlobalTableGlobalSecondaryIndexSettingsUpdateTypeDef,
GlobalTableTypeDef,
ItemCollectionMetricsTypeDef,
ItemResponseTypeDef,
KeySchemaElementTypeDef,
KeysAndAttributesTypeDef,
KinesisDataStreamDestinationTypeDef,
KinesisStreamingDestinationInputRequestTypeDef,
KinesisStreamingDestinationOutputTypeDef,
ListBackupsInputRequestTypeDef,
ListBackupsOutputTypeDef,
ListContributorInsightsInputRequestTypeDef,
ListContributorInsightsOutputTypeDef,
ListExportsInputRequestTypeDef,
ListExportsOutputTypeDef,
ListGlobalTablesInputRequestTypeDef,
ListGlobalTablesOutputTypeDef,
ListTablesInputRequestTypeDef,
ListTablesOutputTypeDef,
ListTagsOfResourceInputRequestTypeDef,
ListTagsOfResourceOutputTypeDef,
LocalSecondaryIndexDescriptionTypeDef,
LocalSecondaryIndexInfoTypeDef,
LocalSecondaryIndexTypeDef,
PaginatorConfigTypeDef,
ParameterizedStatementTypeDef,
PointInTimeRecoveryDescriptionTypeDef,
PointInTimeRecoverySpecificationTypeDef,
ProjectionTypeDef,
ProvisionedThroughputDescriptionResponseMetadataTypeDef,
ProvisionedThroughputDescriptionTypeDef,
ProvisionedThroughputOverrideTypeDef,
ProvisionedThroughputTypeDef,
PutItemInputRequestTypeDef,
PutItemInputTableTypeDef,
PutItemOutputTypeDef,
PutRequestTypeDef,
PutTypeDef,
QueryInputRequestTypeDef,
QueryInputTableTypeDef,
QueryOutputTypeDef,
ReplicaAutoScalingDescriptionTypeDef,
ReplicaAutoScalingUpdateTypeDef,
ReplicaDescriptionTypeDef,
ReplicaGlobalSecondaryIndexAutoScalingDescriptionTypeDef,
ReplicaGlobalSecondaryIndexAutoScalingUpdateTypeDef,
ReplicaGlobalSecondaryIndexDescriptionTypeDef,
ReplicaGlobalSecondaryIndexSettingsDescriptionTypeDef,
ReplicaGlobalSecondaryIndexSettingsUpdateTypeDef,
ReplicaGlobalSecondaryIndexTypeDef,
ReplicaSettingsDescriptionTypeDef,
ReplicaSettingsUpdateTypeDef,
ReplicaTypeDef,
ReplicaUpdateTypeDef,
ReplicationGroupUpdateTypeDef,
ResponseMetadataTypeDef,
RestoreSummaryResponseMetadataTypeDef,
RestoreSummaryTypeDef,
RestoreTableFromBackupInputRequestTypeDef,
RestoreTableFromBackupOutputTypeDef,
RestoreTableToPointInTimeInputRequestTypeDef,
RestoreTableToPointInTimeOutputTypeDef,
SSEDescriptionResponseMetadataTypeDef,
SSEDescriptionTypeDef,
SSESpecificationTypeDef,
ScanInputRequestTypeDef,
ScanInputTableTypeDef,
ScanOutputTypeDef,
ServiceResourceTableRequestTypeDef,
SourceTableDetailsTypeDef,
SourceTableFeatureDetailsTypeDef,
StreamSpecificationResponseMetadataTypeDef,
StreamSpecificationTypeDef,
TableAutoScalingDescriptionTypeDef,
TableBatchWriterRequestTypeDef,
TableClassSummaryResponseMetadataTypeDef,
TableClassSummaryTypeDef,
TableDescriptionTypeDef,
TagResourceInputRequestTypeDef,
TagTypeDef,
TimeToLiveDescriptionTypeDef,
TimeToLiveSpecificationTypeDef,
TransactGetItemTypeDef,
TransactGetItemsInputRequestTypeDef,
TransactGetItemsOutputTypeDef,
TransactWriteItemTypeDef,
TransactWriteItemsInputRequestTypeDef,
TransactWriteItemsOutputTypeDef,
UntagResourceInputRequestTypeDef,
UpdateContinuousBackupsInputRequestTypeDef,
UpdateContinuousBackupsOutputTypeDef,
UpdateContributorInsightsInputRequestTypeDef,
UpdateContributorInsightsOutputTypeDef,
UpdateGlobalSecondaryIndexActionTypeDef,
UpdateGlobalTableInputRequestTypeDef,
UpdateGlobalTableOutputTypeDef,
UpdateGlobalTableSettingsInputRequestTypeDef,
UpdateGlobalTableSettingsOutputTypeDef,
UpdateItemInputRequestTypeDef,
UpdateItemInputTableTypeDef,
UpdateItemOutputTypeDef,
UpdateReplicationGroupMemberActionTypeDef,
UpdateTableInputRequestTypeDef,
UpdateTableInputTableTypeDef,
UpdateTableOutputTypeDef,
UpdateTableReplicaAutoScalingInputRequestTypeDef,
UpdateTableReplicaAutoScalingOutputTypeDef,
UpdateTimeToLiveInputRequestTypeDef,
UpdateTimeToLiveOutputTypeDef,
UpdateTypeDef,
WaiterConfigTypeDef,
WriteRequestTypeDef,
)
def get_structure() -> ArchivalSummaryResponseMetadataTypeDef:
return {
...
}
Versioning
mypy-boto3-dynamodb
version is the same as related boto3
version and
follows PEP 440 format.
Documentation
All type annotations can be found in mypy-boto3-dynamodb docs
Support and contributing
This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-dynamodb-1.20.49.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1688e4040932f199c3842ab0f5e23f933766004ed9dabdef84d6faf0732ec020 |
|
MD5 | d092e64d66d2e3b8f2f42fa7d8ed97a7 |
|
BLAKE2b-256 | db7405ca1d0d2f1956788a2489adf97ccd4f1b5534debc5c4eea38f88f887f72 |
Hashes for mypy_boto3_dynamodb-1.20.49-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9031ded4c19aed1865e2a22ee1e45ae093cd5e6a8062efee47902ad8d207bb6c |
|
MD5 | dc45c581faede905d89bba22ab2bd5fb |
|
BLAKE2b-256 | 7dd5e0b6335ef0b1ef11e5fa8c4cbc46bf374fcc237606b6e1cddb29f46b426b |