DynamoDBServiceResource
Auto-generated documentation for DynamoDB type annotations stubs module mypy-boto3-dynamodb.
DynamoDBServiceResource
Type annotations and code completion for boto3.resource("dynamodb")
, included resources and collections.
boto3 documentation
from mypy_boto3_dynamodb.service_resource import DynamoDBServiceResource
def get_dynamodb_resource() -> DynamoDBServiceResource:
return boto3.resource("dynamodb")
Attributes
-
meta
: DynamoDBResourceMeta -
tables
: ServiceResourceTablesCollection
Collections
ServiceResourceTablesCollection
Provides access to Table resource.
Type annotations and code completion for boto3.resource("dynamodb").tables
collection.
boto3 documentation
from mypy_boto3_dynamodb.service_resource import ServiceResourceTablesCollection
def get_collection() -> ServiceResourceTablesCollection:
return boto3.resource("dynamodb").tables
Methods
DynamoDBServiceResource.Table method
Creates a Table resource.
Type annotations and code completion for boto3.resource("dynamodb").Table
method.
boto3 documentation
kwargs: ServiceResourceTableRequestTypeDef = { # (1)
"name": ...,
}
parent.Table(**kwargs)
DynamoDBServiceResource.batch_get_item method
The BatchGetItem
operation returns the attributes of one or more items from
one or more tables.
Type annotations and code completion for boto3.resource("dynamodb").batch_get_item
method.
boto3 documentation
def batch_get_item(
self,
*,
RequestItems: Mapping[str, KeysAndAttributesServiceResourceTypeDef], # (1)
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (2)
) -> BatchGetItemOutputServiceResourceTypeDef: # (3)
...
- See KeysAndAttributesServiceResourceTypeDef
- See ReturnConsumedCapacityType
- See BatchGetItemOutputServiceResourceTypeDef
kwargs: BatchGetItemInputServiceResourceBatchGetItemTypeDef = { # (1)
"RequestItems": ...,
}
parent.batch_get_item(**kwargs)
DynamoDBServiceResource.batch_write_item method
The BatchWriteItem
operation puts or deletes multiple items in one or more
tables.
Type annotations and code completion for boto3.resource("dynamodb").batch_write_item
method.
boto3 documentation
def batch_write_item(
self,
*,
RequestItems: Mapping[str, Sequence[WriteRequestServiceResourceTypeDef]], # (1)
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (2)
ReturnItemCollectionMetrics: ReturnItemCollectionMetricsType = ..., # (3)
) -> BatchWriteItemOutputServiceResourceTypeDef: # (4)
...
- See WriteRequestServiceResourceTypeDef
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
- See BatchWriteItemOutputServiceResourceTypeDef
kwargs: BatchWriteItemInputServiceResourceBatchWriteItemTypeDef = { # (1)
"RequestItems": ...,
}
parent.batch_write_item(**kwargs)
DynamoDBServiceResource.create_table method
The CreateTable
operation adds a new table to your account.
Type annotations and code completion for boto3.resource("dynamodb").create_table
method.
boto3 documentation
def create_table(
self,
*,
AttributeDefinitions: Sequence[AttributeDefinitionServiceResourceTypeDef], # (1)
TableName: str,
KeySchema: Sequence[KeySchemaElementServiceResourceTypeDef], # (2)
LocalSecondaryIndexes: Sequence[LocalSecondaryIndexServiceResourceTypeDef] = ..., # (3)
GlobalSecondaryIndexes: Sequence[GlobalSecondaryIndexServiceResourceTypeDef] = ..., # (4)
BillingMode: BillingModeType = ..., # (5)
ProvisionedThroughput: ProvisionedThroughputServiceResourceTypeDef = ..., # (6)
StreamSpecification: StreamSpecificationServiceResourceTypeDef = ..., # (7)
SSESpecification: SSESpecificationServiceResourceTypeDef = ..., # (8)
Tags: Sequence[TagServiceResourceTypeDef] = ..., # (9)
TableClass: TableClassType = ..., # (10)
DeletionProtectionEnabled: bool = ...,
) -> Table:
...
- See AttributeDefinitionServiceResourceTypeDef
- See KeySchemaElementServiceResourceTypeDef
- See LocalSecondaryIndexServiceResourceTypeDef
- See GlobalSecondaryIndexServiceResourceTypeDef
- See BillingModeType
- See ProvisionedThroughputServiceResourceTypeDef
- See StreamSpecificationServiceResourceTypeDef
- See SSESpecificationServiceResourceTypeDef
- See TagServiceResourceTypeDef
- See TableClassType
kwargs: CreateTableInputServiceResourceCreateTableTypeDef = { # (1)
"AttributeDefinitions": ...,
"TableName": ...,
"KeySchema": ...,
}
parent.create_table(**kwargs)
DynamoDBServiceResource.get_available_subresources method
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for boto3.resource("dynamodb").get_available_subresources
method.
boto3 documentation
Table
Type annotations and code completion for boto3.resource("dynamodb").Table
class.
boto3 documentation
from mypy_boto3_dynamodb.service_resource import Table
def get_resource() -> Table:
return boto3.resource("dynamodb").Table(...)
Table attributes
attribute_definitions
:List
[AttributeDefinitionTableTypeDef]table_name
:str
key_schema
:List
[KeySchemaElementTableTypeDef]table_status
: TableStatusTypecreation_date_time
:datetime
provisioned_throughput
: ProvisionedThroughputDescriptionResponseMetadataTypeDeftable_size_bytes
:int
item_count
:int
table_arn
:str
table_id
:str
billing_mode_summary
: BillingModeSummaryResponseMetadataTypeDeflocal_secondary_indexes
:List
[LocalSecondaryIndexDescriptionTableTypeDef]global_secondary_indexes
:List
[GlobalSecondaryIndexDescriptionTableTypeDef]stream_specification
: StreamSpecificationResponseMetadataTypeDeflatest_stream_label
:str
latest_stream_arn
:str
global_table_version
:str
replicas
:List
[ReplicaDescriptionTableTypeDef]restore_summary
: RestoreSummaryResponseMetadataTypeDefsse_description
: SSEDescriptionResponseMetadataTypeDefarchival_summary
: ArchivalSummaryResponseMetadataTypeDeftable_class_summary
: TableClassSummaryResponseMetadataTypeDefdeletion_protection_enabled
:bool
name
:str
Table methods
Table.batch_writer method
Create a batch writer object.
Type annotations and code completion for boto3.resource("dynamodb").batch_writer
method.
boto3 documentation
kwargs: TableBatchWriterRequestTypeDef = { # (1)
"overwrite_by_pkeys": ...,
}
parent.batch_writer(**kwargs)
Table.delete method
The DeleteTable
operation deletes a table and all of its items.
Type annotations and code completion for boto3.resource("dynamodb").delete
method.
boto3 documentation
Table.delete_item method
Deletes a single item in a table by primary key.
Type annotations and code completion for boto3.resource("dynamodb").delete_item
method.
boto3 documentation
def delete_item(
self,
*,
Key: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
Expected: Mapping[str, ExpectedAttributeValueTableTypeDef] = ..., # (1)
ConditionalOperator: ConditionalOperatorType = ..., # (2)
ReturnValues: ReturnValueType = ..., # (3)
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (4)
ReturnItemCollectionMetrics: ReturnItemCollectionMetricsType = ..., # (5)
ConditionExpression: Union[str, ConditionBase] = ...,
ExpressionAttributeNames: Mapping[str, str] = ...,
ExpressionAttributeValues: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]] = ...,
) -> DeleteItemOutputTableTypeDef: # (6)
...
- See ExpectedAttributeValueTableTypeDef
- See ConditionalOperatorType
- See ReturnValueType
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
- See DeleteItemOutputTableTypeDef
kwargs: DeleteItemInputTableDeleteItemTypeDef = { # (1)
"Key": ...,
}
parent.delete_item(**kwargs)
Table.get_available_subresources method
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for boto3.resource("dynamodb").get_available_subresources
method.
boto3 documentation
Table.get_item method
The GetItem
operation returns a set of attributes for the item with the given
primary key.
Type annotations and code completion for boto3.resource("dynamodb").get_item
method.
boto3 documentation
def get_item(
self,
*,
Key: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
AttributesToGet: Sequence[str] = ...,
ConsistentRead: bool = ...,
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (1)
ProjectionExpression: str = ...,
ExpressionAttributeNames: Mapping[str, str] = ...,
) -> GetItemOutputTableTypeDef: # (2)
...
kwargs: GetItemInputTableGetItemTypeDef = { # (1)
"Key": ...,
}
parent.get_item(**kwargs)
Table.load method
Calls meth:DynamoDB.Client.describe_table
to update the attributes of the
Table resource.
Type annotations and code completion for boto3.resource("dynamodb").load
method.
boto3 documentation
Table.put_item method
Creates a new item, or replaces an old item with a new item.
Type annotations and code completion for boto3.resource("dynamodb").put_item
method.
boto3 documentation
def put_item(
self,
*,
Item: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
Expected: Mapping[str, ExpectedAttributeValueTableTypeDef] = ..., # (1)
ReturnValues: ReturnValueType = ..., # (2)
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (3)
ReturnItemCollectionMetrics: ReturnItemCollectionMetricsType = ..., # (4)
ConditionalOperator: ConditionalOperatorType = ..., # (5)
ConditionExpression: Union[str, ConditionBase] = ...,
ExpressionAttributeNames: Mapping[str, str] = ...,
ExpressionAttributeValues: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]] = ...,
) -> PutItemOutputTableTypeDef: # (6)
...
- See ExpectedAttributeValueTableTypeDef
- See ReturnValueType
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
- See ConditionalOperatorType
- See PutItemOutputTableTypeDef
kwargs: PutItemInputTablePutItemTypeDef = { # (1)
"Item": ...,
}
parent.put_item(**kwargs)
Table.query method
You must provide the name of the partition key attribute and a single value for that attribute.
Type annotations and code completion for boto3.resource("dynamodb").query
method.
boto3 documentation
def query(
self,
*,
IndexName: str = ...,
Select: SelectType = ..., # (1)
AttributesToGet: Sequence[str] = ...,
Limit: int = ...,
ConsistentRead: bool = ...,
KeyConditions: Mapping[str, ConditionTableTypeDef] = ..., # (2)
QueryFilter: Mapping[str, ConditionTableTypeDef] = ..., # (2)
ConditionalOperator: ConditionalOperatorType = ..., # (4)
ScanIndexForward: bool = ...,
ExclusiveStartKey: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]] = ...,
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (5)
ProjectionExpression: str = ...,
FilterExpression: Union[str, ConditionBase] = ...,
KeyConditionExpression: Union[str, ConditionBase] = ...,
ExpressionAttributeNames: Mapping[str, str] = ...,
ExpressionAttributeValues: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]] = ...,
) -> QueryOutputTableTypeDef: # (6)
...
- See SelectType
- See ConditionTableTypeDef
- See ConditionTableTypeDef
- See ConditionalOperatorType
- See ReturnConsumedCapacityType
- See QueryOutputTableTypeDef
kwargs: QueryInputTableQueryTypeDef = { # (1)
"IndexName": ...,
}
parent.query(**kwargs)
Table.reload method
Calls meth:DynamoDB.Client.describe_table
to update the attributes of the
Table resource.
Type annotations and code completion for boto3.resource("dynamodb").reload
method.
boto3 documentation
Table.scan method
The Scan
operation returns one or more items and item attributes by accessing
every item in a table or a secondary index.
Type annotations and code completion for boto3.resource("dynamodb").scan
method.
boto3 documentation
def scan(
self,
*,
IndexName: str = ...,
AttributesToGet: Sequence[str] = ...,
Limit: int = ...,
Select: SelectType = ..., # (1)
ScanFilter: Mapping[str, ConditionTableTypeDef] = ..., # (2)
ConditionalOperator: ConditionalOperatorType = ..., # (3)
ExclusiveStartKey: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]] = ...,
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (4)
TotalSegments: int = ...,
Segment: int = ...,
ProjectionExpression: str = ...,
FilterExpression: Union[str, ConditionBase] = ...,
ExpressionAttributeNames: Mapping[str, str] = ...,
ExpressionAttributeValues: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]] = ...,
ConsistentRead: bool = ...,
) -> ScanOutputTableTypeDef: # (5)
...
- See SelectType
- See ConditionTableTypeDef
- See ConditionalOperatorType
- See ReturnConsumedCapacityType
- See ScanOutputTableTypeDef
kwargs: ScanInputTableScanTypeDef = { # (1)
"IndexName": ...,
}
parent.scan(**kwargs)
Table.update method
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
Type annotations and code completion for boto3.resource("dynamodb").update
method.
boto3 documentation
def update(
self,
*,
AttributeDefinitions: Sequence[AttributeDefinitionTableTypeDef] = ..., # (1)
BillingMode: BillingModeType = ..., # (2)
ProvisionedThroughput: ProvisionedThroughputTableTypeDef = ..., # (3)
GlobalSecondaryIndexUpdates: Sequence[GlobalSecondaryIndexUpdateTableTypeDef] = ..., # (4)
StreamSpecification: StreamSpecificationTableTypeDef = ..., # (5)
SSESpecification: SSESpecificationTableTypeDef = ..., # (6)
ReplicaUpdates: Sequence[ReplicationGroupUpdateTableTypeDef] = ..., # (7)
TableClass: TableClassType = ..., # (8)
DeletionProtectionEnabled: bool = ...,
) -> Table:
...
- See AttributeDefinitionTableTypeDef
- See BillingModeType
- See ProvisionedThroughputTableTypeDef
- See GlobalSecondaryIndexUpdateTableTypeDef
- See StreamSpecificationTableTypeDef
- See SSESpecificationTableTypeDef
- See ReplicationGroupUpdateTableTypeDef
- See TableClassType
kwargs: UpdateTableInputTableUpdateTypeDef = { # (1)
"AttributeDefinitions": ...,
}
parent.update(**kwargs)
Table.update_item method
Edits an existing item's attributes, or adds a new item to the table if it does not already exist.
Type annotations and code completion for boto3.resource("dynamodb").update_item
method.
boto3 documentation
def update_item(
self,
*,
Key: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
AttributeUpdates: Mapping[str, AttributeValueUpdateTableTypeDef] = ..., # (1)
Expected: Mapping[str, ExpectedAttributeValueTableTypeDef] = ..., # (2)
ConditionalOperator: ConditionalOperatorType = ..., # (3)
ReturnValues: ReturnValueType = ..., # (4)
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (5)
ReturnItemCollectionMetrics: ReturnItemCollectionMetricsType = ..., # (6)
UpdateExpression: str = ...,
ConditionExpression: Union[str, ConditionBase] = ...,
ExpressionAttributeNames: Mapping[str, str] = ...,
ExpressionAttributeValues: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]] = ...,
) -> UpdateItemOutputTableTypeDef: # (7)
...
- See AttributeValueUpdateTableTypeDef
- See ExpectedAttributeValueTableTypeDef
- See ConditionalOperatorType
- See ReturnValueType
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
- See UpdateItemOutputTableTypeDef
kwargs: UpdateItemInputTableUpdateItemTypeDef = { # (1)
"Key": ...,
}
parent.update_item(**kwargs)
Table.wait_until_exists method
Waits until this Table is exists.
Type annotations and code completion for boto3.resource("dynamodb").wait_until_exists
method.
boto3 documentation
Table.wait_until_not_exists method
Waits until this Table is not exists.
Type annotations and code completion for boto3.resource("dynamodb").wait_until_not_exists
method.
boto3 documentation