Skip to content

DynamoDBClient

Index > DynamoDB > 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

Usage example
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.

Usage example
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)
Type checking example
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

Method definition
def batch_execute_statement(
    self,
    *,
    Statements: Sequence[BatchStatementRequestTypeDef],  # (1)
    ReturnConsumedCapacity: ReturnConsumedCapacityType = ...,  # (2)
) -> BatchExecuteStatementOutputTypeDef:  # (3)
    ...
  1. See BatchStatementRequestTypeDef
  2. See ReturnConsumedCapacityType
  3. See BatchExecuteStatementOutputTypeDef
Usage example with kwargs
kwargs: BatchExecuteStatementInputRequestTypeDef = {  # (1)
    "Statements": ...,
}

parent.batch_execute_statement(**kwargs)
  1. See BatchExecuteStatementInputRequestTypeDef

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

Method definition
def batch_get_item(
    self,
    *,
    RequestItems: Mapping[str, KeysAndAttributesTypeDef],  # (1)
    ReturnConsumedCapacity: ReturnConsumedCapacityType = ...,  # (2)
) -> BatchGetItemOutputTypeDef:  # (3)
    ...
  1. See KeysAndAttributesTypeDef
  2. See ReturnConsumedCapacityType
  3. See BatchGetItemOutputTypeDef
Usage example with kwargs
kwargs: BatchGetItemInputRequestTypeDef = {  # (1)
    "RequestItems": ...,
}

parent.batch_get_item(**kwargs)
  1. See BatchGetItemInputRequestTypeDef

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

Method definition
def batch_write_item(
    self,
    *,
    RequestItems: Mapping[str, Sequence[WriteRequestTypeDef]],  # (1)
    ReturnConsumedCapacity: ReturnConsumedCapacityType = ...,  # (2)
    ReturnItemCollectionMetrics: ReturnItemCollectionMetricsType = ...,  # (3)
) -> BatchWriteItemOutputTypeDef:  # (4)
    ...
  1. See WriteRequestTypeDef
  2. See ReturnConsumedCapacityType
  3. See ReturnItemCollectionMetricsType
  4. See BatchWriteItemOutputTypeDef
Usage example with kwargs
kwargs: BatchWriteItemInputRequestTypeDef = {  # (1)
    "RequestItems": ...,
}

parent.batch_write_item(**kwargs)
  1. See BatchWriteItemInputRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("dynamodb").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("dynamodb").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_backup

Creates a backup for an existing table.

Type annotations and code completion for boto3.client("dynamodb").create_backup method. boto3 documentation

Method definition
def create_backup(
    self,
    *,
    TableName: str,
    BackupName: str,
) -> CreateBackupOutputTypeDef:  # (1)
    ...
  1. See CreateBackupOutputTypeDef
Usage example with kwargs
kwargs: CreateBackupInputRequestTypeDef = {  # (1)
    "TableName": ...,
    "BackupName": ...,
}

parent.create_backup(**kwargs)
  1. See CreateBackupInputRequestTypeDef

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

Method definition
def create_global_table(
    self,
    *,
    GlobalTableName: str,
    ReplicationGroup: Sequence[ReplicaTypeDef],  # (1)
) -> CreateGlobalTableOutputTypeDef:  # (2)
    ...
  1. See ReplicaTypeDef
  2. See CreateGlobalTableOutputTypeDef
Usage example with kwargs
kwargs: CreateGlobalTableInputRequestTypeDef = {  # (1)
    "GlobalTableName": ...,
    "ReplicationGroup": ...,
}

parent.create_global_table(**kwargs)
  1. See CreateGlobalTableInputRequestTypeDef

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

Method definition
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)
) -> CreateTableOutputTypeDef:  # (11)
    ...
  1. See AttributeDefinitionTypeDef
  2. See KeySchemaElementTypeDef
  3. See LocalSecondaryIndexTypeDef
  4. See GlobalSecondaryIndexTypeDef
  5. See BillingModeType
  6. See ProvisionedThroughputTypeDef
  7. See StreamSpecificationTypeDef
  8. See SSESpecificationTypeDef
  9. See TagTypeDef
  10. See TableClassType
  11. See CreateTableOutputTypeDef
