AWS SDK for C++  1.8.52
AWS SDK for C++
Public Member Functions | List of all members
Aws::DynamoDB::Model::GetItemRequest Class Reference

#include <GetItemRequest.h>

+ Inheritance diagram for Aws::DynamoDB::Model::GetItemRequest:

Public Member Functions

 GetItemRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetTableName () const
 
bool TableNameHasBeenSet () const
 
void SetTableName (const Aws::String &value)
 
void SetTableName (Aws::String &&value)
 
void SetTableName (const char *value)
 
GetItemRequestWithTableName (const Aws::String &value)
 
GetItemRequestWithTableName (Aws::String &&value)
 
GetItemRequestWithTableName (const char *value)
 
const Aws::Map< Aws::String, AttributeValue > & GetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (const Aws::Map< Aws::String, AttributeValue > &value)
 
void SetKey (Aws::Map< Aws::String, AttributeValue > &&value)
 
GetItemRequestWithKey (const Aws::Map< Aws::String, AttributeValue > &value)
 
GetItemRequestWithKey (Aws::Map< Aws::String, AttributeValue > &&value)
 
GetItemRequestAddKey (const Aws::String &key, const AttributeValue &value)
 
GetItemRequestAddKey (Aws::String &&key, const AttributeValue &value)
 
GetItemRequestAddKey (const Aws::String &key, AttributeValue &&value)
 
GetItemRequestAddKey (Aws::String &&key, AttributeValue &&value)
 
GetItemRequestAddKey (const char *key, AttributeValue &&value)
 
GetItemRequestAddKey (const char *key, const AttributeValue &value)
 
const Aws::Vector< Aws::String > & GetAttributesToGet () const
 
bool AttributesToGetHasBeenSet () const
 
void SetAttributesToGet (const Aws::Vector< Aws::String > &value)
 
void SetAttributesToGet (Aws::Vector< Aws::String > &&value)
 
GetItemRequestWithAttributesToGet (const Aws::Vector< Aws::String > &value)
 
GetItemRequestWithAttributesToGet (Aws::Vector< Aws::String > &&value)
 
GetItemRequestAddAttributesToGet (const Aws::String &value)
 
GetItemRequestAddAttributesToGet (Aws::String &&value)
 
GetItemRequestAddAttributesToGet (const char *value)
 
bool GetConsistentRead () const
 
bool ConsistentReadHasBeenSet () const
 
void SetConsistentRead (bool value)
 
GetItemRequestWithConsistentRead (bool value)
 
const ReturnConsumedCapacityGetReturnConsumedCapacity () const
 
bool ReturnConsumedCapacityHasBeenSet () const
 
void SetReturnConsumedCapacity (const ReturnConsumedCapacity &value)
 
void SetReturnConsumedCapacity (ReturnConsumedCapacity &&value)
 
GetItemRequestWithReturnConsumedCapacity (const ReturnConsumedCapacity &value)
 
GetItemRequestWithReturnConsumedCapacity (ReturnConsumedCapacity &&value)
 
const Aws::StringGetProjectionExpression () const
 
bool ProjectionExpressionHasBeenSet () const
 
void SetProjectionExpression (const Aws::String &value)
 
void SetProjectionExpression (Aws::String &&value)
 
void SetProjectionExpression (const char *value)
 
GetItemRequestWithProjectionExpression (const Aws::String &value)
 
GetItemRequestWithProjectionExpression (Aws::String &&value)
 
