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

#include <KeysAndAttributes.h>

Public Member Functions

 KeysAndAttributes ()
 
 KeysAndAttributes (Aws::Utils::Json::JsonView jsonValue)
 
KeysAndAttributesoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Vector< Aws::Map< Aws::String, AttributeValue > > & GetKeys () const
 
bool KeysHasBeenSet () const
 
void SetKeys (const Aws::Vector< Aws::Map< Aws::String, AttributeValue >> &value)
 
void SetKeys (Aws::Vector< Aws::Map< Aws::String, AttributeValue >> &&value)
 
KeysAndAttributesWithKeys (const Aws::Vector< Aws::Map< Aws::String, AttributeValue >> &value)
 
KeysAndAttributesWithKeys (Aws::Vector< Aws::Map< Aws::String, AttributeValue >> &&value)
 
KeysAndAttributesAddKeys (const Aws::Map< Aws::String, AttributeValue > &value)
 
KeysAndAttributesAddKeys (Aws::Map< Aws::String, 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)
 
KeysAndAttributesWithAttributesToGet (const Aws::Vector< Aws::String > &value)
 
KeysAndAttributesWithAttributesToGet (Aws::Vector< Aws::String > &&value)
 
KeysAndAttributesAddAttributesToGet (const Aws::String &value)
 
KeysAndAttributesAddAttributesToGet (Aws::String &&value)
 
KeysAndAttributesAddAttributesToGet (const char *value)
 
bool GetConsistentRead () const
 
bool ConsistentReadHasBeenSet () const
 
void SetConsistentRead (bool value)
 
KeysAndAttributesWithConsistentRead (bool value)
 
const Aws::StringGetProjectionExpression () const
 
bool ProjectionExpressionHasBeenSet () const
 
void SetProjectionExpression (const Aws::String &value)
 
void SetProjectionExpression (Aws::String &&value)
 
void SetProjectionExpression (const char *value)
 
KeysAndAttributesWithProjectionExpression (const Aws::String &value)
 
KeysAndAttributesWithProjectionExpression (Aws::String &&value)
 
KeysAndAttributesWithProjectionExpression (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)
 
KeysAndAttributesWithExpressionAttributeNames (const Aws::Map< Aws::String, Aws::String > &value)
 
KeysAndAttributesWithExpressionAttributeNames (Aws::Map< Aws::String, Aws::String > &&value)
 
KeysAndAttributesAddExpressionAttributeNames (const Aws::String &key, const Aws::String &value)
 
KeysAndAttributesAddExpressionAttributeNames (Aws::String &&key, const Aws::String &value)
 
KeysAndAttributesAddExpressionAttributeNames (const Aws::String &key, Aws::String &&value)
 
KeysAndAttributesAddExpressionAttributeNames (Aws::String &&key, Aws::String &&value)
 
KeysAndAttributesAddExpressionAttributeNames (const char *key, Aws::String &&value)
 
KeysAndAttributesAddExpressionAttributeNames (Aws::String &&key, const char *value)
 
KeysAndAttributesAddExpressionAttributeNames (const char *key, const char *value)
 

Detailed Description

Represents a set of primary keys and, for each key, the attributes to retrieve from 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. For a composite primary key, you must provide both the partition key and the sort key.

See Also:

AWS API Reference

Definition at line 39 of file KeysAndAttributes.h.

Constructor & Destructor Documentation

◆ KeysAndAttributes() [1/2]

Aws::DynamoDB::Model::KeysAndAttributes::KeysAndAttributes ( )

◆ KeysAndAttributes() [2/2]

Aws::DynamoDB::Model::KeysAndAttributes::KeysAndAttributes ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddAttributesToGet() [1/3]

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

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

Definition at line 151 of file KeysAndAttributes.h.

◆ AddAttributesToGet() [2/3]

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

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

Definition at line 159 of file KeysAndAttributes.h.

◆ AddAttributesToGet() [3/3]

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

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

Definition at line 167 of file KeysAndAttributes.h.

◆ AddExpressionAttributeNames() [1/7]

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 483 of file KeysAndAttributes.h.

◆ AddExpressionAttributeNames() [2/7]

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 510 of file KeysAndAttributes.h.

◆ AddExpressionAttributeNames() [3/7]

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 537 of file KeysAndAttributes.h.

◆ AddExpressionAttributeNames() [4/7]

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 564 of file KeysAndAttributes.h.

◆ AddExpressionAttributeNames() [5/7]

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 591 of file KeysAndAttributes.h.

◆ AddExpressionAttributeNames() [6/7]

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 618 of file KeysAndAttributes.h.

◆ AddExpressionAttributeNames() [7/7]

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 645 of file KeysAndAttributes.h.

◆ AddKeys() [1/2]

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

The primary key attribute values that define the items and the attributes associated with the items.

Definition at line 88 of file KeysAndAttributes.h.

◆ AddKeys() [2/2]

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::AddKeys ( Aws::Map< Aws::String, AttributeValue > &&  value)
inline

The primary key attribute values that define the items and the attributes associated with the items.

Definition at line 94 of file KeysAndAttributes.h.

◆ AttributesToGetHasBeenSet()

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

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

Definition at line 111 of file KeysAndAttributes.h.