Usage example with kwargs
kwargs: CreateTableInputRequestTypeDef = {  # (1)
    "AttributeDefinitions": ...,
    "TableName": ...,
    "KeySchema": ...,
}

parent.create_table(**kwargs)
  1. See CreateTableInputRequestTypeDef

delete_backup

Deletes an existing backup of a table.

Type annotations and code completion for boto3.client("dynamodb").delete_backup method. boto3 documentation

Method definition
def delete_backup(
    self,
    *,
    BackupArn: str,
) -> DeleteBackupOutputTypeDef:  # (1)
    ...
  1. See DeleteBackupOutputTypeDef
Usage example with kwargs
kwargs: DeleteBackupInputRequestTypeDef = {  # (1)
    "BackupArn": ...,
}

parent.delete_backup(**kwargs)
  1. See DeleteBackupInputRequestTypeDef

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

Method definition
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)
    ...
  1. See AttributeValueTypeDef
  2. See ExpectedAttributeValueTypeDef
  3. See ConditionalOperatorType
  4. See ReturnValueType
  5. See ReturnConsumedCapacityType
  6. See ReturnItemCollectionMetricsType
  7. See AttributeValueTypeDef
  8. See DeleteItemOutputTypeDef
Usage example with kwargs
kwargs: DeleteItemInputRequestTypeDef = {  # (1)
    "TableName": ...,
    "Key": ...,
}

parent.delete_item(**kwargs)
  1. See DeleteItemInputRequestTypeDef

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

Method definition
def delete_table(
    self,
    *,
    TableName: str,
) -> DeleteTableOutputTypeDef:  # (1)
    ...
  1. See DeleteTableOutputTypeDef
Usage example with kwargs
kwargs: DeleteTableInputRequestTypeDef = {  # (1)
    "TableName": ...,
}

parent.delete_table(**kwargs)
  1. See DeleteTableInputRequestTypeDef

describe_backup

Describes an existing backup of a table.

Type annotations and code completion for boto3.client("dynamodb").describe_backup method. boto3 documentation

Method definition
def describe_backup(
    self,
    *,
    BackupArn: str,
) -> DescribeBackupOutputTypeDef:  # (1)
    ...
  1. See DescribeBackupOutputTypeDef
Usage example with kwargs
kwargs: DescribeBackupInputRequestTypeDef = {  # (1)
    "BackupArn": ...,
}

parent.describe_backup(**kwargs)
  1. See DescribeBackupInputRequestTypeDef

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

Method definition
def describe_continuous_backups(
    self,
    *,
    TableName: str,
) -> DescribeContinuousBackupsOutputTypeDef:  # (1)
    ...
  1. See DescribeContinuousBackupsOutputTypeDef
Usage example with kwargs
kwargs: DescribeContinuousBackupsInputRequestTypeDef = {  # (1)
    "TableName": ...,
}

parent.describe_continuous_backups(**kwargs)
  1. See DescribeContinuousBackupsInputRequestTypeDef

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

Method definition
def describe_contributor_insights(
    self,
    *,
    TableName: str,
    IndexName: str = ...,
) -> DescribeContributorInsightsOutputTypeDef:  # (1)
    ...
  1. See DescribeContributorInsightsOutputTypeDef
Usage example with kwargs
kwargs: DescribeContributorInsightsInputRequestTypeDef = {  # (1)
    "TableName": ...,
}

parent.describe_contributor_insights(**kwargs)
  1. See DescribeContributorInsightsInputRequestTypeDef

describe_endpoints

Returns the regional endpoint information.

Type annotations and code completion for boto3.client("dynamodb").describe_endpoints method. boto3 documentation

Method definition
def describe_endpoints(
    self,
) -> DescribeEndpointsResponseTypeDef:  # (1)
    ...
  1. See DescribeEndpointsResponseTypeDef

describe_export

Describes an existing table export.

Type annotations and code completion for boto3.client("dynamodb").describe_export method. boto3 documentation

Method definition
def describe_export(
    self,
    *,
    ExportArn: str,
) -> DescribeExportOutputTypeDef:  # (1)
    ...
  1. See DescribeExportOutputTypeDef
Usage example with kwargs
kwargs: DescribeExportInputRequestTypeDef = {  # (1)
    "ExportArn": ...,
}

parent.describe_export(**kwargs)
  1. See DescribeExportInputRequestTypeDef

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

Method definition
def describe_global_table(
    self,
    *,
    GlobalTableName: str,
) -> DescribeGlobalTableOutputTypeDef:  # (1)
    ...
  1. See DescribeGlobalTableOutputTypeDef
Usage example with kwargs
kwargs: DescribeGlobalTableInputRequestTypeDef = {  # (1)
    "GlobalTableName": ...,
}

parent.describe_global_table(**kwargs)
  1. See DescribeGlobalTableInputRequestTypeDef

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

Method definition
def describe_global_table_settings(
    self,
    *,
    GlobalTableName: str,
) -> DescribeGlobalTableSettingsOutputTypeDef:  # (1)
    ...
  1. See DescribeGlobalTableSettingsOutputTypeDef
Usage example with kwargs
kwargs: DescribeGlobalTableSettingsInputRequestTypeDef = {  # (1)
    "GlobalTableName": ...,
}

parent.describe_global_table_settings(**kwargs)
  1. See DescribeGlobalTableSettingsInputRequestTypeDef

describe_import

Represents the properties of the import.

Type annotations and code completion for boto3.client("dynamodb").describe_import method. boto3 documentation

Method definition
def describe_import(
    self,
    *,
    ImportArn: str,
) -> DescribeImportOutputTypeDef:  # (1)
    ...
  1. See DescribeImportOutputTypeDef
Usage example with kwargs
kwargs: DescribeImportInputRequestTypeDef = {  # (1)
    "ImportArn": ...,
}

parent.describe_import(**kwargs)
  1. See DescribeImportInputRequestTypeDef

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

Method definition
def describe_kinesis_streaming_destination(
    self,
    *,
    TableName: str,
) -> DescribeKinesisStreamingDestinationOutputTypeDef:  # (1)
    ...
  1. See DescribeKinesisStreamingDestinationOutputTypeDef
Usage example with kwargs
kwargs: DescribeKinesisStreamingDestinationInputRequestTypeDef = {  # (1)
    "TableName": ...,
}

parent.describe_kinesis_streaming_destination(**kwargs)
  1. See DescribeKinesisStreamingDestinationInputRequestTypeDef

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

Method definition
def describe_limits(
    self,
) -> DescribeLimitsOutputTypeDef:  # (1)
    ...
  1. See DescribeLimitsOutputTypeDef

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

Method definition
def describe_table(
    self,
    *,
    TableName: str,
) -> DescribeTableOutputTypeDef:  # (1)
    ...
  1. See DescribeTableOutputTypeDef
Usage example with kwargs
kwargs: DescribeTableInputRequestTypeDef = {  # (1)
    "TableName": ...,
}

parent.describe_table(**kwargs)
  1. See DescribeTableInputRequestTypeDef

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

Method definition
def describe_table_replica_auto_scaling(
    self,
    *,
    TableName: str,
) -> DescribeTableReplicaAutoScalingOutputTypeDef:  # (1)
    ...
  1. See DescribeTableReplicaAutoScalingOutputTypeDef
Usage example with kwargs
kwargs: DescribeTableReplicaAutoScalingInputRequestTypeDef = {  # (1)
    "TableName": ...,
}

parent.describe_table_replica_auto_scaling(**kwargs)
  1. See DescribeTableReplicaAutoScalingInputRequestTypeDef

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

Method definition
def describe_time_to_live(
    self,
    *,
    TableName: str,
) -> DescribeTimeToLiveOutputTypeDef:  # (1)
    ...
  1. See DescribeTimeToLiveOutputTypeDef
Usage example with kwargs
kwargs: DescribeTimeToLiveInputRequestTypeDef = {  # (1)
    "TableName": ...,
}

parent.describe_time_to_live(**kwargs)
  1. See DescribeTimeToLiveInputRequestTypeDef

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

Method definition
def disable_kinesis_streaming_destination(
    self,
    *,
    TableName: str,
    StreamArn: str,
) -> KinesisStreamingDestinationOutputTypeDef:  # (1)
    ...
  1. See KinesisStreamingDestinationOutputTypeDef
Usage example with kwargs
kwargs: KinesisStreamingDestinationInputRequestTypeDef = {  # (1)
    "TableName": ...,
    "StreamArn": ...,
}

parent.disable_kinesis_streaming_destination(**kwargs)
  1. See KinesisStreamingDestinationInputRequestTypeDef

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

Method definition
def enable_kinesis_streaming_destination(
    self,
    *,
    TableName: str,
    StreamArn: str,
) -> KinesisStreamingDestinationOutputTypeDef:  # (1)
    ...
  1. See KinesisStreamingDestinationOutputTypeDef
Usage example with kwargs
kwargs: KinesisStreamingDestinationInputRequestTypeDef = {  # (1)
    "TableName": ...,
    "StreamArn": ...,
}

parent.enable_kinesis_streaming_destination(**kwargs)
  1. See KinesisStreamingDestinationInputRequestTypeDef

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

Method definition
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)
    ...
  1. See AttributeValueTypeDef
  2. See ReturnConsumedCapacityType
  3. See ExecuteStatementOutputTypeDef
Usage example with kwargs
kwargs: ExecuteStatementInputRequestTypeDef = {  # (1)
    "Statement": ...,
}

parent.execute_statement(**kwargs)
  1. See ExecuteStatementInputRequestTypeDef

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

Method definition
def execute_transaction(
    self,
    *,
    TransactStatements: Sequence[ParameterizedStatementTypeDef],  # (1)
    ClientRequestToken: str = ...,
    ReturnConsumedCapacity: ReturnConsumedCapacityType = ...,  # (2)
) -> ExecuteTransactionOutputTypeDef:  # (3)
    ...
  1. See ParameterizedStatementTypeDef
  2. See ReturnConsumedCapacityType
  3. See ExecuteTransactionOutputTypeDef
Usage example with kwargs
kwargs: ExecuteTransactionInputRequestTypeDef = {  # (1)
    "TransactStatements": ...,
}

parent.execute_transaction(**kwargs)
  1. See ExecuteTransactionInputRequestTypeDef

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

Method definition
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)
    ...
  1. See S3SseAlgorithmType
  2. See ExportFormatType
  3. See ExportTableToPointInTimeOutputTypeDef
Usage example with kwargs
kwargs: ExportTableToPointInTimeInputRequestTypeDef = {  # (1)
    "TableArn": ...,
    "S3Bucket": ...,
}

parent.export_table_to_point_in_time(**kwargs)
  1. See ExportTableToPointInTimeInputRequestTypeDef

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

Method definition
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

Method definition
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)
    ...
  1. See AttributeValueTypeDef
  2. See ReturnConsumedCapacityType
  3. See GetItemOutputTypeDef
Usage example with kwargs
kwargs: GetItemInputRequestTypeDef = {  # (1)
    "TableName": ...,
    "Key": ...,
}

parent.get_item(**kwargs)
  1. See GetItemInputRequestTypeDef

import_table

Imports table data from an S3 bucket.

Type annotations and code completion for boto3.client("dynamodb").import_table method. boto3 documentation

Method definition
def import_table(
    self,
    *,
    S3BucketSource: S3BucketSourceTypeDef,  # (1)
    InputFormat: InputFormatType,  # (2)
    TableCreationParameters: TableCreationParametersTypeDef,  # (3)
    ClientToken: str = ...,
    InputFormatOptions: InputFormatOptionsTypeDef = ...,  # (4)
    InputCompressionType: InputCompressionTypeType = ...,  # (5)
) -> ImportTableOutputTypeDef:  # (6)
    ...
  1. See S3BucketSourceTypeDef
  2. See InputFormatType
  3. See TableCreationParametersTypeDef
  4. See InputFormatOptionsTypeDef
  5. See InputCompressionTypeType
  6. See ImportTableOutputTypeDef
Usage example with kwargs
kwargs: ImportTableInputRequestTypeDef = {  # (1)
    "S3BucketSource": ...,
    "InputFormat": ...,
    "TableCreationParameters": ...,
}

