Package-level declarations

Types

Link copied to clipboard

Contains details of a table archival operation.

Link copied to clipboard
sealed class AttributeAction
Link copied to clipboard

Represents an attribute for describing the schema for the table and indexes.

Link copied to clipboard
sealed class AttributeValue

Represents the data for an attribute.

Link copied to clipboard

For the UpdateItem operation, represents the attributes to be modified, the action to perform on each, and the new value for each.

Link copied to clipboard

Represents the properties of the scaling policy.

Link copied to clipboard

Represents the auto scaling policy to be modified.

Link copied to clipboard

Represents the auto scaling settings for a global table or global secondary index.

Link copied to clipboard

Represents the auto scaling settings to be modified for a global table or global secondary index.

Represents the properties of a target tracking scaling policy.

Represents the settings of a target tracking scaling policy that will be modified.

Link copied to clipboard

Contains the description of the backup created for the table.

Link copied to clipboard

Contains the details of the backup created for the table.

Link copied to clipboard

There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.

Link copied to clipboard

Backup not found for the given BackupARN.

Link copied to clipboard
sealed class BackupStatus
Link copied to clipboard

Contains details for the backup.

Link copied to clipboard
sealed class BackupType
Link copied to clipboard
sealed class BackupTypeFilter
Link copied to clipboard

Represents the input of a BatchGetItem operation.

Link copied to clipboard

Represents the output of a BatchGetItem operation.

Link copied to clipboard

An error associated with a statement in a PartiQL batch that was run.

Link copied to clipboard
Link copied to clipboard

A PartiQL batch statement request.

Link copied to clipboard

A PartiQL batch statement response..

Link copied to clipboard

Represents the input of a BatchWriteItem operation.

Link copied to clipboard

Represents the output of a BatchWriteItem operation.

Link copied to clipboard
sealed class BillingMode
Link copied to clipboard

Contains the details for the read/write capacity mode. This page talks about PROVISIONED and PAY_PER_REQUEST billing modes. For more information about these modes, see Read/write capacity mode.

Link copied to clipboard

An ordered list of errors for each item in the request which caused the transaction to get cancelled. The values of the list are ordered according to the ordering of the TransactWriteItems request parameter. If no error occurred for the associated item an error with a Null code and Null message will be present.

Link copied to clipboard
class Capacity

Represents the amount of provisioned throughput capacity consumed on a table or an index.

Link copied to clipboard
sealed class ComparisonOperator
Link copied to clipboard
class Condition

Represents the selection criteria for a Query or Scan operation:

Link copied to clipboard

A condition specified in the operation failed to be evaluated.

Link copied to clipboard
sealed class ConditionalOperator
Link copied to clipboard

Represents a request to perform a check that an item exists or to check the condition of specific attributes of the item.

Link copied to clipboard

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 capacity mode in the Amazon DynamoDB Developer Guide.

Link copied to clipboard

Represents the continuous backups and point in time recovery settings on the table.

Link copied to clipboard
Link copied to clipboard

Backups have not yet been enabled for this table.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Represents a Contributor Insights summary entry.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Represents a new global secondary index to be added to an existing table.

Link copied to clipboard
Link copied to clipboard

Specifies the action to add a new witness Region to a MRSC global table. A MRSC global table can be configured with either three replicas, or with two replicas and one witness.

Link copied to clipboard

Represents a replica to be added.

Link copied to clipboard

Represents a replica to be created.

Link copied to clipboard

Represents the input of a CreateTable operation.

Link copied to clipboard

Represents the output of a CreateTable operation.

Link copied to clipboard

Processing options for the CSV file being imported.

Link copied to clipboard
class Delete

Represents a request to perform a DeleteItem operation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Represents a global secondary index to be deleted from an existing table.

Specifies the action to remove a witness Region from a MRSC global table. You cannot delete a single witness from a MRSC global table - you must delete both a replica and the witness together. The deletion of both a witness and replica converts the remaining replica to a single-Region DynamoDB table.

Link copied to clipboard

Represents the input of a DeleteItem operation.

Link copied to clipboard

Represents the output of a DeleteItem operation.

Link copied to clipboard

Represents a replica to be removed.

Link copied to clipboard

Represents a replica to be deleted.

Link copied to clipboard

Represents a request to perform a DeleteItem operation on an item.

Link copied to clipboard

Represents the input of a DeleteTable operation.

Link copied to clipboard

Represents the output of a DeleteTable operation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Represents the input of a DescribeLimits operation. Has no content.

Link copied to clipboard

Represents the output of a DescribeLimits operation.

Link copied to clipboard

Represents the input of a DescribeTable operation.

Link copied to clipboard

Represents the output of a DescribeTable operation.

Link copied to clipboard
Link copied to clipboard
sealed class DestinationStatus
Link copied to clipboard

