document_client
library
Classes
ArchivalSummary
Contains details of a table archival operation.
AttributeDefinition
Represents an attribute for describing the key schema for the table and
indexes.
AttributeValue
Represents the data for an attribute.
AttributeValueUpdate
For the UpdateItem
operation, represents the attributes to be
modified, the action to perform on each, and the new value for each.
Attribute values cannot be null; string and binary type attributes must have
lengths greater than zero; and set type attributes must not be empty.
Requests with empty values will be rejected with a
ValidationException
exception.
AutoScalingPolicyDescription
Represents the properties of the scaling policy.
AutoScalingPolicyUpdate
Represents the auto scaling policy to be modified.
AutoScalingSettingsDescription
Represents the auto scaling settings for a global table or global secondary
index.
AutoScalingSettingsUpdate
Represents the auto scaling settings to be modified for a global table or
global secondary index.
AutoScalingTargetTrackingScalingPolicyConfigurationDescription
Represents the properties of a target tracking scaling policy.
AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
Represents the settings of a target tracking scaling policy that will be
modified.
AwsClientCredentials
AWS credentials.
BackupDescription
Contains the description of the backup created for the table.
BackupDetails
Contains the details of the backup created for the table.
BackupSummary
Contains details for the backup.
BatchExecuteStatementOutput
BatchGetItemOutput
Represents the output of a BatchGetItem
operation.
BatchGetOutput
BatchStatementError
An error associated with a statement in a PartiQL batch that was run.
BatchStatementRequest
A PartiQL batch statement request.
BatchStatementResponse
A PartiQL batch statement response..
BatchWriteItemOutput
Represents the output of a BatchWriteItem
operation.
BatchWriteOutput
BillingModeSummary
Contains the details for the read/write capacity mode.
Capacity
Represents the amount of provisioned throughput capacity consumed on a table
or an index.
Condition
Represents the selection criteria for a Query
or
Scan
operation:
ConditionCheck
Represents a request to perform a check that an item exists or to check the
condition of specific attributes of the item.
ConditionDC
ConsumedCapacity
The capacity units consumed by an operation. The data returned includes the
total provisioned throughput consumed, along with statistics for the table
and any indexes involved in the operation. ConsumedCapacity
is
only returned if the request asked for it. For more information, see Provisioned
Throughput in the Amazon DynamoDB Developer Guide .
ContinuousBackupsDescription
Represents the continuous backups and point in time recovery settings on the
table.
ContributorInsightsSummary
Represents a Contributor Insights summary entry.
CreateBackupOutput
CreateGlobalSecondaryIndexAction
Represents a new global secondary index to be added to an existing table.
CreateGlobalTableOutput
CreateReplicaAction
Represents a replica to be added.
CreateReplicationGroupMemberAction
Represents a replica to be created.
CreateTableOutput
Represents the output of a CreateTable
operation.
Delete
Represents a request to perform a DeleteItem
operation.
DeleteBackupOutput
DeleteGlobalSecondaryIndexAction
Represents a global secondary index to be deleted from an existing table.
DeleteItemOutput
Represents the output of a DeleteItem
operation.
DeleteReplicaAction
Represents a replica to be removed.
DeleteReplicationGroupMemberAction
Represents a replica to be deleted.
DeleteRequest
Represents a request to perform a DeleteItem
operation on an
item.
DeleteTableOutput
Represents the output of a DeleteTable
operation.
DescribeBackupOutput
DescribeContinuousBackupsOutput
DescribeContributorInsightsOutput
DescribeEndpointsResponse
DescribeExportOutput
DescribeGlobalTableOutput
DescribeGlobalTableSettingsOutput
DescribeKinesisStreamingDestinationOutput
DescribeLimitsOutput
Represents the output of a DescribeLimits
operation.
DescribeTableOutput
Represents the output of a DescribeTable
operation.
DescribeTableReplicaAutoScalingOutput
DescribeTimeToLiveOutput
DocumentClient
The document client simplifies working with items in Amazon DynamoDB
by abstracting away the notion of attribute values. This abstraction
annotates native Dart types supplied as input parameters, as well
as converts annotated response data to native Dart types.
DynamoDB
Amazon DynamoDB is a fully managed NoSQL database service that provides fast
and predictable performance with seamless scalability. DynamoDB lets you
offload the administrative burdens of operating and scaling a distributed
database, so that you don't have to worry about hardware provisioning, setup
and configuration, replication, software patching, or cluster scaling.
Endpoint
An endpoint information details.
ExecuteStatementOutput
ExecuteTransactionOutput
ExpectedAttributeValue
Represents a condition to be compared with an attribute value. This
condition can be used with DeleteItem
, PutItem
, or
UpdateItem
operations; if the comparison evaluates to true, the
operation succeeds; if not, the operation fails. You can use
ExpectedAttributeValue
in one of two different ways:
ExpectedAttributeValueDC
ExportDescription
Represents the properties of the exported table.
ExportSummary
Summary information about an export task.
ExportTableToPointInTimeOutput
FailureException
Represents a failure a contributor insights operation.
Get
Specifies an item and related attribute values to retrieve in a
TransactGetItem
object.
GetDC
GetItemOutput
Represents the output of a GetItem
operation.
GetOutput
GlobalSecondaryIndex
Represents the properties of a global secondary index.
GlobalSecondaryIndexAutoScalingUpdate
Represents the auto scaling settings of a global secondary index for a
global table that will be modified.
GlobalSecondaryIndexDescription
Represents the properties of a global secondary index.
GlobalSecondaryIndexInfo
Represents the properties of a global secondary index for the table when the
backup was created.
GlobalSecondaryIndexUpdate
Represents one of the following:
GlobalTable
Represents the properties of a global table.
GlobalTableDescription
Contains details about the global table.
GlobalTableGlobalSecondaryIndexSettingsUpdate
Represents the settings of a global secondary index for a global table that
will be modified.
ItemCollectionMetrics
Information about item collections, if any, that were affected by the
operation. ItemCollectionMetrics
is only returned if the
request asked for it. If the table does not have any local secondary
indexes, this information is not returned in the response.
ItemCollectionMetricsDC
ItemResponse
Details for the requested item.
KeysAndAttributes
Represents a set of primary keys and, for each key, the attributes to
retrieve from the table.
KeysAndProjection
KeySchemaElement
Represents a single element of a key schema. A key schema specifies
the attributes that make up the primary key of a table, or the key
attributes of an index.
KinesisDataStreamDestination
Describes a Kinesis data stream destination.
KinesisStreamingDestinationOutput
ListBackupsOutput
ListContributorInsightsOutput
ListExportsOutput
ListGlobalTablesOutput
ListTablesOutput
Represents the output of a ListTables
operation.
ListTagsOfResourceOutput
LocalSecondaryIndex
Represents the properties of a local secondary index.
LocalSecondaryIndexDescription
Represents the properties of a local secondary index.
LocalSecondaryIndexInfo
Represents the properties of a local secondary index for the table when the
backup was created.
Operation
OperationOutput
ParameterizedStatement
Represents a PartiQL statment that uses parameters.
PointInTimeRecoveryDescription
The description of the point in time settings applied to the table.
PointInTimeRecoverySpecification
Represents the settings used to enable point in time recovery.
Projection
Represents attributes that are copied (projected) from the table into an
index. These are in addition to the primary key attributes and index key
attributes, which are automatically projected.
ProvisionedThroughput
Represents the provisioned throughput settings for a specified table or
index. The settings can be modified using the UpdateTable
operation.
ProvisionedThroughputDescription
Represents the provisioned throughput settings for the table, consisting of
read and write capacity units, along with data about increases and
decreases.
ProvisionedThroughputOverride
Replica-specific provisioned throughput settings. If not specified, uses the
source table's provisioned throughput settings.
Put
Represents a request to perform a PutItem
operation.
PutItemOutput
Represents the output of a PutItem
operation.
PutRequest
Represents a request to perform a PutItem
operation on an item.
QueryOutput
Represents the output of a Query
operation.
QueryOutputDC
Replica
Represents the properties of a replica.
ReplicaAutoScalingDescription
Represents the auto scaling settings of the replica.
ReplicaAutoScalingUpdate
Represents the auto scaling settings of a replica that will be modified.
ReplicaDescription
Contains the details of the replica.
ReplicaGlobalSecondaryIndex
Represents the properties of a replica global secondary index.
ReplicaGlobalSecondaryIndexAutoScalingDescription
Represents the auto scaling configuration for a replica global secondary
index.
ReplicaGlobalSecondaryIndexAutoScalingUpdate
Represents the auto scaling settings of a global secondary index for a
replica that will be modified.
ReplicaGlobalSecondaryIndexDescription
Represents the properties of a replica global secondary index.
ReplicaGlobalSecondaryIndexSettingsDescription
Represents the properties of a global secondary index.
ReplicaGlobalSecondaryIndexSettingsUpdate
Represents the settings of a global secondary index for a global table that
will be modified.
ReplicaSettingsDescription
Represents the properties of a replica.
ReplicaSettingsUpdate
Represents the settings for a global table in a Region that will be
modified.
ReplicationGroupUpdate
Represents one of the following:
ReplicaUpdate
Represents one of the following:
RestoreSummary
Contains details for the restore.
RestoreTableFromBackupOutput
RestoreTableToPointInTimeOutput
ScanOutput
Represents the output of a Scan
operation.
SourceTableDetails
Contains the details of the table when the backup was created.
SourceTableFeatureDetails
Contains the details of the features enabled on the table when the backup
was created. For example, LSIs, GSIs, streams, TTL.
SSEDescription
The description of the server-side encryption status on the specified table.
SSESpecification
Represents the settings used to enable server-side encryption.
StreamSpecification
Represents the DynamoDB Streams configuration for a table in DynamoDB.
TableAutoScalingDescription
Represents the auto scaling configuration for a global table.
TableDescription
Represents the properties of a table.
Tag
Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a
single DynamoDB table.
TimeToLiveDescription
The description of the Time to Live (TTL) status on the specified table.
TimeToLiveSpecification
Represents the settings used to enable or disable Time to Live (TTL) for the
specified table.
TransactGetItem
Specifies an item to be retrieved as part of the transaction.
TransactGetItemsOutput
TransactGetOutput
TransactWrite
TransactWriteItem
A list of requests that can perform update, put, delete, or check operations
on multiple items in one or more tables atomically.
TransactWriteItemsOutput
Update
Represents a request to perform an UpdateItem
operation.
UpdateContinuousBackupsOutput
UpdateContributorInsightsOutput
UpdateDC
UpdateGlobalSecondaryIndexAction
Represents the new provisioned throughput settings to be applied to a global
secondary index.
UpdateGlobalTableOutput
UpdateGlobalTableSettingsOutput
UpdateItemOutput
Represents the output of an UpdateItem
operation.
UpdateOperation
UpdateReplicationGroupMemberAction
Represents a replica to be modified.
UpdateTableOutput
Represents the output of an UpdateTable
operation.
UpdateTableReplicaAutoScalingOutput
UpdateTimeToLiveOutput
Write
WriteRequest
Represents an operation to perform - either DeleteItem
or
PutItem
. You can only request one of these operations, not
both, in a single WriteRequest
. If you do need to perform both
of these operations, you need to provide two separate
WriteRequest
objects.