Struct aws_sdk_dynamodb::input::BatchGetItemInput
source · #[non_exhaustive]pub struct BatchGetItemInput { /* private fields */ }
Expand description
Represents the input of a BatchGetItem
operation.
Implementations§
source§impl BatchGetItemInput
impl BatchGetItemInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<BatchGetItem, AwsResponseRetryClassifier>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<BatchGetItem, AwsResponseRetryClassifier>, BuildError>
Consumes the builder and constructs an Operation<BatchGetItem
>
Examples found in repository?
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::BatchGetItem,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::BatchGetItemError>,
> {
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::BatchGetItemOutput,
aws_smithy_http::result::SdkError<crate::error::BatchGetItemError>,
> {
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 BatchGetItemInput
.
source§impl BatchGetItemInput
impl BatchGetItemInput
sourcepub fn request_items(&self) -> Option<&HashMap<String, KeysAndAttributes>>
pub fn request_items(&self) -> Option<&HashMap<String, KeysAndAttributes>>
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
- Iftrue
, a strongly consistent read is used; iffalse
(the default), an eventually consistent read is used. -
ExpressionAttributeNames
- One or more substitution tokens for attribute names in theProjectionExpression
parameter. The following are some use cases for usingExpressionAttributeNames
:-
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. UseProjectionExpression
instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
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.
Trait Implementations§
source§impl Clone for BatchGetItemInput
impl Clone for BatchGetItemInput
source§fn clone(&self) -> BatchGetItemInput
fn clone(&self) -> BatchGetItemInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more