There was an attempt to insert an item with the same primary key as an item that already exists in the DynamoDB table.

Link copied to clipboard

Base class for all service related exceptions thrown by the DynamoDb client

Link copied to clipboard

Enables setting the configuration for Kinesis Streaming.

Link copied to clipboard
class Endpoint

An endpoint information details.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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:

Link copied to clipboard

There was a conflict when writing to the specified S3 bucket.

Link copied to clipboard

Represents the properties of the exported table.

Link copied to clipboard
sealed class ExportFormat
Link copied to clipboard

The specified export was not found.

Link copied to clipboard
sealed class ExportStatus
Link copied to clipboard

Summary information about an export task.

Link copied to clipboard
sealed class ExportType
Link copied to clipboard
sealed class ExportViewType
Link copied to clipboard

Represents a failure a contributor insights operation.

Link copied to clipboard
class Get

Specifies an item and related attribute values to retrieve in a TransactGetItem object.

Link copied to clipboard

Represents the input of a GetItem operation.

Link copied to clipboard

Represents the output of a GetItem operation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Represents the properties of a global secondary index.

Link copied to clipboard

Represents the auto scaling settings of a global secondary index for a global table that will be modified.

Link copied to clipboard

Represents the properties of a global secondary index.

Link copied to clipboard

Represents the properties of a global secondary index for the table when the backup was created.

Link copied to clipboard

Represents one of the following:

The description of the warm throughput value on a global secondary index.

Link copied to clipboard

Represents the properties of a global table.

Link copied to clipboard

The specified global table already exists.

Link copied to clipboard

Contains details about the global table.

Represents the settings of a global secondary index for a global table that will be modified.

Link copied to clipboard

The specified global table does not exist.

Link copied to clipboard
sealed class GlobalTableStatus
Link copied to clipboard

Represents the properties of a witness Region in a MRSC global table.

Link copied to clipboard

Represents one of the following:

Link copied to clipboard

DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.

Link copied to clipboard

There was a conflict when importing from the specified S3 source. This can occur when the current import conflicts with a previous import request that had the same client token.

Link copied to clipboard

The specified import was not found.

Link copied to clipboard
sealed class ImportStatus
Link copied to clipboard

Summary information about the source file for the import.

Link copied to clipboard

Represents the properties of the table being imported into.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Optional object containing the parameters specific to an incremental export.

Link copied to clipboard

The operation tried to access a nonexistent index.

Link copied to clipboard
sealed class IndexStatus
Link copied to clipboard
Link copied to clipboard
sealed class InputFormat
Link copied to clipboard

The format options for the data that was imported into the target table. There is one value, CsvOption.

Link copied to clipboard

An error occurred on the server side.

Link copied to clipboard

The specified ExportTime is outside of the point in time recovery window.

Link copied to clipboard

An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.

Link copied to clipboard

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.

Link copied to clipboard

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

Link copied to clipboard

Details for the requested item.

Link copied to clipboard

Represents a set of primary keys and, for each key, the attributes to retrieve from the table.

Link copied to clipboard

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.

Link copied to clipboard
sealed class KeyType
Link copied to clipboard

Describes a Kinesis data stream destination.

Link copied to clipboard

There is no limit to the number of daily on-demand backups that can be taken.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Represents the input of a ListTables operation.

Link copied to clipboard

Represents the output of a ListTables operation.

Link copied to clipboard
Link copied to clipboard

Represents the properties of a local secondary index.

Link copied to clipboard

Represents the properties of a local secondary index.

Link copied to clipboard

Represents the properties of a local secondary index for the table when the backup was created.

Link copied to clipboard
Link copied to clipboard

Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

Link copied to clipboard

Overrides the on-demand throughput settings for this replica table. If you don't specify a value for this parameter, it uses the source table's on-demand throughput settings.

Link copied to clipboard

Represents a PartiQL statement that uses parameters.

Link copied to clipboard

The description of the point in time settings applied to the table.

Link copied to clipboard

Represents the settings used to enable point in time recovery.

Link copied to clipboard
Link copied to clipboard

Point in time recovery has not yet been enabled for this source table.

Link copied to clipboard

The operation tried to access a nonexistent resource-based policy.

Link copied to clipboard

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.

Link copied to clipboard
sealed class ProjectionType
Link copied to clipboard

Represents the provisioned throughput settings for the specified global secondary index. You must use ProvisionedThroughput or OnDemandThroughput based on your table’s capacity mode.

Link copied to clipboard

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

Link copied to clipboard

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

Link copied to clipboard

Replica-specific provisioned throughput settings. If not specified, uses the source table's provisioned throughput settings.

Link copied to clipboard
class Put

Represents a request to perform a PutItem operation.

Link copied to clipboard