GetItemRequestWithProjectionExpression (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetExpressionAttributeNames () const
 
bool ExpressionAttributeNamesHasBeenSet () const
 
void SetExpressionAttributeNames (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetExpressionAttributeNames (Aws::Map< Aws::String, Aws::String > &&value)
 
GetItemRequestWithExpressionAttributeNames (const Aws::Map< Aws::String, Aws::String > &value)
 
GetItemRequestWithExpressionAttributeNames (Aws::Map< Aws::String, Aws::String > &&value)
 
GetItemRequestAddExpressionAttributeNames (const Aws::String &key, const Aws::String &value)
 
GetItemRequestAddExpressionAttributeNames (Aws::String &&key, const Aws::String &value)
 
GetItemRequestAddExpressionAttributeNames (const Aws::String &key, Aws::String &&value)
 
GetItemRequestAddExpressionAttributeNames (Aws::String &&key, Aws::String &&value)
 
GetItemRequestAddExpressionAttributeNames (const char *key, Aws::String &&value)
 
GetItemRequestAddExpressionAttributeNames (Aws::String &&key, const char *value)
 
GetItemRequestAddExpressionAttributeNames (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::DynamoDB::DynamoDBRequest
virtual ~DynamoDBRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Represents the input of a GetItem operation.

See Also:

AWS API Reference

Definition at line 29 of file GetItemRequest.h.

Constructor & Destructor Documentation

◆ GetItemRequest()

Aws::DynamoDB::Model::GetItemRequest::GetItemRequest ( )

Member Function Documentation

◆ AddAttributesToGet() [1/3]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddAttributesToGet ( const Aws::String value)
inline

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

Definition at line 249 of file GetItemRequest.h.

◆ AddAttributesToGet() [2/3]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddAttributesToGet ( Aws::String &&  value)
inline

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

Definition at line 257 of file GetItemRequest.h.

◆ AddAttributesToGet() [3/3]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddAttributesToGet ( const char *  value)
inline

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

Definition at line 265 of file GetItemRequest.h.

◆ AddExpressionAttributeNames() [1/7]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddExpressionAttributeNames ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 600 of file GetItemRequest.h.

◆ AddExpressionAttributeNames() [2/7]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddExpressionAttributeNames ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 627 of file GetItemRequest.h.

◆ AddExpressionAttributeNames() [3/7]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddExpressionAttributeNames ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 654 of file GetItemRequest.h.

◆ AddExpressionAttributeNames() [4/7]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddExpressionAttributeNames ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 681 of file GetItemRequest.h.

◆ AddExpressionAttributeNames() [5/7]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddExpressionAttributeNames ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 708 of file GetItemRequest.h.

◆ AddExpressionAttributeNames() [6/7]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddExpressionAttributeNames ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 735 of file GetItemRequest.h.

◆ AddExpressionAttributeNames() [7/7]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddExpressionAttributeNames ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 762 of file GetItemRequest.h.

◆ AddKey() [1/6]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddKey ( const Aws::String key,
const AttributeValue value 
)
inline

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.

Definition at line 147 of file GetItemRequest.h.

◆ AddKey() [2/6]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddKey ( Aws::String &&  key,
const AttributeValue value 
)
inline

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.

Definition at line 156 of file GetItemRequest.h.

◆ AddKey() [3/6]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddKey ( const Aws::String key,
AttributeValue &&  value 
)
inline

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.

Definition at line 165 of file GetItemRequest.h.

◆ AddKey() [4/6]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddKey ( Aws::String &&  key,
AttributeValue &&  value 
)
inline

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.

Definition at line 174 of file GetItemRequest.h.

◆ AddKey() [5/6]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddKey ( const char *  key,
AttributeValue &&  value 
)
inline

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.

Definition at line 183 of file GetItemRequest.h.

◆ AddKey() [6/6]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::AddKey ( const char *  key,
const AttributeValue value 
)
inline

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.

Definition at line 192 of file GetItemRequest.h.

◆ AttributesToGetHasBeenSet()

bool Aws::DynamoDB::Model::GetItemRequest::AttributesToGetHasBeenSet ( ) const
inline

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

Definition at line 209 of file GetItemRequest.h.

◆ ConsistentReadHasBeenSet()

bool Aws::DynamoDB::Model::GetItemRequest::ConsistentReadHasBeenSet ( ) const
inline

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

Definition at line 280 of file GetItemRequest.h.

◆ ExpressionAttributeNamesHasBeenSet()

bool Aws::DynamoDB::Model::GetItemRequest::ExpressionAttributeNamesHasBeenSet ( ) const
inline

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.

Definition at line 465 of file GetItemRequest.h.

◆ GetAttributesToGet()

const Aws::Vector<Aws::String>& Aws::DynamoDB::Model::GetItemRequest::GetAttributesToGet ( ) const
inline

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

Definition at line 201 of file GetItemRequest.h.

◆ GetConsistentRead()

bool Aws::DynamoDB::Model::GetItemRequest::GetConsistentRead ( ) const
inline

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

Definition at line 273 of file GetItemRequest.h.

◆ GetExpressionAttributeNames()

const Aws::Map<Aws::String, Aws::String>& Aws::DynamoDB::Model::GetItemRequest::GetExpressionAttributeNames ( ) const
inline

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.

Definition at line 438 of file GetItemRequest.h.

◆ GetKey()

const Aws::Map<Aws::String, AttributeValue>& Aws::DynamoDB::Model::GetItemRequest::GetKey ( ) const
inline

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.

Definition at line 93 of file GetItemRequest.h.

◆ GetProjectionExpression()

const Aws::String& Aws::DynamoDB::Model::GetItemRequest::GetProjectionExpression ( ) const
inline

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.

Definition at line 326 of file GetItemRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::DynamoDB::Model::GetItemRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::DynamoDB::DynamoDBRequest.

◆ GetReturnConsumedCapacity()

const ReturnConsumedCapacity& Aws::DynamoDB::Model::GetItemRequest::GetReturnConsumedCapacity ( ) const
inline

Definition at line 298 of file GetItemRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::DynamoDB::Model::GetItemRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file GetItemRequest.h.

◆ GetTableName()

const Aws::String& Aws::DynamoDB::Model::GetItemRequest::GetTableName ( ) const
inline

The name of the table containing the requested item.

Definition at line 48 of file GetItemRequest.h.

◆ KeyHasBeenSet()

bool Aws::DynamoDB::Model::GetItemRequest::KeyHasBeenSet ( ) const
inline

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.

Definition at line 102 of file GetItemRequest.h.

◆ ProjectionExpressionHasBeenSet()

bool Aws::DynamoDB::Model::GetItemRequest::ProjectionExpressionHasBeenSet ( ) const
inline

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.

Definition at line 338 of file GetItemRequest.h.

◆ ReturnConsumedCapacityHasBeenSet()

bool Aws::DynamoDB::Model::GetItemRequest::ReturnConsumedCapacityHasBeenSet ( ) const
inline

Definition at line 301 of file GetItemRequest.h.

◆ SerializePayload()

Aws::String Aws::DynamoDB::Model::GetItemRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAttributesToGet() [1/2]

void Aws::DynamoDB::Model::GetItemRequest::SetAttributesToGet ( const Aws::Vector< Aws::String > &  value)
inline

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

Definition at line 217 of file GetItemRequest.h.

◆ SetAttributesToGet() [2/2]

void Aws::DynamoDB::Model::GetItemRequest::SetAttributesToGet ( Aws::Vector< Aws::String > &&  value)
inline

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

Definition at line 225 of file GetItemRequest.h.

◆ SetConsistentRead()

void Aws::DynamoDB::Model::GetItemRequest::SetConsistentRead ( bool  value)
inline

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

Definition at line 287 of file GetItemRequest.h.

◆ SetExpressionAttributeNames() [1/2]

void Aws::DynamoDB::Model::GetItemRequest::SetExpressionAttributeNames ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 492 of file GetItemRequest.h.

◆ SetExpressionAttributeNames() [2/2]

void Aws::DynamoDB::Model::GetItemRequest::SetExpressionAttributeNames ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 519 of file GetItemRequest.h.

◆ SetKey() [1/2]

void Aws::DynamoDB::Model::GetItemRequest::SetKey ( const Aws::Map< Aws::String, AttributeValue > &  value)
inline

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.

Definition at line 111 of file GetItemRequest.h.

◆ SetKey() [2/2]

void Aws::DynamoDB::Model::GetItemRequest::SetKey ( Aws::Map< Aws::String, AttributeValue > &&  value)
inline

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.

Definition at line 120 of file GetItemRequest.h.

◆ SetProjectionExpression() [1/3]

void Aws::DynamoDB::Model::GetItemRequest::SetProjectionExpression ( const Aws::String value)
inline

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.

Definition at line 350 of file GetItemRequest.h.

◆ SetProjectionExpression() [2/3]

void Aws::DynamoDB::Model::GetItemRequest::SetProjectionExpression ( Aws::String &&  value)
inline

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.

Definition at line 362 of file GetItemRequest.h.

◆ SetProjectionExpression() [3/3]

void Aws::DynamoDB::Model::GetItemRequest::SetProjectionExpression ( const char *  value)
inline

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.

Definition at line 374 of file GetItemRequest.h.

◆ SetReturnConsumedCapacity() [1/2]

void Aws::DynamoDB::Model::GetItemRequest::SetReturnConsumedCapacity ( const ReturnConsumedCapacity value)
inline

Definition at line 304 of file GetItemRequest.h.

◆ SetReturnConsumedCapacity() [2/2]

void Aws::DynamoDB::Model::GetItemRequest::SetReturnConsumedCapacity ( ReturnConsumedCapacity &&  value)
inline

Definition at line 307 of file GetItemRequest.h.

◆ SetTableName() [1/3]

void Aws::DynamoDB::Model::GetItemRequest::SetTableName ( const Aws::String value)
inline

The name of the table containing the requested item.

Definition at line 58 of file GetItemRequest.h.

◆ SetTableName() [2/3]

void Aws::DynamoDB::Model::GetItemRequest::SetTableName ( Aws::String &&  value)
inline

The name of the table containing the requested item.

Definition at line 63 of file GetItemRequest.h.

◆ SetTableName() [3/3]

void Aws::DynamoDB::Model::GetItemRequest::SetTableName ( const char *  value)
inline

The name of the table containing the requested item.

Definition at line 68 of file GetItemRequest.h.

◆ TableNameHasBeenSet()

bool Aws::DynamoDB::Model::GetItemRequest::TableNameHasBeenSet ( ) const
inline

The name of the table containing the requested item.

Definition at line 53 of file GetItemRequest.h.

◆ WithAttributesToGet() [1/2]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::WithAttributesToGet ( const Aws::Vector< Aws::String > &  value)
inline

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

Definition at line 233 of file GetItemRequest.h.

◆ WithAttributesToGet() [2/2]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::WithAttributesToGet ( Aws::Vector< Aws::String > &&  value)
inline

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

Definition at line 241 of file GetItemRequest.h.

◆ WithConsistentRead()

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::WithConsistentRead ( bool  value)
inline

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

Definition at line 294 of file GetItemRequest.h.

◆ WithExpressionAttributeNames() [1/2]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::WithExpressionAttributeNames ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 546 of file GetItemRequest.h.

◆ WithExpressionAttributeNames() [2/2]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::WithExpressionAttributeNames ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 573 of file GetItemRequest.h.

◆ WithKey() [1/2]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::WithKey ( const Aws::Map< Aws::String, AttributeValue > &  value)
inline

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.

Definition at line 129 of file GetItemRequest.h.

◆ WithKey() [2/2]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::WithKey ( Aws::Map< Aws::String, AttributeValue > &&  value)
inline

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.

Definition at line 138 of file GetItemRequest.h.

◆ WithProjectionExpression() [1/3]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::WithProjectionExpression ( const Aws::String value)
inline

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.

Definition at line 386 of file GetItemRequest.h.

◆ WithProjectionExpression() [2/3]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::WithProjectionExpression ( Aws::String &&  value)
inline

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.

Definition at line 398 of file GetItemRequest.h.

◆ WithProjectionExpression() [3/3]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::WithProjectionExpression ( const char *  value)
inline

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.

Definition at line 410 of file GetItemRequest.h.

◆ WithReturnConsumedCapacity() [1/2]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::WithReturnConsumedCapacity ( const ReturnConsumedCapacity value)
inline

Definition at line 310 of file GetItemRequest.h.

◆ WithReturnConsumedCapacity() [2/2]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::WithReturnConsumedCapacity ( ReturnConsumedCapacity &&  value)
inline

Definition at line 313 of file GetItemRequest.h.

◆ WithTableName() [1/3]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::WithTableName ( const Aws::String value)
inline

The name of the table containing the requested item.

Definition at line 73 of file GetItemRequest.h.

◆ WithTableName() [2/3]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::WithTableName ( Aws::String &&  value)
inline

The name of the table containing the requested item.

Definition at line 78 of file GetItemRequest.h.

◆ WithTableName() [3/3]

GetItemRequest& Aws::DynamoDB::Model::GetItemRequest::WithTableName ( const char *  value)
inline

The name of the table containing the requested item.

Definition at line 83 of file GetItemRequest.h.


The documentation for this class was generated from the following file: