Module aws_sdk_dynamodb::types
source · Expand description
Data structures used by operation inputs/outputs.
Modules§
- Builders
- Error types that Amazon DynamoDB can respond with.
Structs§
Contains details of a table archival operation.
Represents an attribute for describing the schema for the table and indexes.
For the
UpdateItem
operation, represents the attributes to be modified, the action to perform on each, and the new value for each.You cannot use
UpdateItem
to update any primary key attributes. Instead, you will need to delete the item, and then usePutItem
to create a new item with new attributes.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.Represents the properties of the scaling policy.
Represents the auto scaling policy to be modified.
Represents the auto scaling settings for a global table or global secondary index.
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.
Contains the description of the backup created for the table.
Contains the details of the backup created for the table.
Contains details for the backup.
An error associated with a statement in a PartiQL batch that was run.
A PartiQL batch statement request.
A PartiQL batch statement response..
Contains the details for the read/write capacity mode. This page talks about
PROVISIONED
andPAY_PER_REQUEST
billing modes. For more information about these modes, see Read/write capacity mode.You may need to switch to on-demand mode at least once in order to return a
BillingModeSummary
response.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.Represents the amount of provisioned throughput capacity consumed on a table or an index.
Represents the selection criteria for a
Query
orScan
operation:-
For a
Query
operation,Condition
is used for specifying theKeyConditions
to use when querying a table or an index. ForKeyConditions
, only the following comparison operators are supported:EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
Condition
is also used in aQueryFilter
, which evaluates the query results and returns only the desired values. -
For a
Scan
operation,Condition
is used in aScanFilter
, which evaluates the scan results and returns only the desired values.
-
Represents a request to perform a check that an item exists or to check the condition of specific attributes of the item.
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.Represents the continuous backups and point in time recovery settings on the table.
Represents a Contributor Insights summary entry.
Represents a new global secondary index to be added to an existing table.
Represents a replica to be added.
Represents a replica to be created.
Processing options for the CSV file being imported.
Represents a request to perform a
DeleteItem
operation.Represents a global secondary index to be deleted from an existing table.
Represents a replica to be removed.
Represents a replica to be deleted.
Represents a request to perform a
DeleteItem
operation on an item.Enables setting the configuration for Kinesis Streaming.
An endpoint information details.
Represents a condition to be compared with an attribute value. This condition can be used with
DeleteItem
,PutItem
, orUpdateItem
operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can useExpectedAttributeValue
in one of two different ways:-
Use
AttributeValueList
to specify one or more values to compare against an attribute. UseComparisonOperator
to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds. -
Use
Value
to specify a value that DynamoDB will compare against an attribute. If the values match, thenExpectedAttributeValue
evaluates to true and the conditional operation succeeds. Optionally, you can also setExists
to false, indicating that you do not expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false.
Value
andExists
are incompatible withAttributeValueList
andComparisonOperator
. Note that if you use both sets of parameters at once, DynamoDB will return aValidationException
exception.-
Represents the properties of the exported table.
Summary information about an export task.
Represents a failure a contributor insights operation.
Specifies an item and related attribute values to retrieve in a
TransactGetItem
object.Represents the properties of a global secondary index.
Represents the auto scaling settings of a global secondary index for a global table that will be modified.
Represents the properties of a global secondary index.
Represents the properties of a global secondary index for the table when the backup was created.
Represents one of the following:
-
A new global secondary index to be added to an existing table.
-
New provisioned throughput parameters for an existing global secondary index.
-
An existing global secondary index to be removed from an existing table.
-
The description of the warm throughput value on a global secondary index.
Represents the properties of a global table.
Contains details about the global table.
Represents the settings of a global secondary index for a global table that will be modified.
Summary information about the source file for the import.
Represents the properties of the table being imported into.
Optional object containing the parameters specific to an incremental export.
The format options for the data that was imported into the target table. There is one value, CsvOption.
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.Details for the requested item.
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.
A
KeySchemaElement
represents exactly one attribute of the primary key. For example, a simple primary key would be represented by oneKeySchemaElement
(for the partition key). A composite primary key would require oneKeySchemaElement
for the partition key, and anotherKeySchemaElement
for the sort key.A
KeySchemaElement
must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.Represents a set of primary keys and, for each key, the attributes to retrieve from the table.
For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key. For a composite primary key, you must provide both the partition key and the sort key.
Describes a Kinesis data stream destination.
Represents the properties of a local secondary index.
Represents the properties of a local secondary index.
Represents the properties of a local secondary index for the table when the backup was created.
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.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.
Represents a PartiQL statement that uses parameters.
The description of the point in time settings applied to the table.
Represents the settings used to enable point in time recovery.
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.
Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the
UpdateTable
operation.For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
Replica-specific provisioned throughput settings. If not specified, uses the source table's provisioned throughput settings.
Represents a request to perform a
PutItem
operation.Represents a request to perform a
PutItem
operation on an item.Represents the properties of a replica.
Represents the auto scaling settings of the replica.
Represents the auto scaling settings of a replica that will be modified.
Contains the details of the replica.
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.
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.
Represents the properties of a replica.
Represents the settings for a global table in a Region that will be modified.
Represents one of the following:
-
A new replica to be added to an existing global table.
-
New parameters for an existing replica.
-
An existing replica to be removed from an existing global table.
-
Represents one of the following:
-
A new replica to be added to an existing regional table or global table. This request invokes the
CreateTableReplica
action in the destination Region. -
New parameters for an existing replica. This request invokes the
UpdateTable
action in the destination Region. -
An existing replica to be deleted. The request invokes the
DeleteTableReplica
action in the destination Region, deleting the replica and all if its items in the destination Region.
When you manually remove a table or global table replica, you do not automatically remove any associated scalable targets, scaling policies, or CloudWatch alarms.
-
Contains details for the restore.
The S3 bucket that is being imported from.
Contains the details of the table when the backup was created.
Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.
The description of the server-side encryption status on the specified table.
Represents the settings used to enable server-side encryption.
Represents the DynamoDB Streams configuration for a table in DynamoDB.
Represents the auto scaling configuration for a global table.
Contains details of the table class.
The parameters for the table created as part of the import operation.
Represents the properties of a table.
Represents the warm throughput value (in read units per second and write units per second) of the base table.
Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table.
Amazon Web Services-assigned tag names and values are automatically assigned the
aws:
prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefixuser:
in the Cost Allocation Report. You cannot backdate the application of a tag.For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
The description of the Time to Live (TTL) status on the specified table.
Represents the settings used to enable or disable Time to Live (TTL) for the specified table.
Specifies an item to be retrieved as part of the transaction.
A list of requests that can perform update, put, delete, or check operations on multiple items in one or more tables atomically.
Represents a request to perform an
UpdateItem
operation.Represents the new provisioned throughput settings to be applied to a global secondary index.
Enables updating the configuration for Kinesis Streaming.
Represents a replica to be modified.
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.Represents an operation to perform - either
DeleteItem
orPutItem
. You can only request one of these operations, not both, in a singleWriteRequest
. If you do need to perform both of these operations, you need to provide two separateWriteRequest
objects.
Enums§
- When writing a match expression against
ApproximateCreationDateTimePrecision
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
AttributeAction
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. Represents the data for an attribute.
Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.
For more information, see Data Types in the Amazon DynamoDB Developer Guide.
- When writing a match expression against
BackupStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
BackupType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
BackupTypeFilter
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
BatchStatementErrorCodeEnum
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
BillingMode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ComparisonOperator
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ConditionalOperator
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ContinuousBackupsStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ContributorInsightsAction
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ContributorInsightsStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
DestinationStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ExportFormat
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ExportStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ExportType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ExportViewType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
GlobalTableStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ImportStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
IndexStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
InputCompressionType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
InputFormat
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
KeyType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
MultiRegionConsistency
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
PointInTimeRecoveryStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ProjectionType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ReplicaStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ReturnConsumedCapacity
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ReturnItemCollectionMetrics
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ReturnValue
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ReturnValuesOnConditionCheckFailure
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
S3SseAlgorithm
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ScalarAttributeType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
Select
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
SseStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
SseType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
StreamViewType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
TableClass
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
TableStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
TimeToLiveStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.