Date archivalDateTime
The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.
String archivalReason
The reason DynamoDB archived the table. Currently, the only possible value is:
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the table's AWS KMS key being
inaccessible for more than seven days. An On-Demand backup was created at the archival time.
String archivalBackupArn
The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. If you wish to restore this backup to the same table name, you will need to delete the original table.
String s
An attribute of type String. For example:
"S": "Hello"
String n
An attribute of type Number. For example:
"N": "123.45"
Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
ByteBuffer b
An attribute of type Binary. For example:
"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
List<E> sS
An attribute of type String Set. For example:
"SS": ["Giraffe", "Hippo" ,"Zebra"]
List<E> nS
An attribute of type Number Set. For example:
"NS": ["42.2", "-19", "7.5", "3.14"]
Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
List<E> bS
An attribute of type Binary Set. For example:
"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]
Map<K,V> m
An attribute of type Map. For example:
"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}
List<E> l
An attribute of type List. For example:
"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]
Boolean nULLValue
An attribute of type Null. For example:
"NULL": true
Boolean bOOL
An attribute of type Boolean. For example:
"BOOL": true
AttributeValue value
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.
String action
Specifies how to perform the update. Valid values are PUT (default), DELETE, and
ADD. The behavior depends on whether the specified primary key already exists in the table.
If an item with the specified Key is found in the table:
PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by
the new value.
DELETE - If no value is specified, the attribute and its value are removed from the item. The data
type of the specified value must match the existing value's data type.
If a set of values is specified, then those values are subtracted from the old set. For example, if the
attribute value was the set [a,b,c] and the DELETE action specified [a,c],
then the final attribute value would be [b]. Specifying an empty set is an error.
ADD - If the attribute does not already exist, then the attribute and its values are added to the
item. If the attribute does exist, then the behavior of ADD depends on the data type of the
attribute:
If the existing attribute is a number, and if Value is also a number, then the Value is
mathematically added to the existing attribute. If Value is a negative number, then it is subtracted
from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the
update, DynamoDB uses 0 as the initial value.
In addition, if you use ADD to update an existing item, and intend to increment or decrement an
attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose
that the item you want to update does not yet have an attribute named itemcount, but you decide to
ADD the number 3 to this attribute anyway, even though it currently does not exist.
DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add
3 to it. The result will be a new itemcount attribute in the item, with a value of
3.
If the existing data type is a set, and if the Value is also a set, then the Value is
added to the existing set. (This is a set operation, not mathematical addition.) For example, if the
attribute value was the set [1,2], and the ADD action specified [3], then
the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set
attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the
Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a set. Do not use
ADD for any other data types.
If no item with the specified Key is found:
PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.
DELETE - Nothing happens; there is no attribute to delete.
ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the
attribute value. The only data types allowed are number and number set; no other data types can be specified.
String policyName
The name of the scaling policy.
AutoScalingTargetTrackingScalingPolicyConfigurationDescription targetTrackingScalingPolicyConfiguration
Represents a target tracking scaling policy configuration.
String policyName
The name of the scaling policy.
AutoScalingTargetTrackingScalingPolicyConfigurationUpdate targetTrackingScalingPolicyConfiguration
Represents a target tracking scaling policy configuration.
Long minimumUnits
The minimum capacity units that a global table or global secondary index should be scaled down to.
Long maximumUnits
The maximum capacity units that a global table or global secondary index should be scaled up to.
Boolean autoScalingDisabled
Disabled auto scaling for this global table or global secondary index.
String autoScalingRoleArn
Role ARN used for configuring the auto scaling policy.
List<E> scalingPolicies
Information about the scaling policies.
Long minimumUnits
The minimum capacity units that a global table or global secondary index should be scaled down to.
Long maximumUnits
The maximum capacity units that a global table or global secondary index should be scaled up to.
Boolean autoScalingDisabled
Disabled auto scaling for this global table or global secondary index.
String autoScalingRoleArn
Role ARN used for configuring auto scaling policy.
AutoScalingPolicyUpdate scalingPolicyUpdate
The scaling policy to apply for scaling target global table or global secondary index capacity units.
Boolean disableScaleIn
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
Integer scaleInCooldown
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
Integer scaleOutCooldown
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
Double targetValue
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
Boolean disableScaleIn
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
Integer scaleInCooldown
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
Integer scaleOutCooldown
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
Double targetValue
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
BackupDetails backupDetails
Contains the details of the backup created for the table.
SourceTableDetails sourceTableDetails
Contains the details of the table when the backup was created.
SourceTableFeatureDetails sourceTableFeatureDetails
Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.
String backupArn
ARN associated with the backup.
String backupName
Name of the requested backup.
Long backupSizeBytes
Size of the backup in bytes.
String backupStatus
Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
String backupType
BackupType:
USER - You create and manage these using the on-demand backup feature.
SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is
automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore
the deleted table to the state it was in just before the point of deletion.
AWS_BACKUP - On-demand backup created by you from AWS Backup service.
Date backupCreationDateTime
Time at which the backup was created. This is the request time of the backup.
Date backupExpiryDateTime
Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand
backup expires automatically 35 days after its creation.
String tableName
Name of the table.
String tableId
Unique identifier for the table.
String tableArn
ARN associated with the table.
String backupArn
ARN associated with the backup.
String backupName
Name of the specified backup.
Date backupCreationDateTime
Time at which the backup was created.
Date backupExpiryDateTime
Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand
backup expires automatically 35 days after its creation.
String backupStatus
Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
String backupType
BackupType:
USER - You create and manage these using the on-demand backup feature.
SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is
automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore
the deleted table to the state it was in just before the point of deletion.
AWS_BACKUP - On-demand backup created by you from AWS Backup service.
Long backupSizeBytes
Size of the backup in bytes.
Map<K,V> requestItems
A map of one or more table names and, for each table, a map that describes one or more items to retrieve from
that table. Each table name can be used only once per BatchGetItem request.
Each element in the map of items to retrieve consists of the following:
ConsistentRead - If true, a strongly consistent read is used; if false
(the default), an eventually consistent read is used.
ExpressionAttributeNames - One or more substitution tokens for attribute names in the
ProjectionExpression parameter. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Keys - An array of primary key attribute values that define specific items in 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 value. For a composite key, you must provide both the partition key
value and the sort key value.
ProjectionExpression - A string that identifies one or more attributes to retrieve from the table.
These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must
be separated by commas.
If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For
more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
String returnConsumedCapacity
Map<K,V> responses
A map of table name to a list of items. Each object in Responses consists of a table name, along
with a map of attribute data consisting of the data type and attribute value.
Map<K,V> unprocessedKeys
A map of tables and their respective keys that were not processed with the current response. The
UnprocessedKeys value is in the same form as RequestItems, so the value can be provided
directly to a subsequent BatchGetItem operation. For more information, see RequestItems
in the Request Parameters section.
Each element consists of:
Keys - An array of primary key attribute values that define specific items in the table.
ProjectionExpression - One or more attributes to be retrieved from the table or index. By default,
all attributes are returned. If a requested attribute is not found, it does not appear in the result.
ConsistentRead - The consistency of a read operation. If set to true, then a strongly
consistent read is used; otherwise, an eventually consistent read is used.
If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
List<E> consumedCapacity
The read capacity units consumed by the entire BatchGetItem operation.
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
BatchStatementError error
The error associated with a failed PartiQL batch statement.
String tableName
The table name associated with a failed PartiQL batch statement.
Map<K,V> item
A DynamoDB item associated with a BatchStatementResponse
Map<K,V> requestItems
A map of one or more table names and, for each table, a list of operations to be performed (
DeleteRequest or PutRequest). Each element in the map consists of the following:
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be
deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map
consists of an attribute name and an attribute value. For each primary key, you must provide all of the
key attributes. For example, with a simple primary key, you only need to provide a value for the partition key.
For a composite primary key, you must provide values for both the partition key and the sort key.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is
identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name
and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths
greater than zero; and set type attributes must not be empty. Requests that contain empty values are rejected
with a ValidationException exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
String returnConsumedCapacity
String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to SIZE, the response includes
statistics about item collections, if any, that were modified during the operation are returned in the response.
If set to NONE (the default), no statistics are returned.
Map<K,V> unprocessedItems
A map of tables and requests against those tables that were not processed. The UnprocessedItems
value is in the same form as RequestItems, so you can provide this value directly to a subsequent
BatchGetItem operation. For more information, see RequestItems in the Request
Parameters section.
Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to
perform (DeleteRequest or PutRequest).
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be
deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map
consists of an attribute name and an attribute value.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is
identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name
and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths
greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected
with a ValidationException exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.
Map<K,V> itemCollectionMetrics
A list of tables that were processed by BatchWriteItem and, for each table, information about any
item collections that were affected by individual DeleteItem or PutItem operations.
Each entry consists of the following subelements:
ItemCollectionKey - The partition key value of the item collection. This is the same as the
partition key value of the item.
SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This is a two-element
array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the
items in the table, plus the size of all attributes projected into all of the local secondary indexes on the
table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
List<E> consumedCapacity
The capacity units consumed by the entire BatchWriteItem operation.
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
String billingMode
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using
PROVISIONED for predictable workloads.
PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend
using PAY_PER_REQUEST for unpredictable workloads.
Date lastUpdateToPayPerRequestDateTime
Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.
Double readCapacityUnits
The total number of read capacity units consumed on a table or an index.
Double writeCapacityUnits
The total number of write capacity units consumed on a table or an index.
Double capacityUnits
The total number of capacity units consumed on a table or an index.
List<E> attributeValueList
One or more values to evaluate against the supplied attribute. The number of values in the list depends on the
ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For
example, a is greater than A, and a is greater than B. For a
list of code values, see http://en.wikipedia
.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
String comparisonOperator
A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all data types, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number,
Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
NE : Not equal. NE is supported for all data types, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary,
String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type
than the one provided in the request, the value does not match. For example, {"S":"6"} does not
equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an AttributeValue element of a different type than
the one provided in the request, the value does not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an AttributeValue element of a different type than
the one provided in the request, the value does not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an AttributeValue element of a different type than
the one provided in the request, the value does not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including
lists and maps.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute "
a" is null, and you evaluate it using NOT_NULL, the result is a Boolean
true. This result is because the attribute "a" exists; its data type is not relevant to
the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all data types, including
lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "
a" is null, and you evaluate it using NULL, the result is a Boolean false.
This is because the attribute "a" exists; its data type is not relevant to the NULL
comparison operator.
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a
subsequence of the target that matches the input. If the target attribute of the comparison is a set ("
SS", "NS", or "BS"), then the operator evaluates to true if it finds an
exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a
" can be a list; however, "b" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for
the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks
for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison
is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it
does not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a
" can be a list; however, "b" cannot be a set, a map, or a list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a
Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a
set type).
IN : Checks for matching elements in a list.
AttributeValueList can contain one or more AttributeValue elements of type String,
Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the
input are equal to the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either
String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or
equal to, the first element and less than, or equal to, the second element. If an item contains an
AttributeValue element of a different type than the one provided in the request, the value does not
match. For example, {"S":"6"} does not compare to {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy
Conditional Parameters in the Amazon DynamoDB Developer Guide.
Map<K,V> key
The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.
String tableName
Name of the table for the check item request.
String conditionExpression
A condition that must be satisfied in order for a conditional update to succeed.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
String returnValuesOnConditionCheckFailure
Use ReturnValuesOnConditionCheckFailure to get the item attributes if the
ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid
values are: NONE and ALL_OLD.
String tableName
The name of the table that was affected by the operation.
Double capacityUnits
The total number of capacity units consumed by the operation.
Double readCapacityUnits
The total number of read capacity units consumed by the operation.
Double writeCapacityUnits
The total number of write capacity units consumed by the operation.
Capacity table
The amount of throughput consumed on the table affected by the operation.
Map<K,V> localSecondaryIndexes
The amount of throughput consumed on each local index affected by the operation.
Map<K,V> globalSecondaryIndexes
The amount of throughput consumed on each global index affected by the operation.
String continuousBackupsStatus
ContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED
PointInTimeRecoveryDescription pointInTimeRecoveryDescription
The description of the point in time recovery settings applied to the table.
String tableName
Name of the table associated with the summary.
String indexName
Name of the index associated with the summary, if any.
String contributorInsightsStatus
Describes the current status for contributor insights for the given table and index, if applicable.
BackupDetails backupDetails
Contains the details of the backup created for the table.
String indexName
The name of the global secondary index to be created.
List<E> keySchema
The key schema for the global secondary index.
Projection 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 provisionedThroughput
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
GlobalTableDescription globalTableDescription
Contains the details of the global table.
String regionName
The Region of the replica to be added.
String regionName
The Region where the new replica will be created.
String kMSMasterKeyId
The AWS KMS customer master key (CMK) that should be used for AWS KMS encryption in the new replica. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS master key alias/aws/dynamodb.
ProvisionedThroughputOverride provisionedThroughputOverride
Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.
List<E> globalSecondaryIndexes
Replica-specific global secondary index settings.
List<E> attributeDefinitions
An array of attributes that describe the key schema for the table and indexes.
String tableName
The name of the table to create.
List<E> keySchema
Specifies the attributes that make up the primary key for a table or an index. The attributes in
KeySchema must also be defined in the AttributeDefinitions array. For more information,
see Data Model in
the Amazon DynamoDB Developer Guide.
Each KeySchemaElement in the array is composed of:
AttributeName - The name of this key attribute.
KeyType - The role that the key attribute will assume:
HASH - partition key
RANGE - sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For a simple primary key (partition key), you must provide exactly one element with a KeyType of
HASH.
For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order:
The first element must have a KeyType of HASH, and the second element must have a
KeyType of RANGE.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
List<E> localSecondaryIndexes
One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.
Each local secondary index in the array includes the following:
IndexName - The name of the local secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with
the same partition key as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes.
ALL - All of the table attributes are projected into the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of
the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
List<E> globalSecondaryIndexes
One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:
IndexName - The name of the global secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the global secondary index.
Projection - Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes.
ALL - All of the table attributes are projected into the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of
the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units.
String billingMode
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED - We recommend using PROVISIONED for predictable workloads.
PROVISIONED sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads.
PAY_PER_REQUEST sets the billing mode to On-Demand Mode.
ProvisionedThroughput provisionedThroughput
Represents the provisioned throughput settings for a specified table or index. The settings can be modified using
the UpdateTable operation.
If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as
PAY_PER_REQUEST, you cannot specify this property.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
StreamSpecification streamSpecification
The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).
StreamViewType - When an item in the table is modified, StreamViewType determines what
information is written to the table's stream. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
SSESpecification sSESpecification
Represents the settings used to enable server-side encryption.
List<E> tags
A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.
TableDescription tableDescription
Represents the properties of the table.
Map<K,V> key
The primary key of the item to be deleted. Each element consists of an attribute name and a value for that attribute.
String tableName
Name of the table in which the item to be deleted resides.
String conditionExpression
A condition that must be satisfied in order for a conditional delete to succeed.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
String returnValuesOnConditionCheckFailure
Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete
condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
String backupArn
The ARN associated with the backup.
BackupDescription backupDescription
Contains the description of the backup created for the table.
String indexName
The name of the global secondary index to be deleted.
String tableName
The name of the table from which to delete the item.
Map<K,V> key
A map of attribute names to AttributeValue objects, representing the primary key of the item to
delete.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
Map<K,V> expected
This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
String conditionalOperator
This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
String returnValues
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
For DeleteItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE, then
nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem
does not recognize any values other than NONE or ALL_OLD.
String returnConsumedCapacity
String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to SIZE, the response includes
statistics about item collections, if any, that were modified during the operation are returned in the response.
If set to NONE (the default), no statistics are returned.
String conditionExpression
A condition that must be satisfied in order for a conditional DeleteItem to succeed.
An expression can contain any of the following:
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
Map<K,V> attributes
A map of attribute names to AttributeValue objects, representing the item as it appeared before the
DeleteItem operation. This map appears in the response only if ReturnValues was
specified as ALL_OLD in the request.
ConsumedCapacity consumedCapacity
The capacity units consumed by the DeleteItem 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 ReturnConsumedCapacity parameter was
specified. For more information, see Provisioned Mode in the Amazon DynamoDB Developer Guide.
ItemCollectionMetrics itemCollectionMetrics
Information about item collections, if any, that were affected by the DeleteItem operation.
ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was
specified. If the table does not have any local secondary indexes, this information is not returned in the
response.
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The partition key value of the item collection. This is the same as the
partition key value of the item itself.
SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element
array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the
items in the table, plus the size of all attributes projected into all of the local secondary indexes on that
table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
String regionName
The Region of the replica to be removed.
String regionName
The Region where the replica exists.
String tableName
The name of the table to delete.
TableDescription tableDescription
Represents the properties of a table.
String backupArn
The Amazon Resource Name (ARN) associated with the backup.
BackupDescription backupDescription
Contains the description of the backup created for the table.
String tableName
Name of the table for which the customer wants to check the continuous backups and point in time recovery settings.
ContinuousBackupsDescription continuousBackupsDescription
Represents the continuous backups and point in time recovery settings on the table.
String tableName
The name of the table being described.
String indexName
The name of the global secondary index being described.
List<E> contributorInsightsRuleList
List of names of the associated Alpine rules.
String contributorInsightsStatus
Current Status contributor insights.
Date lastUpdateDateTime
Timestamp of the last time the status was changed.
FailureException failureException
Returns information about the last failure that encountered.
The most common exceptions for a FAILED status are:
LimitExceededException - Per-account Amazon CloudWatch Contributor Insights rule limit reached. Please disable Contributor Insights for other tables/indexes OR disable Contributor Insights rules before retrying.
AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient permissions.
AccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient permissions.
InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.
String exportArn
The Amazon Resource Name (ARN) associated with the export.
ExportDescription exportDescription
Represents the properties of the export.
String globalTableName
The name of the global table.
GlobalTableDescription globalTableDescription
Contains the details of the global table.
String globalTableName
The name of the global table to describe.
String tableName
The name of the table being described.
Long accountMaxReadCapacityUnits
The maximum total read capacity units that your account allows you to provision across all of your tables in this Region.
Long accountMaxWriteCapacityUnits
The maximum total write capacity units that your account allows you to provision across all of your tables in this Region.
Long tableMaxReadCapacityUnits
The maximum read capacity units that your account allows you to provision for a new table that you are creating in this Region, including the read capacity units provisioned for its global secondary indexes (GSIs).
Long tableMaxWriteCapacityUnits
The maximum write capacity units that your account allows you to provision for a new table that you are creating in this Region, including the write capacity units provisioned for its global secondary indexes (GSIs).
String streamArn
The Amazon Resource Name (ARN) for the stream.
Integer limit
The maximum number of shard objects to return. The upper limit is 100.
String exclusiveStartShardId
The shard ID of the first item that this operation will evaluate. Use the value that was returned for
LastEvaluatedShardId in the previous operation.
StreamDescription streamDescription
A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards.
String tableName
The name of the table.
TableAutoScalingDescription tableAutoScalingDescription
Represents the auto scaling properties of the table.
String tableName
The name of the table to describe.
TableDescription table
The properties of the table.
String tableName
The name of the table to be described.
TimeToLiveDescription timeToLiveDescription
String statement
The PartiQL statement representing the operation to run.
List<E> parameters
The parameters for the PartiQL statement, if any.
Boolean consistentRead
The consistency of a read operation. If set to true, then a strongly consistent read is used;
otherwise, an eventually consistent read is used.
String nextToken
Set this value to get remaining results, if NextToken was returned in the statement response.
List<E> items
If a read operation was used, this property will contain the result of the reade operation; a map of attribute names and their values. For the write operations this value will be empty.
String nextToken
If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.
AttributeValue value
Represents the data for the expected 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.
Boolean exists
Causes DynamoDB to evaluate the value before attempting a conditional operation:
If Exists is true, DynamoDB will check to see if that attribute value already exists in
the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a
ConditionCheckFailedException.
If Exists is false, DynamoDB assumes that the attribute value does not exist in the
table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value
is found, despite the assumption that it does not exist, the operation fails with a
ConditionCheckFailedException.
The default setting for Exists is true. If you supply a Value all by
itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true,
because it is implied.
DynamoDB returns a ValidationException if:
Exists is true but there is no Value to check. (You expect a value to
exist, but don't specify what that value is.)
Exists is false but you also provide a Value. (You cannot expect an
attribute to have a value, while also expecting it not to exist.)
String comparisonOperator
A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than,
less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all data types, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number,
Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
NE : Not equal. NE is supported for all data types, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary,
String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type
than the one provided in the request, the value does not match. For example, {"S":"6"} does not
equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an AttributeValue element of a different type than
the one provided in the request, the value does not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an AttributeValue element of a different type than
the one provided in the request, the value does not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an AttributeValue element of a different type than
the one provided in the request, the value does not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including
lists and maps.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute "
a" is null, and you evaluate it using NOT_NULL, the result is a Boolean
true. This result is because the attribute "a" exists; its data type is not relevant to
the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all data types, including
lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "
a" is null, and you evaluate it using NULL, the result is a Boolean false.
This is because the attribute "a" exists; its data type is not relevant to the NULL
comparison operator.
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a
subsequence of the target that matches the input. If the target attribute of the comparison is a set ("
SS", "NS", or "BS"), then the operator evaluates to true if it finds an
exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a
" can be a list; however, "b" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for
the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks
for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison
is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it
does not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a
" can be a list; however, "b" cannot be a set, a map, or a list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a
Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a
set type).
IN : Checks for matching elements in a list.
AttributeValueList can contain one or more AttributeValue elements of type String,
Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the
input are equal to the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either
String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or
equal to, the first element and less than, or equal to, the second element. If an item contains an
AttributeValue element of a different type than the one provided in the request, the value does not
match. For example, {"S":"6"} does not compare to {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2", "1"]}
List<E> attributeValueList
One or more values to evaluate against the supplied attribute. The number of values in the list depends on the
ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For
example, a is greater than A, and a is greater than B. For a
list of code values, see http://en.wikipedia
.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
String exportArn
The Amazon Resource Name (ARN) of the table export.
String exportStatus
Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
Date startTime
The time at which the export task began.
Date endTime
The time at which the export task completed.
String exportManifest
The name of the manifest file for the export task.
String tableArn
The Amazon Resource Name (ARN) of the table that was exported.
String tableId
Unique ID of the table that was exported.
Date exportTime
Point in time from which table data was exported.
String clientToken
The client token that was provided for the export task. A client token makes calls to
ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect
as one single call.
String s3Bucket
The name of the Amazon S3 bucket containing the export.
String s3BucketOwner
The ID of the AWS account that owns the bucket containing the export.
String s3Prefix
The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.
String s3SseAlgorithm
Type of encryption used on the bucket where export data is stored. Valid values for S3SseAlgorithm
are:
AES256 - server-side encryption with Amazon S3 managed keys
KMS - server-side encryption with AWS KMS managed keys
String s3SseKmsKeyId
The ID of the AWS KMS managed key used to encrypt the S3 bucket where export data is stored (if applicable).
String failureCode
Status code for the result of the failed export.
String failureMessage
Export failure reason description.
String exportFormat
The format of the exported data. Valid values for ExportFormat are DYNAMODB_JSON or
ION.
Long billedSizeBytes
The billable size of the table export.
Long itemCount
The number of items exported.
String tableArn
The Amazon Resource Name (ARN) associated with the table to export.
Date exportTime
Time in the past from which to export table data. The table export will be a snapshot of the table's state at this point in time.
String clientToken
Providing a ClientToken makes the call to ExportTableToPointInTimeInput idempotent,
meaning that multiple identical calls have the same effect as one single call.
A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.
If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency
window, DynamoDB returns an IdempotentParameterMismatch exception.
String s3Bucket
The name of the Amazon S3 bucket to export the snapshot to.
String s3BucketOwner
The ID of the AWS account that owns the bucket the export will be stored in.
String s3Prefix
The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
String s3SseAlgorithm
Type of encryption used on the bucket where export data will be stored. Valid values for
S3SseAlgorithm are:
AES256 - server-side encryption with Amazon S3 managed keys
KMS - server-side encryption with AWS KMS managed keys
String s3SseKmsKeyId
The ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).
String exportFormat
The format for the exported data. Valid values for ExportFormat are DYNAMODB_JSON or
ION.
ExportDescription exportDescription
Contains a description of the table export.
Map<K,V> key
A map of attribute names to AttributeValue objects that specifies the primary key of the item to
retrieve.
String tableName
The name of the table from which to retrieve the specified item.
String projectionExpression
A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in the ProjectionExpression parameter.
String tableName
The name of the table containing the requested item.
Map<K,V> key
A map of attribute names to AttributeValue objects, representing the primary key of the item to
retrieve.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
List<E> attributesToGet
This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
Boolean consistentRead
Determines the read consistency model: If set to true, then the operation uses strongly consistent
reads; otherwise, the operation uses eventually consistent reads.
String returnConsumedCapacity
String projectionExpression
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result.
For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> item
A map of attribute names to AttributeValue objects, as specified by
ProjectionExpression.
ConsumedCapacity consumedCapacity
The capacity units consumed by the GetItem 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 ReturnConsumedCapacity parameter was
specified. For more information, see Read/Write Capacity Mode in the Amazon DynamoDB Developer Guide.
List<E> records
The stream records from the shard, which were retrieved using the shard iterator.
String nextShardIterator
The next position in the shard from which to start sequentially reading stream records. If set to
null, the shard has been closed and the requested iterator will not return any more data.
String streamArn
The Amazon Resource Name (ARN) for the stream.
String shardId
The identifier of the shard. The iterator will be returned for this shard ID.
String shardIteratorType
Determines how the shard iterator is used to start reading stream records from the shard:
AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.
AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence
number.
TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in
the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this
limit are subject to removal (trimming) from the stream.
LATEST - Start reading just after the most recent stream record in the shard, so that you always
read the most recent data in the shard.
String sequenceNumber
The sequence number of a stream record in the shard from which to start reading.
String shardIterator
The position in the shard from which to start reading stream records sequentially. A shard iterator specifies this position using the sequence number of a stream record in a shard.
String indexName
The name of the global secondary index. The name must be unique among all other indexes on this table.
List<E> keySchema
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
Projection projection
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProvisionedThroughput provisionedThroughput
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
String indexName
The name of the global secondary index.
AutoScalingSettingsUpdate provisionedWriteCapacityAutoScalingUpdate
String indexName
The name of the global secondary index.
List<E> keySchema
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
Projection projection
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
String indexStatus
The current state of the global secondary index:
CREATING - The index is being created.
UPDATING - The index is being updated.
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
Boolean backfilling
Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the
table and determining whether they can be added to the index. (Not all items will qualify: For example, a
partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After
all items have been processed, the backfilling operation is complete and Backfilling is false.
You can delete an index that is being created during the Backfilling phase when
IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that
is being created when IndexStatus is set to CREATING and Backfilling is false.
For indexes that were created during a CreateTable operation, the Backfilling attribute
does not appear in the DescribeTable output.
ProvisionedThroughputDescription provisionedThroughput
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
Long indexSizeBytes
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
Long itemCount
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
String indexArn
The Amazon Resource Name (ARN) that uniquely identifies the index.
String indexName
The name of the global secondary index.
List<E> keySchema
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
Projection projection
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProvisionedThroughput provisionedThroughput
Represents the provisioned throughput settings for the specified global secondary index.
UpdateGlobalSecondaryIndexAction update
The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.
CreateGlobalSecondaryIndexAction create
The parameters required for creating a global secondary index on an existing table:
IndexName
KeySchema
AttributeDefinitions
Projection
ProvisionedThroughput
DeleteGlobalSecondaryIndexAction delete
The name of an existing global secondary index to be removed.
List<E> replicationGroup
The Regions where the global table has replicas.
String globalTableArn
The unique identifier of the global table.
Date creationDateTime
The creation time of the global table.
String globalTableStatus
The current state of the global table:
CREATING - The global table is being created.
UPDATING - The global table is being updated.
DELETING - The global table is being deleted.
ACTIVE - The global table is ready for use.
String globalTableName
The global table name.
String indexName
The name of the global secondary index. The name must be unique among all other indexes on this table.
Long provisionedWriteCapacityUnits
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
AutoScalingSettingsUpdate provisionedWriteCapacityAutoScalingSettingsUpdate
Auto scaling settings for managing a global secondary index's write capacity units.
Map<K,V> itemCollectionKey
The partition key value of the item collection. This value is the same as the partition key value of the item.
List<E> sizeEstimateRangeGB
An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
List<E> keys
The primary key attribute values that define the items and the attributes associated with the items.
List<E> attributesToGet
This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy
Conditional Parameters in the Amazon DynamoDB Developer Guide.
Boolean consistentRead
The consistency of a read operation. If set to true, then a strongly consistent read is used;
otherwise, an eventually consistent read is used.
String projectionExpression
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars,
sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated
by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
String attributeName
The name of a key attribute.
String keyType
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
String tableName
The backups from the table specified by TableName are listed.
Integer limit
Maximum number of backups to return at once.
Date timeRangeLowerBound
Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
Date timeRangeUpperBound
Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
String exclusiveStartBackupArn
LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the
current page of results was returned, inclusive of the current page of results. This value may be specified as
the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next
page of results.
String backupType
The backups from the table specified by BackupType are listed.
Where BackupType can be:
USER - On-demand backup created by you.
SYSTEM - On-demand backup automatically created by DynamoDB.
ALL - All types of on-demand backups (USER and SYSTEM).
List<E> backupSummaries
List of BackupSummary objects.
String lastEvaluatedBackupArn
The ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page
of results. This value may be specified as the ExclusiveStartBackupArn of a new
ListBackups operation in order to fetch the next page of results.
If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are
no more results to be retrieved.
If LastEvaluatedBackupArn is not empty, this may or may not indicate that there is more data to be
returned. All results are guaranteed to have been returned if and only if no value for
LastEvaluatedBackupArn is returned.
String tableArn
The Amazon Resource Name (ARN) associated with the exported table.
Integer maxResults
Maximum number of results to return per page.
String nextToken
An optional string that, if supplied, must be copied from the output of a previous call to
ListExports. When provided in this manner, the API fetches the next page of results.
String exclusiveStartGlobalTableName
The first global table name that this operation will evaluate.
Integer limit
The maximum number of table names to return, if the parameter is not specified DynamoDB defaults to 100.
If the number of global tables DynamoDB finds reaches this limit, it stops the operation and returns the table
names collected up to that point, with a table name in the LastEvaluatedGlobalTableName to apply in
a subsequent operation to the ExclusiveStartGlobalTableName parameter.
String regionName
Lists the global tables in a specific Region.
String tableName
If this parameter is provided, then only the streams associated with this table name are returned.
Integer limit
The maximum number of streams to return. The upper limit is 100.
String exclusiveStartStreamArn
The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was
returned for LastEvaluatedStreamArn in the previous operation.
List<E> streams
A list of stream descriptors associated with the current account and endpoint.
String lastEvaluatedStreamArn
The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedStreamArn is empty, then the "last page" of results has been processed and there is
no more data to be retrieved.
If LastEvaluatedStreamArn is not empty, it does not necessarily mean that there is more data in the
result set. The only way to know when you have reached the end of the result set is when
LastEvaluatedStreamArn is empty.
String exclusiveStartTableName
The first table name that this operation will evaluate. Use the value that was returned for
LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.
Integer limit
A maximum number of table names to return. If this parameter is not specified, the limit is 100.
List<E> tableNames
The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.
If LastEvaluatedTableName also appears in the output, you can use this value as the
ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the
next page of results.
String lastEvaluatedTableName
The name of the last table in the current page of results. Use this value as the
ExclusiveStartTableName in a new request to obtain the next page of results, until all the table
names are returned.
If you do not receive a LastEvaluatedTableName value in the response, this means that there are no
more table names to be retrieved.
String resourceArn
The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).
String nextToken
An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results.
String indexName
The name of the local secondary index. The name must be unique among all other indexes on this table.
List<E> keySchema
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
Projection projection
Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
String indexName
Represents the name of the local secondary index.
List<E> keySchema
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
Projection projection
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
Long indexSizeBytes
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
Long itemCount
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
String indexArn
The Amazon Resource Name (ARN) that uniquely identifies the index.
String indexName
Represents the name of the local secondary index.
List<E> keySchema
The complete key schema for a local secondary index, which consists of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
Projection projection
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
String pointInTimeRecoveryStatus
The current state of point in time recovery:
ENABLING - Point in time recovery is being enabled.
ENABLED - Point in time recovery is enabled.
DISABLED - Point in time recovery is disabled.
Date earliestRestorableDateTime
Specifies the earliest point in time you can restore your table to. You can restore your table to any point in time during the last 35 days.
Date latestRestorableDateTime
LatestRestorableDateTime is typically 5 minutes before the current time.
Boolean pointInTimeRecoveryEnabled
Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
String projectionType
The set of attributes that are projected into the index:
KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index
will include other non-key attributes that you specify.
ALL - All of the table attributes are projected into the index.
List<E> nonKeyAttributes
Represents the non-key attribute names which will be projected into the index.
For local secondary indexes, the total count of NonKeyAttributes summed across all of the local
secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts
as two distinct attributes when determining the total.
Long readCapacityUnits
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
Long writeCapacityUnits
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For
more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
Date lastIncreaseDateTime
The date and time of the last provisioned throughput increase for this table.
Date lastDecreaseDateTime
The date and time of the last provisioned throughput decrease for this table.
Long numberOfDecreasesToday
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
Long readCapacityUnits
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads,
so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent
ReadCapacityUnits per second.
Long writeCapacityUnits
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
Long readCapacityUnits
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
Map<K,V> item
A map of attribute name to attribute values, representing the primary key of the item to be written by
PutItem. All of the table's primary key attributes must be specified, and their data types must
match those of the table's key schema. If any attributes are present in the item that are part of an index key
schema for the table, their types must match the index key schema.
String tableName
Name of the table in which to write the item.
String conditionExpression
A condition that must be satisfied in order for a conditional update to succeed.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
String returnValuesOnConditionCheckFailure
Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition
fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
String tableName
The name of the table to contain the item.
Map<K,V> item
A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
Map<K,V> expected
This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
String returnValues
Use ReturnValues if you want to get the item attributes as they appeared before they were updated
with the PutItem request. For PutItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE, then
nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the
old item is returned.
The ReturnValues parameter is used by several DynamoDB operations; however, PutItem
does not recognize any values other than NONE or ALL_OLD.
String returnConsumedCapacity
String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to SIZE, the response includes
statistics about item collections, if any, that were modified during the operation are returned in the response.
If set to NONE (the default), no statistics are returned.
String conditionalOperator
This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
String conditionExpression
A condition that must be satisfied in order for a conditional PutItem operation to succeed.
An expression can contain any of the following:
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
Map<K,V> attributes
The attribute values as they appeared before the PutItem operation, but only if
ReturnValues is specified as ALL_OLD in the request. Each element consists of an
attribute name and an attribute value.
ConsumedCapacity consumedCapacity
The capacity units consumed by the PutItem 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 ReturnConsumedCapacity parameter was
specified. For more information, see Read/Write Capacity Mode in the Amazon DynamoDB Developer Guide.
ItemCollectionMetrics itemCollectionMetrics
Information about item collections, if any, that were affected by the PutItem operation.
ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was
specified. If the table does not have any local secondary indexes, this information is not returned in the
response.
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The partition key value of the item collection. This is the same as the
partition key value of the item itself.
SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element
array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the
items in the table, plus the size of all attributes projected into all of the local secondary indexes on that
table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
Map<K,V> item
A map of attribute name to attribute values, representing the primary key of an item to be processed by
PutItem. All of the table's primary key attributes must be specified, and their data types must
match those of the table's key schema. If any attributes are present in the item that are part of an index key
schema for the table, their types must match the index key schema.
String tableName
The name of the table containing the requested items.
String indexName
The name of an index to query. This index can be any local secondary index or global secondary index on the
table. Note that if you use the IndexName parameter, you must also provide TableName.
String select
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query
a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the
parent table. If the index is configured to project all item attributes, then all of the data can be obtained
from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have
been projected into the index. If the index is configured to project all attributes, this return value is
equivalent to specifying ALL_ATTRIBUTES.
COUNT - Returns the number of matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This
return value is equivalent to specifying AttributesToGet without specifying any value for
Select.
If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an
index. You cannot use both Select and AttributesToGet together in a single request,
unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to
specifying AttributesToGet without any value for Select.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
List<E> attributesToGet
This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
Integer limit
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the
number of items up to the limit while processing the results, it stops the operation and returns the matching
values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that
you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this
limit, it stops the operation and returns the matching values up to the limit, and a key in
LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information,
see Query and
Scan in the Amazon DynamoDB Developer Guide.
Boolean consistentRead
Determines the read consistency model: If set to true, then the operation uses strongly consistent
reads; otherwise, the operation uses eventually consistent reads.
Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index
with ConsistentRead set to true, you will receive a ValidationException.
Map<K,V> keyConditions
This is a legacy parameter. Use KeyConditionExpression instead. For more information, see KeyConditions in the Amazon DynamoDB Developer Guide.
Map<K,V> queryFilter
This is a legacy parameter. Use FilterExpression instead. For more information, see QueryFilter in the Amazon DynamoDB Developer Guide.
String conditionalOperator
This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
Boolean scanIndexForward
Specifies the order for index traversal: If true (default), the traversal is performed in ascending
order; if false, the traversal is performed in descending order.
Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
If ScanIndexForward is true, DynamoDB returns the results in the order in which they
are stored (by sort key value). This is the default behavior. If ScanIndexForward is
false, DynamoDB reads the results in reverse order by sort key value, and then returns the results
to the client.
Map<K,V> exclusiveStartKey
The primary key of the first item that this operation will evaluate. Use the value that was returned for
LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number, or Binary. No set data types are
allowed.
String returnConsumedCapacity
String projectionExpression
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
String filterExpression
A string that contains conditions that DynamoDB applies after the Query operation, but before the
data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression does not allow key attributes. You cannot define a filter expression based on a
partition key or a sort key.
A FilterExpression is applied after the items have already been read; the process of filtering does
not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
String keyConditionExpression
The condition that specifies the key values for items to be retrieved by the Query action.
The condition must perform an equality test on a single partition key value.
The condition can optionally perform one of several comparison tests on a single sort key value. This allows
Query to retrieve one item with a given partition key value and sort key value, or several items
that have the same partition key value but different sort key values.
The partition key equality test is required, and must be specified in the following format:
partitionKeyName = :partitionkeyval
If you also want to provide a condition for the sort key, it must be combined using AND with the
condition for the sort key. Following is an example, using the = comparison operator for the sort key:
partitionKeyName = :partitionkeyval AND
sortKeyName = :sortkeyval
Valid comparisons for the sort key condition are as follows:
sortKeyName = :sortkeyval - true if the sort key value is equal to
:sortkeyval.
sortKeyName < :sortkeyval - true if the sort key value is less than
:sortkeyval.
sortKeyName <= :sortkeyval - true if the sort key value is less than or
equal to :sortkeyval.
sortKeyName > :sortkeyval - true if the sort key value is greater than
:sortkeyval.
sortKeyName >= :sortkeyval - true if the sort key value is greater
than or equal to :sortkeyval.
sortKeyName BETWEEN :sortkeyval1 AND
:sortkeyval2 - true if the sort key value is greater than or equal to :sortkeyval1, and
less than or equal to :sortkeyval2.
begins_with ( sortKeyName, :sortkeyval ) - true if the sort
key value begins with a particular operand. (You cannot use this function with a sort key that is of type
Number.) Note that the function name begins_with is case-sensitive.
Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval and
:sortval with actual values at runtime.
You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition
key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a
DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error
because Size is a reserved word:
Size = :myval
To work around this, define a placeholder (such a #S) to represent the attribute name Size.
KeyConditionExpression then is as follows:
#S = :myval
For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.
For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using
Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
List<E> items
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
Integer count
The number of items in the response.
If you used a QueryFilter in the request, then Count is the number of items returned
after the filter was applied, and ScannedCount is the number of matching items before the filter was
applied.
If you did not use a filter in the request, then Count and ScannedCount are the same.
Integer scannedCount
The number of items evaluated, before any QueryFilter is applied. A high ScannedCount
value with few, or no, Count results indicates an inefficient Query operation. For more
information, see Count and
ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as Count.
Map<K,V> lastEvaluatedKey
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no
more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result
set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey
is empty.
ConsumedCapacity consumedCapacity
The capacity units consumed by the Query 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 ReturnConsumedCapacity parameter was
specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
String eventID
A globally unique identifier for the event that was recorded in this stream record.
String eventName
The type of data modification that was performed on the DynamoDB table:
INSERT - a new item was added to the table.
MODIFY - one or more of an existing item's attributes were modified.
REMOVE - the item was deleted from the table
String eventVersion
The version number of the stream record format. This number is updated whenever the structure of
Record is modified.
Client applications must not assume that eventVersion will remain at a particular value, as this
number is subject to change at any time. In general, eventVersion will only increase as the
low-level DynamoDB Streams API evolves.
String eventSource
The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.
String awsRegion
The region in which the GetRecords request was received.
StreamRecord dynamodb
The main body of the stream record, containing all of the DynamoDB-specific fields.
Identity userIdentity
Items that are deleted by the Time to Live process after expiration have the following fields:
Records[].userIdentity.type
"Service"
Records[].userIdentity.principalId
"dynamodb.amazonaws.com"
String regionName
The Region where the replica needs to be created.
String regionName
The Region where the replica exists.
List<E> globalSecondaryIndexes
Replica-specific global secondary index auto scaling settings.
AutoScalingSettingsDescription replicaProvisionedReadCapacityAutoScalingSettings
AutoScalingSettingsDescription replicaProvisionedWriteCapacityAutoScalingSettings
String replicaStatus
The current state of the replica:
CREATING - The replica is being created.
UPDATING - The replica is being updated.
DELETING - The replica is being deleted.
ACTIVE - The replica is ready for use.
String regionName
The Region where the replica exists.
List<E> replicaGlobalSecondaryIndexUpdates
Represents the auto scaling settings of global secondary indexes that will be modified.
AutoScalingSettingsUpdate replicaProvisionedReadCapacityAutoScalingUpdate
String regionName
The name of the Region.
String replicaStatus
The current state of the replica:
CREATING - The replica is being created.
UPDATING - The replica is being updated.
DELETING - The replica is being deleted.
ACTIVE - The replica is ready for use.
REGION_DISABLED - The replica is inaccessible because the AWS Region has been disabled.
If the AWS Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table is inaccessible.
If the AWS KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
String replicaStatusDescription
Detailed information about the replica status.
String replicaStatusPercentProgress
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
String kMSMasterKeyId
The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.
ProvisionedThroughputOverride provisionedThroughputOverride
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
List<E> globalSecondaryIndexes
Replica-specific global secondary index settings.
Date replicaInaccessibleDateTime
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the
ReplicaStatus property.
String indexName
The name of the global secondary index.
ProvisionedThroughputOverride provisionedThroughputOverride
Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI's read capacity settings.
String indexName
The name of the global secondary index.
String indexStatus
The current state of the replica global secondary index:
CREATING - The index is being created.
UPDATING - The index is being updated.
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings
AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings
String indexName
The name of the global secondary index.
AutoScalingSettingsUpdate provisionedReadCapacityAutoScalingUpdate
String indexName
The name of the global secondary index.
ProvisionedThroughputOverride provisionedThroughputOverride
If not described, uses the source table GSI's read capacity settings.
String indexName
The name of the global secondary index. The name must be unique among all other indexes on this table.
String indexStatus
The current status of the global secondary index:
CREATING - The global secondary index is being created.
UPDATING - The global secondary index is being updated.
DELETING - The global secondary index is being deleted.
ACTIVE - The global secondary index is ready for use.
Long provisionedReadCapacityUnits
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException.
AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings
Auto scaling settings for a global secondary index replica's read capacity units.
Long provisionedWriteCapacityUnits
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings
Auto scaling settings for a global secondary index replica's write capacity units.
String indexName
The name of the global secondary index. The name must be unique among all other indexes on this table.
Long provisionedReadCapacityUnits
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException.
AutoScalingSettingsUpdate provisionedReadCapacityAutoScalingSettingsUpdate
Auto scaling settings for managing a global secondary index replica's read capacity units.
String regionName
The Region name of the replica.
String replicaStatus
The current state of the Region:
CREATING - The Region is being created.
UPDATING - The Region is being updated.
DELETING - The Region is being deleted.
ACTIVE - The Region is ready for use.
BillingModeSummary replicaBillingModeSummary
The read/write capacity mode of the replica.
Long replicaProvisionedReadCapacityUnits
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
AutoScalingSettingsDescription replicaProvisionedReadCapacityAutoScalingSettings
Auto scaling settings for a global table replica's read capacity units.
Long replicaProvisionedWriteCapacityUnits
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For
more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
AutoScalingSettingsDescription replicaProvisionedWriteCapacityAutoScalingSettings
Auto scaling settings for a global table replica's write capacity units.
List<E> replicaGlobalSecondaryIndexSettings
Replica global secondary index settings for the global table.
String regionName
The Region of the replica to be added.
Long replicaProvisionedReadCapacityUnits
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
AutoScalingSettingsUpdate replicaProvisionedReadCapacityAutoScalingSettingsUpdate
Auto scaling settings for managing a global table replica's read capacity units.
List<E> replicaGlobalSecondaryIndexSettingsUpdate
Represents the settings of a global secondary index for a global table that will be modified.
CreateReplicationGroupMemberAction create
The parameters required for creating a replica for the table.
UpdateReplicationGroupMemberAction update
The parameters required for updating a replica for the table.
DeleteReplicationGroupMemberAction delete
The parameters required for deleting a replica for the table.
CreateReplicaAction create
The parameters required for creating a replica on an existing global table.
DeleteReplicaAction delete
The name of the existing replica to be removed.
String sourceBackupArn
The Amazon Resource Name (ARN) of the backup from which the table was restored.
String sourceTableArn
The ARN of the source table of the backup that is being restored.
Date restoreDateTime
Point in time or source backup time.
Boolean restoreInProgress
Indicates if a restore is in progress or not.
String targetTableName
The name of the new table to which the backup must be restored.
String backupArn
The Amazon Resource Name (ARN) associated with the backup.
String billingModeOverride
The billing mode of the restored table.
List<E> globalSecondaryIndexOverride
List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.
List<E> localSecondaryIndexOverride
List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.
ProvisionedThroughput provisionedThroughputOverride
Provisioned throughput settings for the restored table.
SSESpecification sSESpecificationOverride
The new server-side encryption settings for the restored table.
TableDescription tableDescription
The description of the table created from an existing backup.
String sourceTableArn
The DynamoDB table that will be restored. This value is an Amazon Resource Name (ARN).
String sourceTableName
Name of the source table that is being restored.
String targetTableName
The name of the new table to which it must be restored to.
Boolean useLatestRestorableTime
Restore the table to the latest possible time. LatestRestorableDateTime is typically 5 minutes
before the current time.
Date restoreDateTime
Time in the past to restore the table to.
String billingModeOverride
The billing mode of the restored table.
List<E> globalSecondaryIndexOverride
List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.
List<E> localSecondaryIndexOverride
List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.
ProvisionedThroughput provisionedThroughputOverride
Provisioned throughput settings for the restored table.
SSESpecification sSESpecificationOverride
The new server-side encryption settings for the restored table.
TableDescription tableDescription
Represents the properties of a table.
String tableName
The name of the table containing the requested items; or, if you provide IndexName, the name of the
table to which that index belongs.
String indexName
The name of a secondary index to scan. This index can be any local secondary index or global secondary index.
Note that if you use the IndexName parameter, you must also provide TableName.
List<E> attributesToGet
This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
Integer limit
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the
number of items up to the limit while processing the results, it stops the operation and returns the matching
values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that
you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this
limit, it stops the operation and returns the matching values up to the limit, and a key in
LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information,
see Working with
Queries in the Amazon DynamoDB Developer Guide.
String select
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query
a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the
parent table. If the index is configured to project all item attributes, then all of the data can be obtained
from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have
been projected into the index. If the index is configured to project all attributes, this return value is
equivalent to specifying ALL_ATTRIBUTES.
COUNT - Returns the number of matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This
return value is equivalent to specifying AttributesToGet without specifying any value for
Select.
If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an
index. You cannot use both Select and AttributesToGet together in a single request,
unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to
specifying AttributesToGet without any value for Select.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
Map<K,V> scanFilter
This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
String conditionalOperator
This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
Map<K,V> exclusiveStartKey
The primary key of the first item that this operation will evaluate. Use the value that was returned for
LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the
same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
String returnConsumedCapacity
Integer totalSegments
For a parallel Scan request, TotalSegments represents the total number of segments into
which the Scan operation will be divided. The value of TotalSegments corresponds to the
number of application workers that will perform the parallel scan. For example, if you want to use four
application threads to scan a table or an index, specify a TotalSegments value of 4.
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000.
If you specify a TotalSegments value of 1, the Scan operation will be sequential rather
than parallel.
If you specify TotalSegments, you must also specify Segment.
Integer segment
For a parallel Scan request, Segment identifies an individual segment to be scanned by
an application worker.
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application
threads to scan a table or an index, then the first thread specifies a Segment value of 0, the
second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as
ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for
TotalSegments.
If you provide Segment, you must also provide TotalSegments.
String projectionExpression
A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
String filterExpression
A string that contains conditions that DynamoDB applies after the Scan operation, but before the
data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does
not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that
you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
Boolean consistentRead
A Boolean value that determines the read consistency model during the scan:
If ConsistentRead is false, then the data returned from Scan might not
contain the results from other recently completed write operations (PutItem, UpdateItem
, or DeleteItem).
If ConsistentRead is true, then all of the write operations that completed before the
Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is false.
The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global
secondary index with ConsistentRead set to true, you will receive a ValidationException
.
List<E> items
An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.
Integer count
The number of items in the response.
If you set ScanFilter in the request, then Count is the number of items returned after
the filter was applied, and ScannedCount is the number of matching items before the filter was
applied.
If you did not use a filter in the request, then Count is the same as ScannedCount.
Integer scannedCount
The number of items evaluated, before any ScanFilter is applied. A high ScannedCount
value with few, or no, Count results indicates an inefficient Scan operation. For more
information, see Count and
ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as Count.
Map<K,V> lastEvaluatedKey
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no
more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result
set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey
is empty.
ConsumedCapacity consumedCapacity
The capacity units consumed by the Scan 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 ReturnConsumedCapacity parameter was
specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
String startingSequenceNumber
The first sequence number for the stream records contained within a shard. String contains numeric characters only.
String endingSequenceNumber
The last sequence number for the stream records contained within a shard. String contains numeric characters only.
String shardId
The system-generated identifier for this shard.
SequenceNumberRange sequenceNumberRange
The range of possible sequence numbers for the shard.
String parentShardId
The shard ID of the current shard's parent.
String tableName
The name of the table for which the backup was created.
String tableId
Unique identifier for the table for which the backup was created.
String tableArn
ARN of the table for which backup was created.
Long tableSizeBytes
Size of the table in bytes. Note that this is an approximate value.
List<E> keySchema
Schema of the table.
Date tableCreationDateTime
Time when the source table was created.
ProvisionedThroughput provisionedThroughput
Read IOPs and Write IOPS on the table when the backup was created.
Long itemCount
Number of items in the table. Note that this is an approximate value.
String billingMode
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using
PROVISIONED for predictable workloads.
PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend
using PAY_PER_REQUEST for unpredictable workloads.
List<E> localSecondaryIndexes
Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.
List<E> globalSecondaryIndexes
Represents the GSI properties for the table when the backup was created. It includes the IndexName, KeySchema, Projection, and ProvisionedThroughput for the GSIs on the table at the time of backup.
StreamSpecification streamDescription
Stream settings on the table when the backup was created.
TimeToLiveDescription timeToLiveDescription
Time to Live settings on the table when the backup was created.
SSEDescription sSEDescription
The description of the server-side encryption status on the table when the backup was created.
String status
Represents the current state of server-side encryption. The only supported values are:
ENABLED - Server-side encryption is enabled.
UPDATING - Server-side encryption is being updated.
String sSEType
Server-side encryption type. The only supported value is:
KMS - Server-side encryption that uses AWS Key Management Service. The key is stored in your account
and is managed by AWS KMS (AWS KMS charges apply).
String kMSMasterKeyArn
The AWS KMS customer master key (CMK) ARN used for the AWS KMS encryption.
Date inaccessibleEncryptionDateTime
Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's AWS KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's AWS KMS key is accessible again. DynamoDB will initiate the table archival process when table's AWS KMS key remains inaccessible for more than seven days from this date.
Boolean enabled
Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true),
server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If
disabled (false) or not specified, server-side encryption is set to AWS owned CMK.
String sSEType
Server-side encryption type. The only supported value is:
KMS - Server-side encryption that uses AWS Key Management Service. The key is stored in your account
and is managed by AWS KMS (AWS KMS charges apply).
String kMSMasterKeyId
The AWS KMS customer master key (CMK) that should be used for the AWS KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB customer master key alias/aws/dynamodb.
String streamArn
The Amazon Resource Name (ARN) for the stream.
String tableName
The DynamoDB table with which the stream is associated.
String streamLabel
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a
stream from another table might have the same timestamp. However, the combination of the following three elements
is guaranteed to be unique:
the AWS customer ID.
the table name
the StreamLabel
String streamArn
The Amazon Resource Name (ARN) for the stream.
String streamLabel
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a
stream from another table might have the same timestamp. However, the combination of the following three elements
is guaranteed to be unique:
the AWS customer ID.
the table name
the StreamLabel
String streamStatus
Indicates the current status of the stream:
ENABLING - Streams is currently being enabled on the DynamoDB table.
ENABLED - the stream is enabled.
DISABLING - Streams is currently being disabled on the DynamoDB table.
DISABLED - the stream is disabled.
String streamViewType
Indicates the format of the records within this stream:
KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.
NEW_IMAGE - entire items from the table, as they appeared after they were modified.
OLD_IMAGE - entire items from the table, as they appeared before they were modified.
NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.
Date creationRequestDateTime
The date and time when the request to create this stream was issued.
String tableName
The DynamoDB table with which the stream is associated.
List<E> keySchema
The key attribute(s) of the stream's DynamoDB table.
List<E> shards
The shards that comprise the stream.
String lastEvaluatedShardId
The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is
currently no more data to be retrieved.
If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the
result set. The only way to know when you have reached the end of the result set is when
LastEvaluatedShardId is empty.
Date approximateCreationDateTime
The approximate date and time when the stream record was created, in UNIX epoch time format.
Map<K,V> keys
The primary key attribute(s) for the DynamoDB item that was modified.
Map<K,V> newImage
The item in the DynamoDB table as it appeared after it was modified.
Map<K,V> oldImage
The item in the DynamoDB table as it appeared before it was modified.
String sequenceNumber
The sequence number of the stream record.
Long sizeBytes
The size of the stream record, in bytes.
String streamViewType
The type of data from the modified DynamoDB item that was captured in this stream record:
KEYS_ONLY - only the key attributes of the modified item.
NEW_IMAGE - the entire item, as it appeared after it was modified.
OLD_IMAGE - the entire item, as it appeared before it was modified.
NEW_AND_OLD_IMAGES - both the new and the old item images of the item.
Boolean streamEnabled
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
String streamViewType
When an item in the table is modified, StreamViewType determines what information is written to the
stream for this table. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
String tableName
The name of the table.
String tableStatus
The current state of the table:
CREATING - The table is being created.
UPDATING - The table is being updated.
DELETING - The table is being deleted.
ACTIVE - The table is ready for use.
List<E> replicas
Represents replicas of the global table.
List<E> attributeDefinitions
An array of AttributeDefinition objects. Each of these objects describes one attribute in the table
and index key schema.
Each AttributeDefinition object in this array is composed of:
AttributeName - The name of the attribute.
AttributeType - The data type for the attribute.
String tableName
The name of the table.
List<E> keySchema
The primary key structure for the table. Each KeySchemaElement consists of:
AttributeName - The name of the attribute.
KeyType - The role of the attribute:
HASH - partition key
RANGE - sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
String tableStatus
The current state of the table:
CREATING - The table is being created.
UPDATING - The table is being updated.
DELETING - The table is being deleted.
ACTIVE - The table is ready for use.
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table in inaccessible.
Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival
process when a table's AWS KMS key remains inaccessible for more than seven days.
ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
ARCHIVED - The table has been archived. See the ArchivalReason for more information.
Date creationDateTime
The date and time when the table was created, in UNIX epoch time format.
ProvisionedThroughputDescription provisionedThroughput
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
Long tableSizeBytes
The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
Long itemCount
The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
String tableArn
The Amazon Resource Name (ARN) that uniquely identifies the table.
String tableId
Unique identifier for the table for which the backup was created.
BillingModeSummary billingModeSummary
Contains the details for the read/write capacity mode.
List<E> localSecondaryIndexes
Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
IndexName - The name of the local secondary index.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be
between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes.
ALL - All of the table attributes are projected into the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of
the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately
every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING state, no information about indexes will be returned.
List<E> globalSecondaryIndexes
The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only
when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new
index with data from the table. (This attribute does not appear for indexes that were created during a
CreateTable operation.)
You can delete an index that is being created during the Backfilling phase when
IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that
is being created when IndexStatus is set to CREATING and Backfilling is false. (This
attribute does not appear for indexes that were created during a CreateTable operation.)
IndexName - The name of the global secondary index.
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus - The current status of the global secondary index:
CREATING - The index is being created.
UPDATING - The index is being updated.
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
ItemCount - The number of items in the global secondary index. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in this value.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be
between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index
will include other non-key attributes that you specify.
ALL - All of the table attributes are projected into the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of
the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING state, no information about indexes will be returned.
StreamSpecification streamSpecification
The current DynamoDB Streams configuration for the table.
String latestStreamLabel
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a
stream from another table might have the same timestamp. However, the combination of the following three elements
is guaranteed to be unique:
AWS customer ID
Table name
StreamLabel
String latestStreamArn
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
String globalTableVersion
Represents the version of global tables in use, if the table is replicated across AWS Regions.
List<E> replicas
Represents replicas of the table.
RestoreSummary restoreSummary
Contains details for the restore.
SSEDescription sSEDescription
The description of the server-side encryption status on the specified table.
ArchivalSummary archivalSummary
Contains information about the table archive.
String key
The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
String value
The value of the tag. Tag values are case-sensitive and can be null.
Get get
Contains the primary key that identifies the item to get, together with the name of the table that contains the item, and optionally the specific attributes of the item to retrieve.
List<E> transactItems
An ordered array of up to 25 TransactGetItem objects, each of which contains a Get
structure.
String returnConsumedCapacity
A value of TOTAL causes consumed capacity information to be returned, and a value of
NONE prevents that information from being returned. No other value is valid.
List<E> consumedCapacity
If the ReturnConsumedCapacity value was TOTAL, this is an array of
ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in
the TransactItems parameter. These ConsumedCapacity objects report the read-capacity units
consumed by the TransactGetItems call in that table.
List<E> responses
An ordered array of up to 25 ItemResponse objects, each of which corresponds to the
TransactGetItem object in the same position in the TransactItems array. Each
ItemResponse object contains a Map of the name-value pairs that are the projected attributes of the
requested item.
If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or if the
requested item has no projected attributes, the corresponding ItemResponse object is an empty Map.
ConditionCheck conditionCheck
A request to perform a check item operation.
Put put
A request to perform a PutItem operation.
Delete delete
A request to perform a DeleteItem operation.
Update update
A request to perform an UpdateItem operation.
List<E> transactItems
An ordered array of up to 25 TransactWriteItem objects, each of which contains a
ConditionCheck, Put, Update, or Delete object. These can
operate on items in different tables, but the tables must reside in the same AWS account and Region, and no two
of them can operate on the same item.
String returnConsumedCapacity
String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to SIZE, the response includes
statistics about item collections (if any), that were modified during the operation and are returned in the
response. If set to NONE (the default), no statistics are returned.
String clientRequestToken
Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning
that multiple identical calls have the same effect as one single call.
Although multiple identical calls using the same client request token produce the same result on the server (no
side effects), the responses to the calls might not be the same. If the ReturnConsumedCapacity>
parameter is set, then the initial TransactWriteItems call returns the amount of write capacity
units consumed in making the changes. Subsequent TransactWriteItems calls with the same client token
return the number of read capacity units consumed in reading the item.
A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.
If you submit a request with the same client token but a change in other parameters within the 10-minute
idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.
List<E> consumedCapacity
The capacity units consumed by the entire TransactWriteItems operation. The values of the list are
ordered according to the ordering of the TransactItems request parameter.
Map<K,V> itemCollectionMetrics
A list of tables that were processed by TransactWriteItems and, for each table, information about
any item collections that were affected by individual UpdateItem, PutItem, or
DeleteItem operations.
Map<K,V> key
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
String updateExpression
An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
String tableName
Name of the table for the UpdateItem request.
String conditionExpression
A condition that must be satisfied in order for a conditional update to succeed.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
String returnValuesOnConditionCheckFailure
Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update
condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE, ALL_OLD,
UPDATED_OLD, ALL_NEW, UPDATED_NEW.
String tableName
The name of the table.
PointInTimeRecoverySpecification pointInTimeRecoverySpecification
Represents the settings used to enable point in time recovery.
ContinuousBackupsDescription continuousBackupsDescription
Represents the continuous backups and point in time recovery settings on the table.
String indexName
The name of the global secondary index to be updated.
ProvisionedThroughput provisionedThroughput
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
GlobalTableDescription globalTableDescription
Contains the details of the global table.
String globalTableName
The name of the global table
String globalTableBillingMode
The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table
defaults to PROVISIONED capacity billing mode.
PROVISIONED - We recommend using PROVISIONED for predictable workloads.
PROVISIONED sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads.
PAY_PER_REQUEST sets the billing mode to On-Demand Mode.
Long globalTableProvisionedWriteCapacityUnits
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
AutoScalingSettingsUpdate globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate
Auto scaling settings for managing provisioned write capacity for the global table.
List<E> globalTableGlobalSecondaryIndexSettingsUpdate
Represents the settings of a global secondary index for a global table that will be modified.
List<E> replicaSettingsUpdate
Represents the settings for a global table in a Region that will be modified.
String tableName
The name of the table containing the item to update.
Map<K,V> key
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
Map<K,V> attributeUpdates
This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
Map<K,V> expected
This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
String conditionalOperator
This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
String returnValues
Use ReturnValues if you want to get the item attributes as they appear before or after they are
updated. For UpdateItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE, then
nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem
operation.
UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The values returned are strongly consistent.
String returnConsumedCapacity
String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to SIZE, the response includes
statistics about item collections, if any, that were modified during the operation are returned in the response.
If set to NONE (the default), no statistics are returned.
String updateExpression
An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.
The following action values are available for UpdateExpression.
SET - Adds one or more attributes and values to an item. If any of these attributes already exist,
they are replaced by the new values. You can also use SET to add or subtract from an attribute that
is of type Number. For example: SET myNum = myNum + :val
SET supports the following functions:
if_not_exists (path, operand) - if the item does not contain an attribute at the specified path,
then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function
to avoid overwriting an attribute that may already be present in the item.
list_append (operand, operand) - evaluates to a list with a new element added to it. You can append
the new element to the start or the end of the list by reversing the order of the operands.
These function names are case-sensitive.
REMOVE - Removes one or more attributes from an item.
ADD - Adds the specified value to the item, if the attribute does not already exist. If the
attribute does exist, then the behavior of ADD depends on the data type of the attribute:
If the existing attribute is a number, and if Value is also a number, then Value is
mathematically added to the existing attribute. If Value is a negative number, then it is subtracted
from the existing attribute.
If you use ADD to increment or decrement a number value for an item that doesn't exist before the
update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that
doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the
item you want to update doesn't have an attribute named itemcount, but you decide to
ADD the number 3 to this attribute anyway. DynamoDB will create the
itemcount attribute, set its initial value to 0, and finally add 3 to it.
The result will be a new itemcount attribute in the item, with a value of 3.
If the existing data type is a set and if Value is also a set, then Value is added to
the existing set. For example, if the attribute value is the set [1,2], and the ADD
action specified [3], then the final attribute value is [1,2,3]. An error occurs if an
ADD action is specified for a set attribute and the attribute type specified does not match the
existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the
Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition, ADD can only be
used on top-level attributes, not nested attributes.
DELETE - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute
value was the set [a,b,c] and the DELETE action specifies [a,c], then the
final attribute value is [b]. Specifying an empty set is an error.
The DELETE action only supports set data types. In addition, DELETE can only be used on
top-level attributes, not nested attributes.
You can have many actions in a single expression, such as the following:
SET a=:value1, b=:value2 DELETE :value3, :value4, :value5
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
String conditionExpression
A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for
ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that
you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
Map<K,V> attributes
A map of attribute values as they appear before or after the UpdateItem operation, as determined by
the ReturnValues parameter.
The Attributes map is only present if ReturnValues was specified as something other
than NONE in the request. Each element represents one attribute.
ConsumedCapacity consumedCapacity
The capacity units consumed by the UpdateItem 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 ReturnConsumedCapacity parameter was
specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
ItemCollectionMetrics itemCollectionMetrics
Information about item collections, if any, that were affected by the UpdateItem operation.
ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was
specified. If the table does not have any local secondary indexes, this information is not returned in the
response.
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The partition key value of the item collection. This is the same as the
partition key value of the item itself.
SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element
array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the
items in the table, plus the size of all attributes projected into all of the local secondary indexes on that
table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
String regionName
The Region where the replica exists.
String kMSMasterKeyId
The AWS KMS customer master key (CMK) of the replica that should be used for AWS KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS master key alias/aws/dynamodb.
ProvisionedThroughputOverride provisionedThroughputOverride
Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.
List<E> globalSecondaryIndexes
Replica-specific global secondary index settings.
List<E> globalSecondaryIndexUpdates
Represents the auto scaling settings of the global secondary indexes of the replica to be updated.
String tableName
The name of the global table to be updated.
AutoScalingSettingsUpdate provisionedWriteCapacityAutoScalingUpdate
List<E> replicaUpdates
Represents the auto scaling settings of replicas of the table that will be modified.
TableAutoScalingDescription tableAutoScalingDescription
Returns information about the auto scaling settings of a table with replicas.
List<E> attributeDefinitions
An array of attributes that describe the key schema for the table and indexes. If you are adding a new global
secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.
String tableName
The name of the table to be updated.
String billingMode
Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.
PROVISIONED - We recommend using PROVISIONED for predictable workloads.
PROVISIONED sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads.
PAY_PER_REQUEST sets the billing mode to On-Demand Mode.
ProvisionedThroughput provisionedThroughput
The new provisioned throughput settings for the specified table or index.
List<E> globalSecondaryIndexUpdates
An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:
Create - add a new global secondary index to the table.
Update - modify the provisioned throughput settings of an existing global secondary index.
Delete - remove a global secondary index from the table.
You can create or delete only one global secondary index per UpdateTable operation.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
StreamSpecification streamSpecification
Represents the DynamoDB Streams configuration for the table.
You receive a ResourceInUseException if you try to enable a stream on a table that already has a
stream, or if you try to disable a stream on a table that doesn't have a stream.
SSESpecification sSESpecification
The new server-side encryption settings for the specified table.
List<E> replicaUpdates
A list of replica update actions (create, delete, or update) for the table.
This property only applies to Version 2019.11.21 of global tables.
TableDescription tableDescription
Represents the properties of the table.
String tableName
The name of the table to be configured.
TimeToLiveSpecification timeToLiveSpecification
Represents the settings used to enable or disable Time to Live for the specified table.
TimeToLiveSpecification timeToLiveSpecification
Represents the output of an UpdateTimeToLive operation.
PutRequest putRequest
A request to perform a PutItem operation.
DeleteRequest deleteRequest
A request to perform a DeleteItem operation.
Copyright © 2021. All rights reserved.