Struct rusoto_dynamodb::GetItemInput
source · [−]pub struct GetItemInput {
pub attributes_to_get: Option<Vec<String>>,
pub consistent_read: Option<bool>,
pub expression_attribute_names: Option<HashMap<String, String>>,
pub key: HashMap<String, AttributeValue>,
pub projection_expression: Option<String>,
pub return_consumed_capacity: Option<String>,
pub table_name: String,
}
Expand description
Represents the input of a GetItem
operation.
Fields
attributes_to_get: Option<Vec<String>>
This is a legacy parameter. Use ProjectionExpression
instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
consistent_read: Option<bool>
Determines the read consistency model: If set to true
, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.
expression_attribute_names: 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.
key: HashMap<String, AttributeValue>
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.
projection_expression: Option<String>
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.
return_consumed_capacity: Option<String>
table_name: String
The name of the table containing the requested item.
Trait Implementations
sourceimpl Clone for GetItemInput
impl Clone for GetItemInput
sourcefn clone(&self) -> GetItemInput
fn clone(&self) -> GetItemInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for GetItemInput
impl Debug for GetItemInput
sourceimpl Default for GetItemInput
impl Default for GetItemInput
sourcefn default() -> GetItemInput
fn default() -> GetItemInput
Returns the “default value” for a type. Read more
sourceimpl PartialEq<GetItemInput> for GetItemInput
impl PartialEq<GetItemInput> for GetItemInput
sourcefn eq(&self, other: &GetItemInput) -> bool
fn eq(&self, other: &GetItemInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &GetItemInput) -> bool
fn ne(&self, other: &GetItemInput) -> bool
This method tests for !=
.
sourceimpl Serialize for GetItemInput
impl Serialize for GetItemInput
impl StructuralPartialEq for GetItemInput
Auto Trait Implementations
impl RefUnwindSafe for GetItemInput
impl Send for GetItemInput
impl Sync for GetItemInput
impl Unpin for GetItemInput
impl UnwindSafe for GetItemInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more