Represents the input of a PutItem operation.

Link copied to clipboard

Represents the output of a PutItem operation.

Link copied to clipboard

Represents a request to perform a PutItem operation on an item.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Represents the input of a Query operation.

Link copied to clipboard

Represents the output of a Query operation.

Link copied to clipboard
class Replica

Represents the properties of a replica.

Link copied to clipboard

The specified replica is already part of the global table.

Link copied to clipboard

Represents the auto scaling settings of the replica.

Link copied to clipboard

Represents the auto scaling settings of a replica that will be modified.

Link copied to clipboard

Contains the details of the replica.

Link copied to clipboard

Represents the properties of a replica global secondary index.

Represents the auto scaling configuration for a replica global secondary index.

Represents the auto scaling settings of a global secondary index for a replica that will be modified.

Link copied to clipboard

Represents the properties of a replica global secondary index.

Represents the properties of a global secondary index.

Represents the settings of a global secondary index for a global table that will be modified.

Link copied to clipboard

The specified replica is no longer part of the global table.

Link copied to clipboard

Represents the properties of a replica.

Link copied to clipboard

Represents the settings for a global table in a Region that will be modified.

Link copied to clipboard
sealed class ReplicaStatus
Link copied to clipboard

The request was rejected because one or more items in the request are being modified by a request in another Region.

Link copied to clipboard

Represents one of the following:

Link copied to clipboard

Represents one of the following:

Link copied to clipboard

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web ServicesSupport to request a quota increase.

Link copied to clipboard

The operation conflicts with the resource's availability. For example:

Link copied to clipboard

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

Link copied to clipboard

Contains details for the restore.

Link copied to clipboard

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

Link copied to clipboard
Link copied to clipboard
sealed class ReturnValue
Link copied to clipboard

The S3 bucket that is being imported from.

Link copied to clipboard
sealed class S3SseAlgorithm
Link copied to clipboard
sealed class ScalarAttributeType
Link copied to clipboard

Represents the input of a Scan operation.

Link copied to clipboard

Represents the output of a Scan operation.

Link copied to clipboard
sealed class Select
Link copied to clipboard

Contains the details of the table when the backup was created.

Link copied to clipboard

Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.

Link copied to clipboard

The description of the server-side encryption status on the specified table.

Link copied to clipboard

Represents the settings used to enable server-side encryption.

Link copied to clipboard
sealed class SseStatus
Link copied to clipboard
sealed class SseType
Link copied to clipboard

Represents the DynamoDB Streams configuration for a table in DynamoDB.

Link copied to clipboard
sealed class StreamViewType
Link copied to clipboard

A target table with the specified name already exists.

Link copied to clipboard

Represents the auto scaling configuration for a global table.

Link copied to clipboard
sealed class TableClass
Link copied to clipboard

Contains details of the table class.

Link copied to clipboard

The parameters for the table created as part of the import operation.

Link copied to clipboard

Represents the properties of a table.

Link copied to clipboard

A target table with the specified name is either being created or deleted.

Link copied to clipboard

A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

Link copied to clipboard
sealed class TableStatus
Link copied to clipboard

Represents the warm throughput value (in read units per second and write units per second) of the table. Warm throughput is applicable for DynamoDB Standard-IA tables and specifies the minimum provisioned capacity maintained for immediate data access.

Link copied to clipboard
class Tag

Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The description of the Time to Live (TTL) status on the specified table.

Link copied to clipboard

Represents the settings used to enable or disable Time to Live (TTL) for the specified table.

Link copied to clipboard
sealed class TimeToLiveStatus
Link copied to clipboard

Specifies an item to be retrieved as part of the transaction.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The entire transaction request was canceled.

Link copied to clipboard

Operation was rejected because there is an ongoing transaction for the item.

Link copied to clipboard

The transaction with the given request token is already in progress.

Link copied to clipboard

A list of requests that can perform update, put, delete, or check operations on multiple items in one or more tables atomically.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Update

Represents a request to perform an UpdateItem operation.

Link copied to clipboard

Represents the new provisioned throughput settings to be applied to a global secondary index.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Represents the input of an UpdateItem operation.

Link copied to clipboard

Represents the output of an UpdateItem operation.

Link copied to clipboard

Enables updating the configuration for Kinesis Streaming.

Link copied to clipboard

Represents a replica to be modified.

Link copied to clipboard

Represents the input of an UpdateTable operation.

Link copied to clipboard

Represents the output of an UpdateTable operation.

Link copied to clipboard

Represents the input of an UpdateTimeToLive operation.

Link copied to clipboard
Link copied to clipboard

Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the UpdateTable operation to meet the throughput requirements of an upcoming peak event.

Link copied to clipboard
sealed class WitnessStatus
Link copied to clipboard

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.