Struct aws_sdk_dynamodb::client::fluent_builders::PutItem [−][src]
pub struct PutItem<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to PutItem
.
Creates a new item, or replaces an old item with a new item. If an item that has the
same primary key as the new item already exists in the specified table, the new item
completely replaces the existing item. You can perform a conditional put operation (add
a new item if one with the specified primary key doesn't exist), or replace an existing
item if it has certain attribute values. You can return the item's attribute values in
the same operation, using the ReturnValues
parameter.
This topic provides general information about the PutItem
API.
For information on how to call the PutItem
API using the Amazon Web Services SDK in specific languages, see the following:
When you add an item, the primary key attributes are the only required attributes. Attribute values cannot be null.
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. Set type attributes cannot be empty.
Invalid Requests with empty values will be rejected with a
ValidationException
exception.
To prevent a new item from replacing an existing item, use a conditional
expression that contains the attribute_not_exists
function with the
name of the attribute being used as the partition key for the table. Since every
record must contain that attribute, the attribute_not_exists
function
will only succeed if no matching item exists.
For more information about PutItem
, see Working with
Items in the Amazon DynamoDB Developer Guide.
Implementations
impl<C, M, R> PutItem<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> PutItem<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(self) -> Result<PutItemOutput, SdkError<PutItemError>> where
R::Policy: SmithyRetryPolicy<PutItemInputOperationOutputAlias, PutItemOutput, PutItemError, PutItemInputOperationRetryAlias>,
pub async fn send(self) -> Result<PutItemOutput, SdkError<PutItemError>> where
R::Policy: SmithyRetryPolicy<PutItemInputOperationOutputAlias, PutItemOutput, PutItemError, PutItemInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
The name of the table to contain the item.
The name of the table to contain the item.
Adds a key-value pair to Item
.
To override the contents of this collection use set_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.
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.
Adds a key-value pair to Expected
.
To override the contents of this collection use set_expected
.
This is a legacy parameter. Use ConditionExpression
instead. For more
information, see Expected in the Amazon DynamoDB Developer
Guide.
This is a legacy parameter. Use ConditionExpression
instead. For more
information, see Expected in the Amazon DynamoDB Developer
Guide.
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
- IfReturnValues
is not specified, or if its value isNONE
, then nothing is returned. (This setting is the default forReturnValues
.) -
ALL_OLD
- IfPutItem
overwrote an attribute name-value pair, then the content of the old item is returned.
The values returned are strongly consistent.
The ReturnValues
parameter is used by several DynamoDB operations;
however, PutItem
does not recognize any values other than
NONE
or ALL_OLD
.
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
- IfReturnValues
is not specified, or if its value isNONE
, then nothing is returned. (This setting is the default forReturnValues
.) -
ALL_OLD
- IfPutItem
overwrote an attribute name-value pair, then the content of the old item is returned.
The values returned are strongly consistent.
The ReturnValues
parameter is used by several DynamoDB operations;
however, PutItem
does not recognize any values other than
NONE
or ALL_OLD
.
Determines the level of detail about provisioned throughput consumption that is returned in the response:
-
INDEXES
- The response includes the aggregateConsumedCapacity
for the operation, together withConsumedCapacity
for each table and secondary index that was accessed.Note that some operations, such as
GetItem
andBatchGetItem
, do not access any indexes at all. In these cases, specifyingINDEXES
will only returnConsumedCapacity
information for table(s). -
TOTAL
- The response includes only the aggregateConsumedCapacity
for the operation. -
NONE
- NoConsumedCapacity
details are included in the response.
Determines the level of detail about provisioned throughput consumption that is returned in the response:
-
INDEXES
- The response includes the aggregateConsumedCapacity
for the operation, together withConsumedCapacity
for each table and secondary index that was accessed.Note that some operations, such as
GetItem
andBatchGetItem
, do not access any indexes at all. In these cases, specifyingINDEXES
will only returnConsumedCapacity
information for table(s). -
TOTAL
- The response includes only the aggregateConsumedCapacity
for the operation. -
NONE
- NoConsumedCapacity
details are included in the response.
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.
pub fn set_return_item_collection_metrics(
self,
input: Option<ReturnItemCollectionMetrics>
) -> Self
pub fn set_return_item_collection_metrics(
self,
input: Option<ReturnItemCollectionMetrics>
) -> Self
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.
This is a legacy parameter. Use ConditionExpression
instead. For more
information, see ConditionalOperator in the Amazon DynamoDB Developer
Guide.
This is a legacy parameter. Use ConditionExpression
instead. For more
information, see ConditionalOperator in the Amazon DynamoDB Developer
Guide.
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.
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.
Adds a key-value pair to ExpressionAttributeNames
.
To override the contents of this collection use set_expression_attribute_names
.
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.
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.
pub fn expression_attribute_values(
self,
k: impl Into<String>,
v: impl Into<AttributeValue>
) -> Self
pub fn expression_attribute_values(
self,
k: impl Into<String>,
v: impl Into<AttributeValue>
) -> Self
Adds a key-value pair to ExpressionAttributeValues
.
To override the contents of this collection use set_expression_attribute_values
.
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.
pub fn set_expression_attribute_values(
self,
input: Option<HashMap<String, AttributeValue>>
) -> Self
pub fn set_expression_attribute_values(
self,
input: Option<HashMap<String, AttributeValue>>
) -> Self
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.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !RefUnwindSafe for PutItem<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for PutItem<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more