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

# DynamoDBClient 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.

# Exceptions.exceptions usage example

client = boto3.client("dynamodb")

try:
    do_something(client)
except (
    client.exceptions.BackupInUseException,
    client.exceptions.BackupNotFoundException,
    client.exceptions.ClientError,
    client.exceptions.ConditionalCheckFailedException,
    client.exceptions.ContinuousBackupsUnavailableException,
    client.exceptions.DuplicateItemException,
    client.exceptions.ExportConflictException,
    client.exceptions.ExportNotFoundException,
    client.exceptions.GlobalTableAlreadyExistsException,
    client.exceptions.GlobalTableNotFoundException,
    client.exceptions.IdempotentParameterMismatchException,
    client.exceptions.ImportConflictException,
    client.exceptions.ImportNotFoundException,
    client.exceptions.IndexNotFoundException,
    client.exceptions.InternalServerError,
    client.exceptions.InvalidExportTimeException,
    client.exceptions.InvalidRestoreTimeException,
    client.exceptions.ItemCollectionSizeLimitExceededException,
    client.exceptions.LimitExceededException,
    client.exceptions.PointInTimeRecoveryUnavailableException,
    client.exceptions.PolicyNotFoundException,
    client.exceptions.ProvisionedThroughputExceededException,
    client.exceptions.ReplicaAlreadyExistsException,
    client.exceptions.ReplicaNotFoundException,
    client.exceptions.RequestLimitExceeded,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.TableAlreadyExistsException,
    client.exceptions.TableInUseException,
    client.exceptions.TableNotFoundException,
    client.exceptions.TransactionCanceledException,
    client.exceptions.TransactionConflictException,
    client.exceptions.TransactionInProgressException,
) as e:
    print(e)
# Exceptions.exceptions 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

# batch_execute_statement 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 
# batch_execute_statement method usage example with argument unpacking

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

# batch_get_item method definition

def batch_get_item(
    self,
    *,
    RequestItems: Mapping[str, KeysAndAttributesUnionTypeDef],  # (1)
    ReturnConsumedCapacity: ReturnConsumedCapacityType = ...,  # (2)
) -> BatchGetItemOutputTypeDef:  # (3)
    ...
  1. See KeysAndAttributesTypeDef KeysAndAttributesOutputTypeDef
  2. See ReturnConsumedCapacityType
  3. See BatchGetItemOutputTypeDef 
# batch_get_item method usage example with argument unpacking

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

# batch_write_item method definition

def batch_write_item(
    self,
    *,
    RequestItems: Mapping[str, Sequence[WriteRequestUnionTypeDef]],  # (1)
    ReturnConsumedCapacity: ReturnConsumedCapacityType = ...,  # (2)
    ReturnItemCollectionMetrics: ReturnItemCollectionMetricsType = ...,  # (3)
) -> BatchWriteItemOutputTypeDef:  # (4)
    ...
  1. See WriteRequestTypeDef WriteRequestOutputTypeDef
  2. See ReturnConsumedCapacityType
  3. See ReturnItemCollectionMetricsType
  4. See BatchWriteItemOutputTypeDef 
# batch_write_item method usage example with argument unpacking

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

# can_paginate 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

# close 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

# create_backup method definition

def create_backup(
    self,
    *,
    TableName: str,
    BackupName: str,
) -> CreateBackupOutputTypeDef:  # (1)
    ...
  1. See CreateBackupOutputTypeDef 
# create_backup method usage example with argument unpacking

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

# create_global_table method definition

def create_global_table(
    self,
    *,
    GlobalTableName: str,
    ReplicationGroup: Sequence[ReplicaTypeDef],  # (1)
) -> CreateGlobalTableOutputTypeDef:  # (2)
    ...
  1. See ReplicaTypeDef
  2. See CreateGlobalTableOutputTypeDef 
# create_global_table method usage example with argument unpacking

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

# create_table method definition

def create_table(
    self,
    *,
    AttributeDefinitions: Sequence[AttributeDefinitionTypeDef],  # (1)
    TableName: str,
    KeySchema: Sequence[KeySchemaElementTypeDef],  # (2)
    LocalSecondaryIndexes: Sequence[LocalSecondaryIndexTypeDef] = ...,  # (3)
    GlobalSecondaryIndexes: Sequence[GlobalSecondaryIndexUnionTypeDef] = ...,  # (4)
    BillingMode: BillingModeType = ...,  # (5)
    ProvisionedThroughput: ProvisionedThroughputTypeDef = ...,  # (6)
    StreamSpecification: StreamSpecificationTypeDef = ...,  # (7)
    SSESpecification: SSESpecificationTypeDef = ...,  # (8)
    Tags: Sequence[TagTypeDef] = ...,  # (9)
    TableClass: TableClassType = ...,  # (10)
    DeletionProtectionEnabled: bool = ...,
    WarmThroughput: WarmThroughputTypeDef = ...,  # (11)
    ResourcePolicy: str = ...,
    OnDemandThroughput: OnDemandThroughputTypeDef = ...,  # (12)
) -> CreateTableOutputTypeDef:  # (13)
    ...
  1. See AttributeDefinitionTypeDef
  2. See KeySchemaElementTypeDef
  3. See LocalSecondaryIndexTypeDef
  4. See GlobalSecondaryIndexTypeDef GlobalSecondaryIndexOutputTypeDef
  5. See BillingModeType
  6. See ProvisionedThroughputTypeDef
  7. See StreamSpecificationTypeDef
  8. See SSESpecificationTypeDef
  9. See TagTypeDef
  10. See TableClassType
  11. See WarmThroughputTypeDef
  12. See OnDemandThroughputTypeDef
  13. See CreateTableOutputTypeDef 
# create_table method usage example with argument unpacking

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

# delete_backup method definition

def delete_backup(
    self,
    *,
    BackupArn: str,
) -> DeleteBackupOutputTypeDef:  # (1)
    ...
  1. See DeleteBackupOutputTypeDef 
# delete_backup method usage example with argument unpacking

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

# delete_item method definition

def delete_item(
    self,
    *,
    TableName: str,
    Key: Mapping[str, UniversalAttributeValueTypeDef],  # (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, UniversalAttributeValueTypeDef] = ...,  # (1)
    ReturnValuesOnConditionCheckFailure: ReturnValuesOnConditionCheckFailureType = ...,  # (8)
) -> DeleteItemOutputTypeDef:  # (9)
    ...
  1. See AttributeValueTypeDef
  2. See ExpectedAttributeValueTypeDef
  3. See ConditionalOperatorType
  4. See ReturnValueType
  5. See ReturnConsumedCapacityType
  6. See ReturnItemCollectionMetricsType
  7. See AttributeValueTypeDef
  8. See ReturnValuesOnConditionCheckFailureType
  9. See DeleteItemOutputTypeDef 
# delete_item method usage example with argument unpacking

kwargs: DeleteItemInputRequestTypeDef = {  # (1)
    "TableName": ...,
    "Key": ...,
}

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

delete_resource_policy#

Deletes the resource-based policy attached to the resource, which can be a table or stream.

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

# delete_resource_policy method definition

def delete_resource_policy(
    self,
    *,
    ResourceArn: str,
    ExpectedRevisionId: str = ...,
) -> DeleteResourcePolicyOutputTypeDef:  # (1)
    ...
  1. See DeleteResourcePolicyOutputTypeDef 
# delete_resource_policy method usage example with argument unpacking

kwargs: DeleteResourcePolicyInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.delete_resource_policy(**kwargs)
  1. See DeleteResourcePolicyInputRequestTypeDef

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

# delete_table method definition

def delete_table(
    self,
    *,
    TableName: str,
) -> DeleteTableOutputTypeDef:  # (1)
    ...
  1. See DeleteTableOutputTypeDef 
# delete_table method usage example with argument unpacking

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

# describe_backup method definition

def describe_backup(
    self,
    *,
    BackupArn: str,
) -> DescribeBackupOutputTypeDef:  # (1)
    ...
  1. See DescribeBackupOutputTypeDef 
# describe_backup method usage example with argument unpacking

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

# describe_continuous_backups method definition

def describe_continuous_backups(
    self,
    *,
    TableName: str,
) -> DescribeContinuousBackupsOutputTypeDef:  # (1)
    ...
  1. See DescribeContinuousBackupsOutputTypeDef 
# describe_continuous_backups method usage example with argument unpacking

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

# describe_contributor_insights method definition

def describe_contributor_insights(
    self,
    *,
    TableName: str,
    IndexName: str = ...,
) -> DescribeContributorInsightsOutputTypeDef:  # (1)
    ...
  1. See DescribeContributorInsightsOutputTypeDef 
# describe_contributor_insights method usage example with argument unpacking

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

# describe_endpoints 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

# describe_export method definition

def describe_export(
    self,
    *,
    ExportArn: str,
) -> DescribeExportOutputTypeDef:  # (1)
    ...
  1. See DescribeExportOutputTypeDef 
# describe_export method usage example with argument unpacking

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

# describe_global_table method definition

def describe_global_table(
    self,
    *,
    GlobalTableName: str,
) -> DescribeGlobalTableOutputTypeDef:  # (1)
    ...
  1. See DescribeGlobalTableOutputTypeDef 
# describe_global_table method usage example with argument unpacking

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

# describe_global_table_settings method definition

def describe_global_table_settings(
    self,
    *,
    GlobalTableName: str,
) -> DescribeGlobalTableSettingsOutputTypeDef:  # (1)
    ...
  1. See DescribeGlobalTableSettingsOutputTypeDef 
# describe_global_table_settings method usage example with argument unpacking

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

# describe_import method definition

def describe_import(
    self,
    *,
    ImportArn: str,
) -> DescribeImportOutputTypeDef:  # (1)
    ...
  1. See DescribeImportOutputTypeDef 
# describe_import method usage example with argument unpacking

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

# describe_kinesis_streaming_destination method definition

def describe_kinesis_streaming_destination(
    self,
    *,
    TableName: str,
) -> DescribeKinesisStreamingDestinationOutputTypeDef:  # (1)
    ...
  1. See DescribeKinesisStreamingDestinationOutputTypeDef 
# describe_kinesis_streaming_destination method usage example with argument unpacking

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

# describe_limits 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

# describe_table method definition

def describe_table(
    self,
    *,
    TableName: str,
) -> DescribeTableOutputTypeDef:  # (1)
    ...
  1. See DescribeTableOutputTypeDef 
# describe_table method usage example with argument unpacking

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

# describe_table_replica_auto_scaling method definition

def describe_table_replica_auto_scaling(
    self,
    *,
    TableName: str,
) -> DescribeTableReplicaAutoScalingOutputTypeDef:  # (1)
    ...
  1. See DescribeTableReplicaAutoScalingOutputTypeDef 
# describe_table_replica_auto_scaling method usage example with argument unpacking

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

# describe_time_to_live method definition

def describe_time_to_live(
    self,
    *,
    TableName: str,
) -> DescribeTimeToLiveOutputTypeDef:  # (1)
    ...
  1. See DescribeTimeToLiveOutputTypeDef 
# describe_time_to_live method usage example with argument unpacking

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

# disable_kinesis_streaming_destination method definition

def disable_kinesis_streaming_destination(
    self,
    *,
    TableName: str,
    StreamArn: str,
    EnableKinesisStreamingConfiguration: EnableKinesisStreamingConfigurationTypeDef = ...,  # (1)
) -> KinesisStreamingDestinationOutputTypeDef:  # (2)
    ...
  1. See EnableKinesisStreamingConfigurationTypeDef
  2. See KinesisStreamingDestinationOutputTypeDef 
# disable_kinesis_streaming_destination method usage example with argument unpacking

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

# enable_kinesis_streaming_destination method definition

def enable_kinesis_streaming_destination(
    self,
    *,
    TableName: str,
    StreamArn: str,
    EnableKinesisStreamingConfiguration: EnableKinesisStreamingConfigurationTypeDef = ...,  # (1)
) -> KinesisStreamingDestinationOutputTypeDef:  # (2)
    ...
  1. See EnableKinesisStreamingConfigurationTypeDef
  2. See KinesisStreamingDestinationOutputTypeDef 
# enable_kinesis_streaming_destination method usage example with argument unpacking

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

# execute_statement method definition

def execute_statement(
    self,
    *,
    Statement: str,
    Parameters: Sequence[UniversalAttributeValueTypeDef] = ...,  # (1)
    ConsistentRead: bool = ...,
    NextToken: str = ...,
    ReturnConsumedCapacity: ReturnConsumedCapacityType = ...,  # (2)
    Limit: int = ...,
    ReturnValuesOnConditionCheckFailure: ReturnValuesOnConditionCheckFailureType = ...,  # (3)
) -> ExecuteStatementOutputTypeDef:  # (4)
    ...
  1. See AttributeValueTypeDef
  2. See ReturnConsumedCapacityType
  3. See ReturnValuesOnConditionCheckFailureType
  4. See ExecuteStatementOutputTypeDef 
# execute_statement method usage example with argument unpacking

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

# execute_transaction 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 
# execute_transaction method usage example with argument unpacking

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

# export_table_to_point_in_time method definition

def export_table_to_point_in_time(
    self,
    *,
    TableArn: str,
    S3Bucket: str,
    ExportTime: TimestampTypeDef = ...,
    ClientToken: str = ...,
    S3BucketOwner: str = ...,
    S3Prefix: str = ...,
    S3SseAlgorithm: S3SseAlgorithmType = ...,  # (1)
    S3SseKmsKeyId: str = ...,
    ExportFormat: ExportFormatType = ...,  # (2)
    ExportType: ExportTypeType = ...,  # (3)
    IncrementalExportSpecification: IncrementalExportSpecificationTypeDef = ...,  # (4)
) -> ExportTableToPointInTimeOutputTypeDef:  # (5)
    ...
  1. See S3SseAlgorithmType
  2. See ExportFormatType
  3. See ExportTypeType
  4. See IncrementalExportSpecificationTypeDef
  5. See ExportTableToPointInTimeOutputTypeDef 
# export_table_to_point_in_time method usage example with argument unpacking

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

# generate_presigned_url 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

# get_item method definition