parent.import_table(**kwargs)
  1. See ImportTableInputRequestTypeDef

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

Method definition
def list_backups(
    self,
    *,
    TableName: str = ...,
    Limit: int = ...,
    TimeRangeLowerBound: Union[datetime, str] = ...,
    TimeRangeUpperBound: Union[datetime, str] = ...,
    ExclusiveStartBackupArn: str = ...,
    BackupType: BackupTypeFilterType = ...,  # (1)
) -> ListBackupsOutputTypeDef:  # (2)
    ...
  1. See BackupTypeFilterType
  2. See ListBackupsOutputTypeDef
Usage example with kwargs
kwargs: ListBackupsInputRequestTypeDef = {  # (1)
    "TableName": ...,
}

parent.list_backups(**kwargs)
  1. See ListBackupsInputRequestTypeDef

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

Method definition
def list_contributor_insights(
    self,
    *,
    TableName: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListContributorInsightsOutputTypeDef:  # (1)
    ...
  1. See ListContributorInsightsOutputTypeDef
Usage example with kwargs
kwargs: ListContributorInsightsInputRequestTypeDef = {  # (1)
    "TableName": ...,
}

parent.list_contributor_insights(**kwargs)
  1. See ListContributorInsightsInputRequestTypeDef

list_exports

Lists completed exports within the past 90 days.

Type annotations and code completion for boto3.client("dynamodb").list_exports method. boto3 documentation

Method definition
def list_exports(
    self,
    *,
    TableArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListExportsOutputTypeDef:  # (1)
    ...
  1. See ListExportsOutputTypeDef
Usage example with kwargs
kwargs: ListExportsInputRequestTypeDef = {  # (1)
    "TableArn": ...,
}

parent.list_exports(**kwargs)
  1. See ListExportsInputRequestTypeDef

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

Method definition
def list_global_tables(
    self,
    *,
    ExclusiveStartGlobalTableName: str = ...,
    Limit: int = ...,
    RegionName: str = ...,
) -> ListGlobalTablesOutputTypeDef:  # (1)
    ...
  1. See ListGlobalTablesOutputTypeDef
Usage example with kwargs
kwargs: ListGlobalTablesInputRequestTypeDef = {  # (1)
    "ExclusiveStartGlobalTableName": ...,
}

parent.list_global_tables(**kwargs)
  1. See ListGlobalTablesInputRequestTypeDef

list_imports

Lists completed imports within the past 90 days.

Type annotations and code completion for boto3.client("dynamodb").list_imports method. boto3 documentation

Method definition
def list_imports(
    self,
    *,
    TableArn: str = ...,
    PageSize: int = ...,
    NextToken: str = ...,
) -> ListImportsOutputTypeDef:  # (1)
    ...
  1. See ListImportsOutputTypeDef
Usage example with kwargs
kwargs: ListImportsInputRequestTypeDef = {  # (1)
    "TableArn": ...,
}

parent.list_imports(**kwargs)
  1. See ListImportsInputRequestTypeDef

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

Method definition
def list_tables(
    self,
    *,
    ExclusiveStartTableName: str = ...,
    Limit: int = ...,
) -> ListTablesOutputTypeDef:  # (1)
    ...
  1. See ListTablesOutputTypeDef
Usage example with kwargs
kwargs: ListTablesInputRequestTypeDef = {  # (1)
    "ExclusiveStartTableName": ...,
}

parent.list_tables(**kwargs)
  1. See ListTablesInputRequestTypeDef

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

Method definition
def list_tags_of_resource(
    self,
    *,
    ResourceArn: str,
    NextToken: str = ...,
) -> ListTagsOfResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsOfResourceOutputTypeDef
Usage example with kwargs
kwargs: ListTagsOfResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_of_resource(**kwargs)
  1. See ListTagsOfResourceInputRequestTypeDef

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

Method definition
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)
    ...
  1. See AttributeValueTypeDef
  2. See ExpectedAttributeValueTypeDef
  3. See ReturnValueType
  4. See ReturnConsumedCapacityType
  5. See ReturnItemCollectionMetricsType
  6. See ConditionalOperatorType
  7. See AttributeValueTypeDef
  8. See PutItemOutputTypeDef
Usage example with kwargs
kwargs: PutItemInputRequestTypeDef = {  # (1)
    "TableName": ...,
    "Item": ...,
}

parent.put_item(**kwargs)
  1. See PutItemInputRequestTypeDef

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

Method definition
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)
    ...
  1. See SelectType
  2. See ConditionTypeDef
  3. See ConditionTypeDef
  4. See ConditionalOperatorType
  5. See AttributeValueTypeDef
  6. See ReturnConsumedCapacityType
  7. See AttributeValueTypeDef
  8. See QueryOutputTypeDef
