DynamoDBClient
Auto-generated documentation for DynamoDB type annotations stubs module mypy-boto3-dynamodb.
DynamoDBClient
Type annotations and code completion for boto3.client("dynamodb")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_dynamodb.client import DynamoDBClient
def get_dynamodb_client() -> DynamoDBClient:
return Session().client("dynamodb")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("dynamodb").exceptions
structure.
client = boto3.client("dynamodb")
try:
do_something(client)
except (
client.BackupInUseException,
client.BackupNotFoundException,
client.ClientError,
client.ConditionalCheckFailedException,
client.ContinuousBackupsUnavailableException,
client.DuplicateItemException,
client.ExportConflictException,
client.ExportNotFoundException,
client.GlobalTableAlreadyExistsException,
client.GlobalTableNotFoundException,
client.IdempotentParameterMismatchException,
client.ImportConflictException,
client.ImportNotFoundException,
client.IndexNotFoundException,
client.InternalServerError,
client.InvalidExportTimeException,
client.InvalidRestoreTimeException,
client.ItemCollectionSizeLimitExceededException,
client.LimitExceededException,
client.PointInTimeRecoveryUnavailableException,
client.ProvisionedThroughputExceededException,
client.ReplicaAlreadyExistsException,
client.ReplicaNotFoundException,
client.RequestLimitExceeded,
client.ResourceInUseException,
client.ResourceNotFoundException,
client.TableAlreadyExistsException,
client.TableInUseException,
client.TableNotFoundException,
client.TransactionCanceledException,
client.TransactionConflictException,
client.TransactionInProgressException,
) as e:
print(e)
from mypy_boto3_dynamodb.client import Exceptions
def handle_error(exc: Exceptions.BackupInUseException) -> None:
...
Methods
batch_execute_statement
This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL.
Type annotations and code completion for boto3.client("dynamodb").batch_execute_statement
method.
boto3 documentation
def batch_execute_statement(
self,
*,
Statements: Sequence[BatchStatementRequestTypeDef], # (1)
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (2)
) -> BatchExecuteStatementOutputTypeDef: # (3)
...
- See BatchStatementRequestTypeDef
- See ReturnConsumedCapacityType
- See BatchExecuteStatementOutputTypeDef
kwargs: BatchExecuteStatementInputRequestTypeDef = { # (1)
"Statements": ...,
}
parent.batch_execute_statement(**kwargs)
batch_get_item
The BatchGetItem
operation returns the attributes of one or more items from
one or more tables.
Type annotations and code completion for boto3.client("dynamodb").batch_get_item
method.
boto3 documentation
def batch_get_item(
self,
*,
RequestItems: Mapping[str, KeysAndAttributesTypeDef], # (1)
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (2)
) -> BatchGetItemOutputTypeDef: # (3)
...
kwargs: BatchGetItemInputRequestTypeDef = { # (1)
"RequestItems": ...,
}
parent.batch_get_item(**kwargs)
batch_write_item
The BatchWriteItem
operation puts or deletes multiple items in one or more
tables.
Type annotations and code completion for boto3.client("dynamodb").batch_write_item
method.
boto3 documentation
def batch_write_item(
self,
*,
RequestItems: Mapping[str, Sequence[WriteRequestTypeDef]], # (1)
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (2)
ReturnItemCollectionMetrics: ReturnItemCollectionMetricsType = ..., # (3)
) -> BatchWriteItemOutputTypeDef: # (4)
...
- See WriteRequestTypeDef
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
- See BatchWriteItemOutputTypeDef
kwargs: BatchWriteItemInputRequestTypeDef = { # (1)
"RequestItems": ...,
}
parent.batch_write_item(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("dynamodb").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("dynamodb").close
method.
boto3 documentation
create_backup
Creates a backup for an existing table.
Type annotations and code completion for boto3.client("dynamodb").create_backup
method.
boto3 documentation
def create_backup(
self,
*,
TableName: str,
BackupName: str,
) -> CreateBackupOutputTypeDef: # (1)
...
kwargs: CreateBackupInputRequestTypeDef = { # (1)
"TableName": ...,
"BackupName": ...,
}
parent.create_backup(**kwargs)
create_global_table
Creates a global table from an existing table.
Type annotations and code completion for boto3.client("dynamodb").create_global_table
method.
boto3 documentation
def create_global_table(
self,
*,
GlobalTableName: str,
ReplicationGroup: Sequence[ReplicaTypeDef], # (1)
) -> CreateGlobalTableOutputTypeDef: # (2)
...
kwargs: CreateGlobalTableInputRequestTypeDef = { # (1)
"GlobalTableName": ...,
"ReplicationGroup": ...,
}
parent.create_global_table(**kwargs)
create_table
The CreateTable
operation adds a new table to your account.
Type annotations and code completion for boto3.client("dynamodb").create_table
method.
boto3 documentation
def create_table(
self,
*,
AttributeDefinitions: Sequence[AttributeDefinitionTypeDef], # (1)
TableName: str,
KeySchema: Sequence[KeySchemaElementTypeDef], # (2)
LocalSecondaryIndexes: Sequence[LocalSecondaryIndexTypeDef] = ..., # (3)
GlobalSecondaryIndexes: Sequence[GlobalSecondaryIndexTypeDef] = ..., # (4)
BillingMode: BillingModeType = ..., # (5)
ProvisionedThroughput: ProvisionedThroughputTypeDef = ..., # (6)
StreamSpecification: StreamSpecificationTypeDef = ..., # (7)
SSESpecification: SSESpecificationTypeDef = ..., # (8)
Tags: Sequence[TagTypeDef] = ..., # (9)
TableClass: TableClassType = ..., # (10)
DeletionProtectionEnabled: bool = ...,
) -> CreateTableOutputTypeDef: # (11)
...
- See AttributeDefinitionTypeDef
- See KeySchemaElementTypeDef
- See LocalSecondaryIndexTypeDef
- See GlobalSecondaryIndexTypeDef
- See BillingModeType
- See ProvisionedThroughputTypeDef
- See StreamSpecificationTypeDef
- See SSESpecificationTypeDef
- See TagTypeDef
- See TableClassType
- See CreateTableOutputTypeDef
kwargs: CreateTableInputRequestTypeDef = { # (1)
"AttributeDefinitions": ...,
"TableName": ...,
"KeySchema": ...,
}
parent.create_table(**kwargs)
delete_backup
Deletes an existing backup of a table.
Type annotations and code completion for boto3.client("dynamodb").delete_backup
method.
boto3 documentation
def delete_backup(
self,
*,
BackupArn: str,
) -> DeleteBackupOutputTypeDef: # (1)
...
kwargs: DeleteBackupInputRequestTypeDef = { # (1)
"BackupArn": ...,
}
parent.delete_backup(**kwargs)
delete_item
Deletes a single item in a table by primary key.
Type annotations and code completion for boto3.client("dynamodb").delete_item
method.
boto3 documentation
def delete_item(
self,
*,
TableName: str,
Key: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
Expected: Mapping[str, ExpectedAttributeValueTypeDef] = ..., # (2)
ConditionalOperator: ConditionalOperatorType = ..., # (3)
ReturnValues: ReturnValueType = ..., # (4)
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (5)
ReturnItemCollectionMetrics: ReturnItemCollectionMetricsType = ..., # (6)
ConditionExpression: str = ...,
ExpressionAttributeNames: Mapping[str, str] = ...,
ExpressionAttributeValues: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]] = ..., # (1)
) -> DeleteItemOutputTypeDef: # (8)
...
- See AttributeValueTypeDef
- See ExpectedAttributeValueTypeDef
- See ConditionalOperatorType
- See ReturnValueType
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
- See AttributeValueTypeDef
- See DeleteItemOutputTypeDef
kwargs: DeleteItemInputRequestTypeDef = { # (1)
"TableName": ...,
"Key": ...,
}
parent.delete_item(**kwargs)
delete_table
The DeleteTable
operation deletes a table and all of its items.
Type annotations and code completion for boto3.client("dynamodb").delete_table
method.
boto3 documentation
def delete_table(
self,
*,
TableName: str,
) -> DeleteTableOutputTypeDef: # (1)
...
kwargs: DeleteTableInputRequestTypeDef = { # (1)
"TableName": ...,
}
parent.delete_table(**kwargs)
describe_backup
Describes an existing backup of a table.
Type annotations and code completion for boto3.client("dynamodb").describe_backup
method.
boto3 documentation
def describe_backup(
self,
*,
BackupArn: str,
) -> DescribeBackupOutputTypeDef: # (1)
...
kwargs: DescribeBackupInputRequestTypeDef = { # (1)
"BackupArn": ...,
}
parent.describe_backup(**kwargs)
describe_continuous_backups
Checks the status of continuous backups and point in time recovery on the specified table.
Type annotations and code completion for boto3.client("dynamodb").describe_continuous_backups
method.
boto3 documentation
def describe_continuous_backups(
self,
*,
TableName: str,
) -> DescribeContinuousBackupsOutputTypeDef: # (1)
...
kwargs: DescribeContinuousBackupsInputRequestTypeDef = { # (1)
"TableName": ...,
}
parent.describe_continuous_backups(**kwargs)
describe_contributor_insights
Returns information about contributor insights for a given table or global secondary index.
Type annotations and code completion for boto3.client("dynamodb").describe_contributor_insights
method.
boto3 documentation
def describe_contributor_insights(
self,
*,
TableName: str,
IndexName: str = ...,
) -> DescribeContributorInsightsOutputTypeDef: # (1)
...
kwargs: DescribeContributorInsightsInputRequestTypeDef = { # (1)
"TableName": ...,
}
parent.describe_contributor_insights(**kwargs)
describe_endpoints
Returns the regional endpoint information.
Type annotations and code completion for boto3.client("dynamodb").describe_endpoints
method.
boto3 documentation
describe_export
Describes an existing table export.
Type annotations and code completion for boto3.client("dynamodb").describe_export
method.
boto3 documentation
def describe_export(
self,
*,
ExportArn: str,
) -> DescribeExportOutputTypeDef: # (1)
...
kwargs: DescribeExportInputRequestTypeDef = { # (1)
"ExportArn": ...,
}
parent.describe_export(**kwargs)
describe_global_table
Returns information about the specified global table.
Type annotations and code completion for boto3.client("dynamodb").describe_global_table
method.
boto3 documentation
def describe_global_table(
self,
*,
GlobalTableName: str,
) -> DescribeGlobalTableOutputTypeDef: # (1)
...
kwargs: DescribeGlobalTableInputRequestTypeDef = { # (1)
"GlobalTableName": ...,
}
parent.describe_global_table(**kwargs)
describe_global_table_settings
Describes Region-specific settings for a global table.
Type annotations and code completion for boto3.client("dynamodb").describe_global_table_settings
method.
boto3 documentation
def describe_global_table_settings(
self,
*,
GlobalTableName: str,
) -> DescribeGlobalTableSettingsOutputTypeDef: # (1)
...
kwargs: DescribeGlobalTableSettingsInputRequestTypeDef = { # (1)
"GlobalTableName": ...,
}
parent.describe_global_table_settings(**kwargs)
describe_import
Represents the properties of the import.
Type annotations and code completion for boto3.client("dynamodb").describe_import
method.
boto3 documentation
def describe_import(
self,
*,
ImportArn: str,
) -> DescribeImportOutputTypeDef: # (1)
...
kwargs: DescribeImportInputRequestTypeDef = { # (1)
"ImportArn": ...,
}
parent.describe_import(**kwargs)
describe_kinesis_streaming_destination
Returns information about the status of Kinesis streaming.
Type annotations and code completion for boto3.client("dynamodb").describe_kinesis_streaming_destination
method.
boto3 documentation
def describe_kinesis_streaming_destination(
self,
*,
TableName: str,
) -> DescribeKinesisStreamingDestinationOutputTypeDef: # (1)
...
kwargs: DescribeKinesisStreamingDestinationInputRequestTypeDef = { # (1)
"TableName": ...,
}
parent.describe_kinesis_streaming_destination(**kwargs)
describe_limits
Returns the current provisioned-capacity quotas for your Amazon Web Services account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.
Type annotations and code completion for boto3.client("dynamodb").describe_limits
method.
boto3 documentation
describe_table
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
Type annotations and code completion for boto3.client("dynamodb").describe_table
method.
boto3 documentation
def describe_table(
self,
*,
TableName: str,
) -> DescribeTableOutputTypeDef: # (1)
...
kwargs: DescribeTableInputRequestTypeDef = { # (1)
"TableName": ...,
}
parent.describe_table(**kwargs)
describe_table_replica_auto_scaling
Describes auto scaling settings across replicas of the global table at once.
Type annotations and code completion for boto3.client("dynamodb").describe_table_replica_auto_scaling
method.
boto3 documentation
def describe_table_replica_auto_scaling(
self,
*,
TableName: str,
) -> DescribeTableReplicaAutoScalingOutputTypeDef: # (1)
...
kwargs: DescribeTableReplicaAutoScalingInputRequestTypeDef = { # (1)
"TableName": ...,
}
parent.describe_table_replica_auto_scaling(**kwargs)
describe_time_to_live
Gives a description of the Time to Live (TTL) status on the specified table.
Type annotations and code completion for boto3.client("dynamodb").describe_time_to_live
method.
boto3 documentation
def describe_time_to_live(
self,
*,
TableName: str,
) -> DescribeTimeToLiveOutputTypeDef: # (1)
...
kwargs: DescribeTimeToLiveInputRequestTypeDef = { # (1)
"TableName": ...,
}
parent.describe_time_to_live(**kwargs)
disable_kinesis_streaming_destination
Stops replication from the DynamoDB table to the Kinesis data stream.
Type annotations and code completion for boto3.client("dynamodb").disable_kinesis_streaming_destination
method.
boto3 documentation
def disable_kinesis_streaming_destination(
self,
*,
TableName: str,
StreamArn: str,
) -> KinesisStreamingDestinationOutputTypeDef: # (1)
...
kwargs: KinesisStreamingDestinationInputRequestTypeDef = { # (1)
"TableName": ...,
"StreamArn": ...,
}
parent.disable_kinesis_streaming_destination(**kwargs)
enable_kinesis_streaming_destination
Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow.
Type annotations and code completion for boto3.client("dynamodb").enable_kinesis_streaming_destination
method.
boto3 documentation
def enable_kinesis_streaming_destination(
self,
*,
TableName: str,
StreamArn: str,
) -> KinesisStreamingDestinationOutputTypeDef: # (1)
...
kwargs: KinesisStreamingDestinationInputRequestTypeDef = { # (1)
"TableName": ...,
"StreamArn": ...,
}
parent.enable_kinesis_streaming_destination(**kwargs)
execute_statement
This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.
Type annotations and code completion for boto3.client("dynamodb").execute_statement
method.
boto3 documentation
def execute_statement(
self,
*,
Statement: str,
Parameters: Sequence[Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]] = ..., # (1)
ConsistentRead: bool = ...,
NextToken: str = ...,
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (2)
Limit: int = ...,
) -> ExecuteStatementOutputTypeDef: # (3)
...
kwargs: ExecuteStatementInputRequestTypeDef = { # (1)
"Statement": ...,
}
parent.execute_statement(**kwargs)
execute_transaction
This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.
Type annotations and code completion for boto3.client("dynamodb").execute_transaction
method.
boto3 documentation
def execute_transaction(
self,
*,
TransactStatements: Sequence[ParameterizedStatementTypeDef], # (1)
ClientRequestToken: str = ...,
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (2)
) -> ExecuteTransactionOutputTypeDef: # (3)
...
- See ParameterizedStatementTypeDef
- See ReturnConsumedCapacityType
- See ExecuteTransactionOutputTypeDef
kwargs: ExecuteTransactionInputRequestTypeDef = { # (1)
"TransactStatements": ...,
}
parent.execute_transaction(**kwargs)
export_table_to_point_in_time
Exports table data to an S3 bucket.
Type annotations and code completion for boto3.client("dynamodb").export_table_to_point_in_time
method.
boto3 documentation
def export_table_to_point_in_time(
self,
*,
TableArn: str,
S3Bucket: str,
ExportTime: Union[datetime, str] = ...,
ClientToken: str = ...,
S3BucketOwner: str = ...,
S3Prefix: str = ...,
S3SseAlgorithm: S3SseAlgorithmType = ..., # (1)
S3SseKmsKeyId: str = ...,
ExportFormat: ExportFormatType = ..., # (2)
) -> ExportTableToPointInTimeOutputTypeDef: # (3)
...
kwargs: ExportTableToPointInTimeInputRequestTypeDef = { # (1)
"TableArn": ...,
"S3Bucket": ...,
}
parent.export_table_to_point_in_time(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("dynamodb").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_item
The GetItem
operation returns a set of attributes for the item with the given
primary key.
Type annotations and code completion for boto3.client("dynamodb").get_item
method.
boto3 documentation
def get_item(
self,
*,
TableName: str,
Key: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
AttributesToGet: Sequence[str] = ...,
ConsistentRead: bool = ...,
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (2)
ProjectionExpression: str = ...,
ExpressionAttributeNames: Mapping[str, str] = ...,
) -> GetItemOutputTypeDef: # (3)
...
kwargs: GetItemInputRequestTypeDef = { # (1)
"TableName": ...,
"Key": ...,
}
parent.get_item(**kwargs)
import_table
Imports table data from an S3 bucket.
Type annotations and code completion for boto3.client("dynamodb").import_table
method.
boto3 documentation
def import_table(
self,
*,
S3BucketSource: S3BucketSourceTypeDef, # (1)
InputFormat: InputFormatType, # (2)
TableCreationParameters: TableCreationParametersTypeDef, # (3)
ClientToken: str = ...,
InputFormatOptions: InputFormatOptionsTypeDef = ..., # (4)
InputCompressionType: InputCompressionTypeType = ..., # (5)
) -> ImportTableOutputTypeDef: # (6)
...
- See S3BucketSourceTypeDef
- See InputFormatType
- See TableCreationParametersTypeDef
- See InputFormatOptionsTypeDef
- See InputCompressionTypeType
- See ImportTableOutputTypeDef
kwargs: ImportTableInputRequestTypeDef = { # (1)
"S3BucketSource": ...,
"InputFormat": ...,
"TableCreationParameters": ...,
}
parent.import_table(**kwargs)
list_backups
List backups associated with an Amazon Web Services account.
Type annotations and code completion for boto3.client("dynamodb").list_backups
method.
boto3 documentation
def list_backups(
self,
*,
TableName: str = ...,
Limit: int = ...,
TimeRangeLowerBound: Union[datetime, str] = ...,
TimeRangeUpperBound: Union[datetime, str] = ...,
ExclusiveStartBackupArn: str = ...,
BackupType: BackupTypeFilterType = ..., # (1)
) -> ListBackupsOutputTypeDef: # (2)
...
kwargs: ListBackupsInputRequestTypeDef = { # (1)
"TableName": ...,
}
parent.list_backups(**kwargs)
list_contributor_insights
Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.
Type annotations and code completion for boto3.client("dynamodb").list_contributor_insights
method.
boto3 documentation
def list_contributor_insights(
self,
*,
TableName: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListContributorInsightsOutputTypeDef: # (1)
...
kwargs: ListContributorInsightsInputRequestTypeDef = { # (1)
"TableName": ...,
}
parent.list_contributor_insights(**kwargs)
list_exports
Lists completed exports within the past 90 days.
Type annotations and code completion for boto3.client("dynamodb").list_exports
method.
boto3 documentation
def list_exports(
self,
*,
TableArn: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListExportsOutputTypeDef: # (1)
...
kwargs: ListExportsInputRequestTypeDef = { # (1)
"TableArn": ...,
}
parent.list_exports(**kwargs)
list_global_tables
Lists all global tables that have a replica in the specified Region.
Type annotations and code completion for boto3.client("dynamodb").list_global_tables
method.
boto3 documentation
def list_global_tables(
self,
*,
ExclusiveStartGlobalTableName: str = ...,
Limit: int = ...,
RegionName: str = ...,
) -> ListGlobalTablesOutputTypeDef: # (1)
...
kwargs: ListGlobalTablesInputRequestTypeDef = { # (1)
"ExclusiveStartGlobalTableName": ...,
}
parent.list_global_tables(**kwargs)
list_imports
Lists completed imports within the past 90 days.
Type annotations and code completion for boto3.client("dynamodb").list_imports
method.
boto3 documentation
def list_imports(
self,
*,
TableArn: str = ...,
PageSize: int = ...,
NextToken: str = ...,
) -> ListImportsOutputTypeDef: # (1)
...
kwargs: ListImportsInputRequestTypeDef = { # (1)
"TableArn": ...,
}
parent.list_imports(**kwargs)
list_tables
Returns an array of table names associated with the current account and endpoint.
Type annotations and code completion for boto3.client("dynamodb").list_tables
method.
boto3 documentation
def list_tables(
self,
*,
ExclusiveStartTableName: str = ...,
Limit: int = ...,
) -> ListTablesOutputTypeDef: # (1)
...
kwargs: ListTablesInputRequestTypeDef = { # (1)
"ExclusiveStartTableName": ...,
}
parent.list_tables(**kwargs)
list_tags_of_resource
List all tags on an Amazon DynamoDB resource.
Type annotations and code completion for boto3.client("dynamodb").list_tags_of_resource
method.
boto3 documentation
def list_tags_of_resource(
self,
*,
ResourceArn: str,
NextToken: str = ...,
) -> ListTagsOfResourceOutputTypeDef: # (1)
...
kwargs: ListTagsOfResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_of_resource(**kwargs)
put_item
Creates a new item, or replaces an old item with a new item.
Type annotations and code completion for boto3.client("dynamodb").put_item
method.
boto3 documentation
def put_item(
self,
*,
TableName: str,
Item: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
Expected: Mapping[str, ExpectedAttributeValueTypeDef] = ..., # (2)
ReturnValues: ReturnValueType = ..., # (3)
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (4)
ReturnItemCollectionMetrics: ReturnItemCollectionMetricsType = ..., # (5)
ConditionalOperator: ConditionalOperatorType = ..., # (6)
ConditionExpression: str = ...,
ExpressionAttributeNames: Mapping[str, str] = ...,
ExpressionAttributeValues: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]] = ..., # (1)
) -> PutItemOutputTypeDef: # (8)
...
- See AttributeValueTypeDef
- See ExpectedAttributeValueTypeDef
- See ReturnValueType
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
- See ConditionalOperatorType
- See AttributeValueTypeDef
- See PutItemOutputTypeDef
kwargs: PutItemInputRequestTypeDef = { # (1)
"TableName": ...,
"Item": ...,
}
parent.put_item(**kwargs)
query
You must provide the name of the partition key attribute and a single value for that attribute.
Type annotations and code completion for boto3.client("dynamodb").query
method.
boto3 documentation
def query(
self,
*,
TableName: str,
IndexName: str = ...,
Select: SelectType = ..., # (1)
AttributesToGet: Sequence[str] = ...,
Limit: int = ...,
ConsistentRead: bool = ...,
KeyConditions: Mapping[str, ConditionTypeDef] = ..., # (2)
QueryFilter: Mapping[str, ConditionTypeDef] = ..., # (2)
ConditionalOperator: ConditionalOperatorType = ..., # (4)
ScanIndexForward: bool = ...,
ExclusiveStartKey: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]] = ..., # (5)
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (6)
ProjectionExpression: str = ...,
FilterExpression: str = ...,
KeyConditionExpression: str = ...,
ExpressionAttributeNames: Mapping[str, str] = ...,
ExpressionAttributeValues: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]] = ..., # (5)
) -> QueryOutputTypeDef: # (8)
...
- See SelectType
- See ConditionTypeDef
- See ConditionTypeDef
- See ConditionalOperatorType
- See AttributeValueTypeDef
- See ReturnConsumedCapacityType
- See AttributeValueTypeDef
- See QueryOutputTypeDef
kwargs: QueryInputRequestTypeDef = { # (1)
"TableName": ...,
}
parent.query(**kwargs)
restore_table_from_backup
Creates a new table from an existing backup.
Type annotations and code completion for boto3.client("dynamodb").restore_table_from_backup
method.
boto3 documentation
def restore_table_from_backup(
self,
*,
TargetTableName: str,
BackupArn: str,
BillingModeOverride: BillingModeType = ..., # (1)
GlobalSecondaryIndexOverride: Sequence[GlobalSecondaryIndexTypeDef] = ..., # (2)
LocalSecondaryIndexOverride: Sequence[LocalSecondaryIndexTypeDef] = ..., # (3)
ProvisionedThroughputOverride: ProvisionedThroughputTypeDef = ..., # (4)
SSESpecificationOverride: SSESpecificationTypeDef = ..., # (5)
) -> RestoreTableFromBackupOutputTypeDef: # (6)
...
- See BillingModeType
- See GlobalSecondaryIndexTypeDef
- See LocalSecondaryIndexTypeDef
- See ProvisionedThroughputTypeDef
- See SSESpecificationTypeDef
- See RestoreTableFromBackupOutputTypeDef
kwargs: RestoreTableFromBackupInputRequestTypeDef = { # (1)
"TargetTableName": ...,
"BackupArn": ...,
}
parent.restore_table_from_backup(**kwargs)
restore_table_to_point_in_time
Restores the specified table to the specified point in time within
EarliestRestorableDateTime
and LatestRestorableDateTime
.
Type annotations and code completion for boto3.client("dynamodb").restore_table_to_point_in_time
method.
boto3 documentation
def restore_table_to_point_in_time(
self,
*,
TargetTableName: str,
SourceTableArn: str = ...,
SourceTableName: str = ...,
UseLatestRestorableTime: bool = ...,
RestoreDateTime: Union[datetime, str] = ...,
BillingModeOverride: BillingModeType = ..., # (1)
GlobalSecondaryIndexOverride: Sequence[GlobalSecondaryIndexTypeDef] = ..., # (2)
LocalSecondaryIndexOverride: Sequence[LocalSecondaryIndexTypeDef] = ..., # (3)
ProvisionedThroughputOverride: ProvisionedThroughputTypeDef = ..., # (4)
SSESpecificationOverride: SSESpecificationTypeDef = ..., # (5)
) -> RestoreTableToPointInTimeOutputTypeDef: # (6)
...
- See BillingModeType
- See GlobalSecondaryIndexTypeDef
- See LocalSecondaryIndexTypeDef
- See ProvisionedThroughputTypeDef
- See SSESpecificationTypeDef
- See RestoreTableToPointInTimeOutputTypeDef
kwargs: RestoreTableToPointInTimeInputRequestTypeDef = { # (1)
"TargetTableName": ...,
}
parent.restore_table_to_point_in_time(**kwargs)
scan
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.client("dynamodb").scan
method.
boto3 documentation
def scan(
self,
*,
TableName: str,
IndexName: str = ...,
AttributesToGet: Sequence[str] = ...,
Limit: int = ...,
Select: SelectType = ..., # (1)
ScanFilter: Mapping[str, ConditionTypeDef] = ..., # (2)
ConditionalOperator: ConditionalOperatorType = ..., # (3)
ExclusiveStartKey: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]] = ..., # (4)
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (5)
TotalSegments: int = ...,
Segment: int = ...,
ProjectionExpression: str = ...,
FilterExpression: str = ...,
ExpressionAttributeNames: Mapping[str, str] = ...,
ExpressionAttributeValues: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]] = ..., # (4)
ConsistentRead: bool = ...,
) -> ScanOutputTypeDef: # (7)
...
- See SelectType
- See ConditionTypeDef
- See ConditionalOperatorType
- See AttributeValueTypeDef
- See ReturnConsumedCapacityType
- See AttributeValueTypeDef
- See ScanOutputTypeDef
kwargs: ScanInputRequestTypeDef = { # (1)
"TableName": ...,
}
parent.scan(**kwargs)
tag_resource
Associate a set of tags with an Amazon DynamoDB resource.
Type annotations and code completion for boto3.client("dynamodb").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: TagResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
transact_get_items
TransactGetItems
is a synchronous operation that atomically retrieves multiple
items from one or more tables (but not from indexes) in a single account and
Region.
Type annotations and code completion for boto3.client("dynamodb").transact_get_items
method.
boto3 documentation
def transact_get_items(
self,
*,
TransactItems: Sequence[TransactGetItemTypeDef], # (1)
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (2)
) -> TransactGetItemsOutputTypeDef: # (3)
...
kwargs: TransactGetItemsInputRequestTypeDef = { # (1)
"TransactItems": ...,
}
parent.transact_get_items(**kwargs)
transact_write_items
TransactWriteItems
is a synchronous write operation that groups up to 100
action requests.
Type annotations and code completion for boto3.client("dynamodb").transact_write_items
method.
boto3 documentation
def transact_write_items(
self,
*,
TransactItems: Sequence[TransactWriteItemTypeDef], # (1)
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (2)
ReturnItemCollectionMetrics: ReturnItemCollectionMetricsType = ..., # (3)
ClientRequestToken: str = ...,
) -> TransactWriteItemsOutputTypeDef: # (4)
...
- See TransactWriteItemTypeDef
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
- See TransactWriteItemsOutputTypeDef
kwargs: TransactWriteItemsInputRequestTypeDef = { # (1)
"TransactItems": ...,
}
parent.transact_write_items(**kwargs)
untag_resource
Removes the association of tags from an Amazon DynamoDB resource.
Type annotations and code completion for boto3.client("dynamodb").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_continuous_backups
UpdateContinuousBackups
enables or disables point in time recovery for the
specified table.
Type annotations and code completion for boto3.client("dynamodb").update_continuous_backups
method.
boto3 documentation
def update_continuous_backups(
self,
*,
TableName: str,
PointInTimeRecoverySpecification: PointInTimeRecoverySpecificationTypeDef, # (1)
) -> UpdateContinuousBackupsOutputTypeDef: # (2)
...
kwargs: UpdateContinuousBackupsInputRequestTypeDef = { # (1)
"TableName": ...,
"PointInTimeRecoverySpecification": ...,
}
parent.update_continuous_backups(**kwargs)
update_contributor_insights
Updates the status for contributor insights for a specific table or index.
Type annotations and code completion for boto3.client("dynamodb").update_contributor_insights
method.
boto3 documentation
def update_contributor_insights(
self,
*,
TableName: str,
ContributorInsightsAction: ContributorInsightsActionType, # (1)
IndexName: str = ...,
) -> UpdateContributorInsightsOutputTypeDef: # (2)
...
kwargs: UpdateContributorInsightsInputRequestTypeDef = { # (1)
"TableName": ...,
"ContributorInsightsAction": ...,
}
parent.update_contributor_insights(**kwargs)
update_global_table
Adds or removes replicas in the specified global table.
Type annotations and code completion for boto3.client("dynamodb").update_global_table
method.
boto3 documentation
def update_global_table(
self,
*,
GlobalTableName: str,
ReplicaUpdates: Sequence[ReplicaUpdateTypeDef], # (1)
) -> UpdateGlobalTableOutputTypeDef: # (2)
...
kwargs: UpdateGlobalTableInputRequestTypeDef = { # (1)
"GlobalTableName": ...,
"ReplicaUpdates": ...,
}
parent.update_global_table(**kwargs)
update_global_table_settings
Updates settings for a global table.
Type annotations and code completion for boto3.client("dynamodb").update_global_table_settings
method.
boto3 documentation
def update_global_table_settings(
self,
*,
GlobalTableName: str,
GlobalTableBillingMode: BillingModeType = ..., # (1)
GlobalTableProvisionedWriteCapacityUnits: int = ...,
GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate: AutoScalingSettingsUpdateTypeDef = ..., # (2)
GlobalTableGlobalSecondaryIndexSettingsUpdate: Sequence[GlobalTableGlobalSecondaryIndexSettingsUpdateTypeDef] = ..., # (3)
ReplicaSettingsUpdate: Sequence[ReplicaSettingsUpdateTypeDef] = ..., # (4)
) -> UpdateGlobalTableSettingsOutputTypeDef: # (5)
...
- See BillingModeType
- See AutoScalingSettingsUpdateTypeDef
- See GlobalTableGlobalSecondaryIndexSettingsUpdateTypeDef
- See ReplicaSettingsUpdateTypeDef
- See UpdateGlobalTableSettingsOutputTypeDef
kwargs: UpdateGlobalTableSettingsInputRequestTypeDef = { # (1)
"GlobalTableName": ...,
}
parent.update_global_table_settings(**kwargs)
update_item
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.client("dynamodb").update_item
method.
boto3 documentation
def update_item(
self,
*,
TableName: str,
Key: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
AttributeUpdates: Mapping[str, AttributeValueUpdateTypeDef] = ..., # (2)
Expected: Mapping[str, ExpectedAttributeValueTypeDef] = ..., # (3)
ConditionalOperator: ConditionalOperatorType = ..., # (4)
ReturnValues: ReturnValueType = ..., # (5)
ReturnConsumedCapacity: ReturnConsumedCapacityType = ..., # (6)
ReturnItemCollectionMetrics: ReturnItemCollectionMetricsType = ..., # (7)
UpdateExpression: str = ...,
ConditionExpression: str = ...,
ExpressionAttributeNames: Mapping[str, str] = ...,
ExpressionAttributeValues: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]] = ..., # (1)
) -> UpdateItemOutputTypeDef: # (9)
...
- See AttributeValueTypeDef
- See AttributeValueUpdateTypeDef
- See ExpectedAttributeValueTypeDef
- See ConditionalOperatorType
- See ReturnValueType
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
- See AttributeValueTypeDef
- See UpdateItemOutputTypeDef
kwargs: UpdateItemInputRequestTypeDef = { # (1)
"TableName": ...,
"Key": ...,
}
parent.update_item(**kwargs)
update_table
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
Type annotations and code completion for boto3.client("dynamodb").update_table
method.
boto3 documentation
def update_table(
self,
*,
TableName: str,
AttributeDefinitions: Sequence[AttributeDefinitionTypeDef] = ..., # (1)
BillingMode: BillingModeType = ..., # (2)
ProvisionedThroughput: ProvisionedThroughputTypeDef = ..., # (3)
GlobalSecondaryIndexUpdates: Sequence[GlobalSecondaryIndexUpdateTypeDef] = ..., # (4)
StreamSpecification: StreamSpecificationTypeDef = ..., # (5)
SSESpecification: SSESpecificationTypeDef = ..., # (6)
ReplicaUpdates: Sequence[ReplicationGroupUpdateTypeDef] = ..., # (7)
TableClass: TableClassType = ..., # (8)
DeletionProtectionEnabled: bool = ...,
) -> UpdateTableOutputTypeDef: # (9)
...
- See AttributeDefinitionTypeDef
- See BillingModeType
- See ProvisionedThroughputTypeDef
- See GlobalSecondaryIndexUpdateTypeDef
- See StreamSpecificationTypeDef
- See SSESpecificationTypeDef
- See ReplicationGroupUpdateTypeDef
- See TableClassType
- See UpdateTableOutputTypeDef
kwargs: UpdateTableInputRequestTypeDef = { # (1)
"TableName": ...,
}
parent.update_table(**kwargs)
update_table_replica_auto_scaling
Updates auto scaling settings on your global tables at once.
Type annotations and code completion for boto3.client("dynamodb").update_table_replica_auto_scaling
method.
boto3 documentation
def update_table_replica_auto_scaling(
self,
*,
TableName: str,
GlobalSecondaryIndexUpdates: Sequence[GlobalSecondaryIndexAutoScalingUpdateTypeDef] = ..., # (1)
ProvisionedWriteCapacityAutoScalingUpdate: AutoScalingSettingsUpdateTypeDef = ..., # (2)
ReplicaUpdates: Sequence[ReplicaAutoScalingUpdateTypeDef] = ..., # (3)
) -> UpdateTableReplicaAutoScalingOutputTypeDef: # (4)
...
- See GlobalSecondaryIndexAutoScalingUpdateTypeDef
- See AutoScalingSettingsUpdateTypeDef
- See ReplicaAutoScalingUpdateTypeDef
- See UpdateTableReplicaAutoScalingOutputTypeDef
kwargs: UpdateTableReplicaAutoScalingInputRequestTypeDef = { # (1)
"TableName": ...,
}
parent.update_table_replica_auto_scaling(**kwargs)
update_time_to_live
The UpdateTimeToLive
method enables or disables Time to Live (TTL) for the
specified table.
Type annotations and code completion for boto3.client("dynamodb").update_time_to_live
method.
boto3 documentation
def update_time_to_live(
self,
*,
TableName: str,
TimeToLiveSpecification: TimeToLiveSpecificationTypeDef, # (1)
) -> UpdateTimeToLiveOutputTypeDef: # (2)
...
kwargs: UpdateTimeToLiveInputRequestTypeDef = { # (1)
"TableName": ...,
"TimeToLiveSpecification": ...,
}
parent.update_time_to_live(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("dynamodb").get_paginator
method with overloads.
client.get_paginator("list_backups")
-> ListBackupsPaginatorclient.get_paginator("list_tables")
-> ListTablesPaginatorclient.get_paginator("list_tags_of_resource")
-> ListTagsOfResourcePaginatorclient.get_paginator("query")
-> QueryPaginatorclient.get_paginator("scan")
-> ScanPaginator
get_waiter
Type annotations and code completion for boto3.client("dynamodb").get_waiter
method with overloads.
client.get_waiter("table_exists")
-> TableExistsWaiterclient.get_waiter("table_not_exists")
-> TableNotExistsWaiter