◆ ConsistentReadHasBeenSet()

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

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

Definition at line 182 of file KeysAndAttributes.h.

◆ ExpressionAttributeNamesHasBeenSet()

bool Aws::DynamoDB::Model::KeysAndAttributes::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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 348 of file KeysAndAttributes.h.

◆ GetAttributesToGet()

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

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

Definition at line 103 of file KeysAndAttributes.h.

◆ GetConsistentRead()

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

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

Definition at line 175 of file KeysAndAttributes.h.

◆ GetExpressionAttributeNames()

const Aws::Map<Aws::String, Aws::String>& Aws::DynamoDB::Model::KeysAndAttributes::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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 321 of file KeysAndAttributes.h.

◆ GetKeys()

const Aws::Vector<Aws::Map<Aws::String, AttributeValue> >& Aws::DynamoDB::Model::KeysAndAttributes::GetKeys ( ) const
inline

The primary key attribute values that define the items and the attributes associated with the items.

Definition at line 52 of file KeysAndAttributes.h.

◆ GetProjectionExpression()

const Aws::String& Aws::DynamoDB::Model::KeysAndAttributes::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 ProjectionExpression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 209 of file KeysAndAttributes.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::DynamoDB::Model::KeysAndAttributes::Jsonize ( ) const

◆ KeysHasBeenSet()

bool Aws::DynamoDB::Model::KeysAndAttributes::KeysHasBeenSet ( ) const
inline

The primary key attribute values that define the items and the attributes associated with the items.

Definition at line 58 of file KeysAndAttributes.h.

◆ operator=()

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ProjectionExpressionHasBeenSet()

bool Aws::DynamoDB::Model::KeysAndAttributes::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 ProjectionExpression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 221 of file KeysAndAttributes.h.

◆ SetAttributesToGet() [1/2]

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

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

Definition at line 119 of file KeysAndAttributes.h.

◆ SetAttributesToGet() [2/2]

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

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

Definition at line 127 of file KeysAndAttributes.h.

◆ SetConsistentRead()

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

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

Definition at line 189 of file KeysAndAttributes.h.

◆ SetExpressionAttributeNames() [1/2]

void Aws::DynamoDB::Model::KeysAndAttributes::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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 375 of file KeysAndAttributes.h.

◆ SetExpressionAttributeNames() [2/2]

void Aws::DynamoDB::Model::KeysAndAttributes::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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 402 of file KeysAndAttributes.h.

◆ SetKeys() [1/2]

void Aws::DynamoDB::Model::KeysAndAttributes::SetKeys ( const Aws::Vector< Aws::Map< Aws::String, AttributeValue >> &  value)
inline

The primary key attribute values that define the items and the attributes associated with the items.

Definition at line 64 of file KeysAndAttributes.h.

◆ SetKeys() [2/2]

void Aws::DynamoDB::Model::KeysAndAttributes::SetKeys ( Aws::Vector< Aws::Map< Aws::String, AttributeValue >> &&  value)
inline

The primary key attribute values that define the items and the attributes associated with the items.

Definition at line 70 of file KeysAndAttributes.h.

◆ SetProjectionExpression() [1/3]

void Aws::DynamoDB::Model::KeysAndAttributes::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 ProjectionExpression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 233 of file KeysAndAttributes.h.

◆ SetProjectionExpression() [2/3]

void Aws::DynamoDB::Model::KeysAndAttributes::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 ProjectionExpression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 245 of file KeysAndAttributes.h.

◆ SetProjectionExpression() [3/3]

void Aws::DynamoDB::Model::KeysAndAttributes::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 ProjectionExpression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 257 of file KeysAndAttributes.h.

◆ WithAttributesToGet() [1/2]

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

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

Definition at line 135 of file KeysAndAttributes.h.

◆ WithAttributesToGet() [2/2]

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

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

Definition at line 143 of file KeysAndAttributes.h.

◆ WithConsistentRead()

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

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

Definition at line 196 of file KeysAndAttributes.h.

◆ WithExpressionAttributeNames() [1/2]

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 429 of file KeysAndAttributes.h.

◆ WithExpressionAttributeNames() [2/2]

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 456 of file KeysAndAttributes.h.

◆ WithKeys() [1/2]

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::WithKeys ( const Aws::Vector< Aws::Map< Aws::String, AttributeValue >> &  value)
inline

The primary key attribute values that define the items and the attributes associated with the items.

Definition at line 76 of file KeysAndAttributes.h.

◆ WithKeys() [2/2]

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::WithKeys ( Aws::Vector< Aws::Map< Aws::String, AttributeValue >> &&  value)
inline

The primary key attribute values that define the items and the attributes associated with the items.

Definition at line 82 of file KeysAndAttributes.h.

◆ WithProjectionExpression() [1/3]

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::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 ProjectionExpression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 269 of file KeysAndAttributes.h.

◆ WithProjectionExpression() [2/3]

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::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 ProjectionExpression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 281 of file KeysAndAttributes.h.

◆ WithProjectionExpression() [3/3]

KeysAndAttributes& Aws::DynamoDB::Model::KeysAndAttributes::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 ProjectionExpression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Definition at line 293 of file KeysAndAttributes.h.


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