def get_item(
    self,
    *,
    TableName: str,
    Key: Mapping[str, UniversalAttributeValueTypeDef],  # (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 
# get_item method usage example with argument unpacking

kwargs: GetItemInputRequestTypeDef = {  # (1)
    "TableName": ...,
    "Key": ...,
}

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

get_resource_policy#

Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.

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

# get_resource_policy method definition

def get_resource_policy(
    self,
    *,
    ResourceArn: str,
) -> GetResourcePolicyOutputTypeDef:  # (1)
    ...
  1. See GetResourcePolicyOutputTypeDef 
# get_resource_policy method usage example with argument unpacking

kwargs: GetResourcePolicyInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_resource_policy(**kwargs)
  1. See GetResourcePolicyInputRequestTypeDef

import_table#

Imports table data from an S3 bucket.

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

# import_table 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 
# import_table method usage example with argument unpacking

kwargs: ImportTableInputRequestTypeDef = {  # (1)
    "S3BucketSource": ...,
    "InputFormat": ...,
    "TableCreationParameters": ...,
}

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

list_backups#

List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup.

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

# list_backups method definition

def list_backups(
    self,
    *,
    TableName: str = ...,
    Limit: int = ...,
    TimeRangeLowerBound: TimestampTypeDef = ...,
    TimeRangeUpperBound: TimestampTypeDef = ...,
    ExclusiveStartBackupArn: str = ...,
    BackupType: BackupTypeFilterType = ...,  # (1)
) -> ListBackupsOutputTypeDef:  # (2)
    ...
  1. See BackupTypeFilterType
  2. See ListBackupsOutputTypeDef 
# list_backups method usage example with argument unpacking

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

# list_contributor_insights method definition

def list_contributor_insights(
    self,
    *,
    TableName: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListContributorInsightsOutputTypeDef:  # (1)
    ...
  1. See ListContributorInsightsOutputTypeDef 
# list_contributor_insights method usage example with argument unpacking

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

# list_exports method definition

def list_exports(
    self,
    *,
    TableArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListExportsOutputTypeDef:  # (1)
    ...
  1. See ListExportsOutputTypeDef 
# list_exports method usage example with argument unpacking

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

# list_global_tables method definition

def list_global_tables(
    self,
    *,
    ExclusiveStartGlobalTableName: str = ...,
    Limit: int = ...,
    RegionName: str = ...,
) -> ListGlobalTablesOutputTypeDef:  # (1)
    ...
  1. See ListGlobalTablesOutputTypeDef 
# list_global_tables method usage example with argument unpacking

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

# list_imports method definition

def list_imports(
    self,
    *,
    TableArn: str = ...,
    PageSize: int = ...,
    NextToken: str = ...,
) -> ListImportsOutputTypeDef:  # (1)
    ...
  1. See ListImportsOutputTypeDef 
# list_imports method usage example with argument unpacking

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

# list_tables method definition

def list_tables(
    self,
    *,
    ExclusiveStartTableName: str = ...,
    Limit: int = ...,
) -> ListTablesOutputTypeDef:  # (1)
    ...
  1. See ListTablesOutputTypeDef 
# list_tables method usage example with argument unpacking

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

# list_tags_of_resource method definition

def list_tags_of_resource(
    self,
    *,
    ResourceArn: str,
    NextToken: str = ...,
) -> ListTagsOfResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsOfResourceOutputTypeDef 
# list_tags_of_resource method usage example with argument unpacking

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

# put_item method definition

def put_item(
    self,
    *,
    TableName: str,
    Item: Mapping[str, UniversalAttributeValueTypeDef],  # (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, UniversalAttributeValueTypeDef] = ...,  # (1)
    ReturnValuesOnConditionCheckFailure: ReturnValuesOnConditionCheckFailureType = ...,  # (8)
) -> PutItemOutputTypeDef:  # (9)
    ...
  1. See AttributeValueTypeDef
  2. See ExpectedAttributeValueTypeDef
  3. See ReturnValueType
  4. See ReturnConsumedCapacityType
  5. See ReturnItemCollectionMetricsType
  6. See ConditionalOperatorType
  7. See AttributeValueTypeDef
  8. See ReturnValuesOnConditionCheckFailureType
  9. See PutItemOutputTypeDef 
# put_item method usage example with argument unpacking

kwargs: PutItemInputRequestTypeDef = {  # (1)
    "TableName": ...,
    "Item": ...,
}

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

put_resource_policy#

Attaches a resource-based policy document to the resource, which can be a table or stream.

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

# put_resource_policy method definition

def put_resource_policy(
    self,
    *,
    ResourceArn: str,
    Policy: str,
    ExpectedRevisionId: str = ...,
    ConfirmRemoveSelfResourceAccess: bool = ...,
) -> PutResourcePolicyOutputTypeDef:  # (1)
    ...
  1. See PutResourcePolicyOutputTypeDef 
# put_resource_policy method usage example with argument unpacking

kwargs: PutResourcePolicyInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Policy": ...,
}

parent.put_resource_policy(**kwargs)
  1. See PutResourcePolicyInputRequestTypeDef

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

# query 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, UniversalAttributeValueTypeDef] = ...,  # (5)
    ReturnConsumedCapacity: ReturnConsumedCapacityType = ...,  # (6)
    ProjectionExpression: str = ...,
    FilterExpression: str = ...,
    KeyConditionExpression: str = ...,
    ExpressionAttributeNames: Mapping[str, str] = ...,
    ExpressionAttributeValues: Mapping[str, UniversalAttributeValueTypeDef] = ...,  # (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 
# query method usage example with argument unpacking

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

# restore_table_from_backup 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)
    OnDemandThroughputOverride: OnDemandThroughputTypeDef = ...,  # (5)
    SSESpecificationOverride: SSESpecificationTypeDef = ...,  # (6)
) -> RestoreTableFromBackupOutputTypeDef:  # (7)
    ...
  1. See BillingModeType
  2. See GlobalSecondaryIndexTypeDef
  3. See LocalSecondaryIndexTypeDef
  4. See ProvisionedThroughputTypeDef
  5. See OnDemandThroughputTypeDef
  6. See SSESpecificationTypeDef
  7. See RestoreTableFromBackupOutputTypeDef 
# restore_table_from_backup method usage example with argument unpacking

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

# restore_table_to_point_in_time method definition

def restore_table_to_point_in_time(
    self,
    *,
    TargetTableName: str,
    SourceTableArn: str = ...,
    SourceTableName: str = ...,
    UseLatestRestorableTime: bool = ...,
    RestoreDateTime: TimestampTypeDef = ...,
    BillingModeOverride: BillingModeType = ...,  # (1)
    GlobalSecondaryIndexOverride: Sequence[GlobalSecondaryIndexTypeDef] = ...,  # (2)
    LocalSecondaryIndexOverride: Sequence[LocalSecondaryIndexTypeDef] = ...,  # (3)
    ProvisionedThroughputOverride: ProvisionedThroughputTypeDef = ...,  # (4)
    OnDemandThroughputOverride: OnDemandThroughputTypeDef = ...,  # (5)
    SSESpecificationOverride: SSESpecificationTypeDef = ...,  # (6)
) -> RestoreTableToPointInTimeOutputTypeDef:  # (7)
    ...
  1. See BillingModeType
  2. See GlobalSecondaryIndexTypeDef
  3. See LocalSecondaryIndexTypeDef
  4. See ProvisionedThroughputTypeDef
  5. See OnDemandThroughputTypeDef
  6. See SSESpecificationTypeDef
  7. See RestoreTableToPointInTimeOutputTypeDef 
# restore_table_to_point_in_time method usage example with argument unpacking

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

# scan 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, UniversalAttributeValueTypeDef] = ...,  # (4)
    ReturnConsumedCapacity: ReturnConsumedCapacityType = ...,  # (5)
    TotalSegments: int = ...,
    Segment: int = ...,
    ProjectionExpression: str = ...,
    FilterExpression: str = ...,
    ExpressionAttributeNames: Mapping[str, str] = ...,
    ExpressionAttributeValues: Mapping[str, UniversalAttributeValueTypeDef] = ...,  # (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 
# scan method usage example with argument unpacking

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See EmptyResponseMetadataTypeDef 
# tag_resource method usage example with argument unpacking

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

# transact_get_items 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 
# transact_get_items method usage example with argument unpacking

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

# transact_write_items 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 
# transact_write_items method usage example with argument unpacking

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceInputRequestTypeDef

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

# update_continuous_backups method definition

def update_continuous_backups(
    self,
    *,
    TableName: str,
    PointInTimeRecoverySpecification: PointInTimeRecoverySpecificationTypeDef,  # (1)
) -> UpdateContinuousBackupsOutputTypeDef:  # (2)
    ...
  1. See PointInTimeRecoverySpecificationTypeDef
  2. See UpdateContinuousBackupsOutputTypeDef 
# update_continuous_backups method usage example with argument unpacking

kwargs: UpdateContinuousBackupsInputRequestTypeDef = {  # (1)
    "TableName": ...,
    "PointInTimeRecoverySpecification": ...,
}

parent.update_continuous_backups(**kwargs)
  1. See UpdateContinuousBackupsInputRequestTypeDef

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

# update_contributor_insights method definition

def update_contributor_insights(
    self,
    *,
    TableName: str,
    ContributorInsightsAction: ContributorInsightsActionType,  # (1)
    IndexName: str = ...,
) -> UpdateContributorInsightsOutputTypeDef:  # (2)
    ...
  1. See ContributorInsightsActionType
  2. See UpdateContributorInsightsOutputTypeDef 
# update_contributor_insights method usage example with argument unpacking

kwargs: UpdateContributorInsightsInputRequestTypeDef = {  # (1)
    "TableName": ...,
    "ContributorInsightsAction": ...,
}

parent.update_contributor_insights(**kwargs)
  1. See UpdateContributorInsightsInputRequestTypeDef

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

# update_global_table method definition

def update_global_table(
    self,
    *,
    GlobalTableName: str,
    ReplicaUpdates: Sequence[ReplicaUpdateTypeDef],  # (1)
) -> UpdateGlobalTableOutputTypeDef:  # (2)
    ...
  1. See ReplicaUpdateTypeDef
  2. See UpdateGlobalTableOutputTypeDef 
# update_global_table method usage example with argument unpacking

kwargs: UpdateGlobalTableInputRequestTypeDef = {  # (1)
    "GlobalTableName": ...,
    "ReplicaUpdates": ...,
}

parent.update_global_table(**kwargs)
  1. See UpdateGlobalTableInputRequestTypeDef

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

# update_global_table_settings method definition

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)
    ...
  1. See BillingModeType
  2. See AutoScalingSettingsUpdateTypeDef
  3. See GlobalTableGlobalSecondaryIndexSettingsUpdateTypeDef
  4. See ReplicaSettingsUpdateTypeDef
  5. See UpdateGlobalTableSettingsOutputTypeDef 
# update_global_table_settings method usage example with argument unpacking

kwargs: UpdateGlobalTableSettingsInputRequestTypeDef = {  # (1)
    "GlobalTableName": ...,
}

parent.update_global_table_settings(**kwargs)
  1. See UpdateGlobalTableSettingsInputRequestTypeDef

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

# update_item method definition

def update_item(
    self,
    *,
    TableName: str,
    Key: Mapping[str, UniversalAttributeValueTypeDef],  # (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, UniversalAttributeValueTypeDef] = ...,  # (1)
    ReturnValuesOnConditionCheckFailure: ReturnValuesOnConditionCheckFailureType = ...,  # (9)
) -> UpdateItemOutputTypeDef:  # (10)
    ...
  1. See AttributeValueTypeDef
  2. See AttributeValueUpdateTypeDef
  3. See ExpectedAttributeValueTypeDef
  4. See ConditionalOperatorType
  5. See ReturnValueType
  6. See ReturnConsumedCapacityType
  7. See ReturnItemCollectionMetricsType
  8. See AttributeValueTypeDef
  9. See ReturnValuesOnConditionCheckFailureType
  10. See UpdateItemOutputTypeDef 
# update_item method usage example with argument unpacking

kwargs: UpdateItemInputRequestTypeDef = {  # (1)
    "TableName": ...,
    "Key": ...,
}