Usage example with kwargs
kwargs: QueryInputRequestTypeDef = {  # (1)
    "TableName": ...,
}

parent.query(**kwargs)
  1. See QueryInputRequestTypeDef

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

Method definition
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)
    ...
  1. See BillingModeType
  2. See GlobalSecondaryIndexTypeDef
  3. See LocalSecondaryIndexTypeDef
  4. See ProvisionedThroughputTypeDef
  5. See SSESpecificationTypeDef
  6. See RestoreTableFromBackupOutputTypeDef
Usage example with kwargs
kwargs: RestoreTableFromBackupInputRequestTypeDef = {  # (1)
    "TargetTableName": ...,
    "BackupArn": ...,
}

parent.restore_table_from_backup(**kwargs)
  1. See RestoreTableFromBackupInputRequestTypeDef

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

Method definition
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)
    ...
  1. See BillingModeType
  2. See GlobalSecondaryIndexTypeDef
  3. See LocalSecondaryIndexTypeDef
  4. See ProvisionedThroughputTypeDef
  5. See SSESpecificationTypeDef
  6. See RestoreTableToPointInTimeOutputTypeDef
Usage example with kwargs
kwargs: RestoreTableToPointInTimeInputRequestTypeDef = {  # (1)
    "TargetTableName": ...,
}

parent.restore_table_to_point_in_time(**kwargs)
  1. See RestoreTableToPointInTimeInputRequestTypeDef

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

Method definition
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)
    ...
  1. See SelectType
  2. See ConditionTypeDef
  3. See ConditionalOperatorType
  4. See AttributeValueTypeDef
  5. See ReturnConsumedCapacityType
  6. See AttributeValueTypeDef
  7. See ScanOutputTypeDef
Usage example with kwargs
kwargs: ScanInputRequestTypeDef = {  # (1)
    "TableName": ...,
}

parent.scan(**kwargs)
  1. See ScanInputRequestTypeDef

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

Method definition
def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceInputRequestTypeDef

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

Method definition
def transact_get_items(
    self,
    *,
    TransactItems: Sequence[TransactGetItemTypeDef],  # (1)
    ReturnConsumedCapacity: ReturnConsumedCapacityType = ...,  # (2)
) -> TransactGetItemsOutputTypeDef:  # (3)
    ...
  1. See TransactGetItemTypeDef
  2. See ReturnConsumedCapacityType
  3. See TransactGetItemsOutputTypeDef
Usage example with kwargs
kwargs: TransactGetItemsInputRequestTypeDef = {  # (1)
    "TransactItems": ...,
}

parent.transact_get_items(**kwargs)
  1. See TransactGetItemsInputRequestTypeDef

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

Method definition
def transact_write_items(
    self,
    *,
    TransactItems: Sequence[TransactWriteItemTypeDef],  # (1)
    ReturnConsumedCapacity: ReturnConsumedCapacityType = ...,  # (2)
    ReturnItemCollectionMetrics: ReturnItemCollectionMetricsType = ...,  # (3)
    ClientRequestToken: str = ...,
) -> TransactWriteItemsOutputTypeDef:  # (4)
    ...
  1. See TransactWriteItemTypeDef
  2. See ReturnConsumedCapacityType
  3. See ReturnItemCollectionMetricsType
  4. See TransactWriteItemsOutputTypeDef
Usage example with kwargs
kwargs: TransactWriteItemsInputRequestTypeDef = {  # (1)
    "TransactItems": ...,
}

parent.transact_write_items(**kwargs)
  1. See TransactWriteItemsInputRequestTypeDef

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

Method definition
def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)