Struct aws_sdk_dynamodb::input::PutItemInput
source · #[non_exhaustive]pub struct PutItemInput { /* private fields */ }
Expand description
Represents the input of a PutItem
operation.
Implementations§
source§impl PutItemInput
impl PutItemInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<PutItem, AwsResponseRetryClassifier>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<PutItem, AwsResponseRetryClassifier>, BuildError>
Consumes the builder and constructs an Operation<PutItem
>
Examples found in repository?
5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::PutItem,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::PutItemError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::PutItemOutput,
aws_smithy_http::result::SdkError<crate::error::PutItemError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture PutItemInput
.
source§impl PutItemInput
impl PutItemInput
sourcepub fn table_name(&self) -> Option<&str>
pub fn table_name(&self) -> Option<&str>
The name of the table to contain the item.
sourcepub fn item(&self) -> Option<&HashMap<String, AttributeValue>>
pub fn item(&self) -> Option<&HashMap<String, AttributeValue>>
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.
sourcepub fn expected(&self) -> Option<&HashMap<String, ExpectedAttributeValue>>
pub fn expected(&self) -> Option<&HashMap<String, ExpectedAttributeValue>>
This is a legacy parameter. Use ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
sourcepub fn return_values(&self) -> Option<&ReturnValue>
pub fn return_values(&self) -> Option<&ReturnValue>
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.
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 ReturnValues
parameter is used by several DynamoDB operations; however, PutItem
does not recognize any values other than NONE
or ALL_OLD
.
sourcepub fn return_consumed_capacity(&self) -> Option<&ReturnConsumedCapacity>
pub fn return_consumed_capacity(&self) -> Option<&ReturnConsumedCapacity>
Determines the level of detail about either provisioned or on-demand 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.
sourcepub fn return_item_collection_metrics(
&self
) -> Option<&ReturnItemCollectionMetrics>
pub fn return_item_collection_metrics(
&self
) -> Option<&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.
sourcepub fn conditional_operator(&self) -> Option<&ConditionalOperator>
pub fn conditional_operator(&self) -> Option<&ConditionalOperator>
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
sourcepub fn condition_expression(&self) -> Option<&str>
pub fn condition_expression(&self) -> Option<&str>
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.
sourcepub fn expression_attribute_names(&self) -> Option<&HashMap<String, String>>
pub fn expression_attribute_names(&self) -> Option<&HashMap<String, String>>
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.
sourcepub fn expression_attribute_values(
&self
) -> Option<&HashMap<String, AttributeValue>>
pub fn expression_attribute_values(
&self
) -> Option<&HashMap<String, AttributeValue>>
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§
source§impl Clone for PutItemInput
impl Clone for PutItemInput
source§fn clone(&self) -> PutItemInput
fn clone(&self) -> PutItemInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more