parent.update_item(**kwargs)
  1. See UpdateItemInputRequestTypeDef

update_kinesis_streaming_destination#

The command to update the Kinesis stream destination.

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

# update_kinesis_streaming_destination method definition

def update_kinesis_streaming_destination(
    self,
    *,
    TableName: str,
    StreamArn: str,
    UpdateKinesisStreamingConfiguration: UpdateKinesisStreamingConfigurationTypeDef = ...,  # (1)
) -> UpdateKinesisStreamingDestinationOutputTypeDef:  # (2)
    ...
  1. See UpdateKinesisStreamingConfigurationTypeDef
  2. See UpdateKinesisStreamingDestinationOutputTypeDef 
# update_kinesis_streaming_destination method usage example with argument unpacking

kwargs: UpdateKinesisStreamingDestinationInputRequestTypeDef = {  # (1)
    "TableName": ...,
    "StreamArn": ...,
}

parent.update_kinesis_streaming_destination(**kwargs)
  1. See UpdateKinesisStreamingDestinationInputRequestTypeDef

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

# update_table method definition

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 = ...,
    OnDemandThroughput: OnDemandThroughputTypeDef = ...,  # (9)
    WarmThroughput: WarmThroughputTypeDef = ...,  # (10)
) -> UpdateTableOutputTypeDef:  # (11)
    ...
  1. See AttributeDefinitionTypeDef
  2. See BillingModeType
  3. See ProvisionedThroughputTypeDef
  4. See GlobalSecondaryIndexUpdateTypeDef
  5. See StreamSpecificationTypeDef
  6. See SSESpecificationTypeDef
  7. See ReplicationGroupUpdateTypeDef
  8. See TableClassType
  9. See OnDemandThroughputTypeDef
  10. See WarmThroughputTypeDef
  11. See UpdateTableOutputTypeDef 
# update_table method usage example with argument unpacking

kwargs: UpdateTableInputRequestTypeDef = {  # (1)
    "TableName": ...,
}

parent.update_table(**kwargs)
  1. See UpdateTableInputRequestTypeDef

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

# update_table_replica_auto_scaling method definition

def update_table_replica_auto_scaling(
    self,
    *,
    TableName: str,
    GlobalSecondaryIndexUpdates: Sequence[GlobalSecondaryIndexAutoScalingUpdateTypeDef] = ...,  # (1)
    ProvisionedWriteCapacityAutoScalingUpdate: AutoScalingSettingsUpdateTypeDef = ...,  # (2)
    ReplicaUpdates: Sequence[ReplicaAutoScalingUpdateTypeDef] = ...,  # (3)
) -> UpdateTableReplicaAutoScalingOutputTypeDef:  # (4)
    ...
  1. See GlobalSecondaryIndexAutoScalingUpdateTypeDef
  2. See AutoScalingSettingsUpdateTypeDef
  3. See ReplicaAutoScalingUpdateTypeDef
  4. See UpdateTableReplicaAutoScalingOutputTypeDef 
# update_table_replica_auto_scaling method usage example with argument unpacking

kwargs: UpdateTableReplicaAutoScalingInputRequestTypeDef = {  # (1)
    "TableName": ...,
}

parent.update_table_replica_auto_scaling(**kwargs)
  1. See UpdateTableReplicaAutoScalingInputRequestTypeDef

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

# update_time_to_live method definition

def update_time_to_live(
    self,
    *,
    TableName: str,
    TimeToLiveSpecification: TimeToLiveSpecificationTypeDef,  # (1)
) -> UpdateTimeToLiveOutputTypeDef:  # (2)
    ...
  1. See TimeToLiveSpecificationTypeDef
  2. See UpdateTimeToLiveOutputTypeDef 
# update_time_to_live method usage example with argument unpacking

kwargs: UpdateTimeToLiveInputRequestTypeDef = {  # (1)
    "TableName": ...,
    "TimeToLiveSpecification": ...,
}

parent.update_time_to_live(**kwargs)
  1. See UpdateTimeToLiveInputRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("dynamodb").get_paginator method with overloads.

get_waiter#

Type annotations and code completion for boto3.client("dynamodb").get_waiter method with overloads.