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

#include <ScanRequest.h>

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

Public Member Functions

 ScanRequest ()
 
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)
 
ScanRequestWithTableName (const Aws::String &value)
 
ScanRequestWithTableName (Aws::String &&value)
 
ScanRequestWithTableName (const char *value)
 
const Aws::StringGetIndexName () const
 
bool IndexNameHasBeenSet () const
 
void SetIndexName (const Aws::String &value)
 
void SetIndexName (Aws::String &&value)
 
void SetIndexName (const char *value)
 
ScanRequestWithIndexName (const Aws::String &value)
 
ScanRequestWithIndexName (Aws::String &&value)
 
ScanRequestWithIndexName (const char *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)
 
ScanRequestWithAttributesToGet (const Aws::Vector< Aws::String > &value)
 
ScanRequestWithAttributesToGet (Aws::Vector< Aws::String > &&value)
 
ScanRequestAddAttributesToGet (const Aws::String &value)
 
ScanRequestAddAttributesToGet (Aws::String &&value)
 
ScanRequestAddAttributesToGet (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
ScanRequestWithLimit (int value)
 
const SelectGetSelect () const
 
bool SelectHasBeenSet () const
 
void SetSelect (const Select &value)
 
void SetSelect (Select &&value)
 
ScanRequestWithSelect (const Select &value)
 
ScanRequestWithSelect (Select &&value)
 
const Aws::Map< Aws::String, Condition > & GetScanFilter () const
 
bool ScanFilterHasBeenSet () const
 
void SetScanFilter (const Aws::Map< Aws::String, Condition > &value)
 
void SetScanFilter (Aws::Map< Aws::String, Condition > &&value)
 
ScanRequestWithScanFilter (const Aws::Map< Aws::String, Condition > &value)
 
ScanRequestWithScanFilter (Aws::Map< Aws::String, Condition > &&value)
 
ScanRequestAddScanFilter (const Aws::String &key, const Condition &value)
 
ScanRequestAddScanFilter (Aws::String &&key, const Condition &value)
 
ScanRequestAddScanFilter (const Aws::String &key, Condition &&value)
 
ScanRequestAddScanFilter (Aws::String &&key, Condition &&value)
 
ScanRequestAddScanFilter (const char *key, Condition &&value)
 
ScanRequestAddScanFilter (const char *key, const Condition &value)
 
const ConditionalOperatorGetConditionalOperator () const
 
bool ConditionalOperatorHasBeenSet () const
 
void SetConditionalOperator (const ConditionalOperator &value)
 
void SetConditionalOperator (ConditionalOperator &&value)
 
ScanRequestWithConditionalOperator (const ConditionalOperator &value)
 
ScanRequestWithConditionalOperator (ConditionalOperator &&value)
 
const Aws::Map< Aws::String, AttributeValue > & GetExclusiveStartKey () const
 
bool ExclusiveStartKeyHasBeenSet () const
 
void SetExclusiveStartKey (const Aws::Map< Aws::String, AttributeValue > &value)
 
void SetExclusiveStartKey (Aws::Map< Aws::String, AttributeValue > &&value)
 
ScanRequestWithExclusiveStartKey (const Aws::Map< Aws::String, AttributeValue > &value)
 
ScanRequestWithExclusiveStartKey (Aws::Map< Aws::String, AttributeValue > &&value)
 
ScanRequestAddExclusiveStartKey (const Aws::String &key, const AttributeValue &value)
 
ScanRequestAddExclusiveStartKey (Aws::String &&key, const AttributeValue &value)
 
ScanRequestAddExclusiveStartKey (const Aws::String &key, AttributeValue &&value)
 
ScanRequestAddExclusiveStartKey (Aws::String &&key, AttributeValue &&value)
 
ScanRequestAddExclusiveStartKey (const char *key, AttributeValue &&value)
 
ScanRequestAddExclusiveStartKey (const char *key, const AttributeValue &value)
 
const ReturnConsumedCapacityGetReturnConsumedCapacity () const
 
bool ReturnConsumedCapacityHasBeenSet () const
 
void SetReturnConsumedCapacity (const ReturnConsumedCapacity &value)
 
void SetReturnConsumedCapacity (ReturnConsumedCapacity &&value)
 
ScanRequestWithReturnConsumedCapacity (const ReturnConsumedCapacity &value)
 
ScanRequestWithReturnConsumedCapacity (ReturnConsumedCapacity &&value)
 
int GetTotalSegments () const
 
bool TotalSegmentsHasBeenSet () const
 
void SetTotalSegments (int value)
 
ScanRequestWithTotalSegments (int value)
 
int GetSegment () const
 
bool SegmentHasBeenSet () const
 
void SetSegment (int value)
 
ScanRequestWithSegment (int value)
 
const Aws::StringGetProjectionExpression () const
 
bool ProjectionExpressionHasBeenSet () const
 
void SetProjectionExpression (const Aws::String &value)
 
void SetProjectionExpression (Aws::String &&value)
 
void SetProjectionExpression (const char *value)
 
ScanRequestWithProjectionExpression (const Aws::String &value)
 
ScanRequestWithProjectionExpression (Aws::String &&value)
 
ScanRequestWithProjectionExpression (const char *value)
 
const Aws::StringGetFilterExpression () const
 
bool FilterExpressionHasBeenSet () const
 
void SetFilterExpression (const Aws::String &value)
 
void SetFilterExpression (Aws::String &&value)
 
void SetFilterExpression (const char *value)
 
ScanRequestWithFilterExpression (const Aws::String &value)
 
ScanRequestWithFilterExpression (Aws::String &&value)
 
ScanRequestWithFilterExpression (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)
 
ScanRequestWithExpressionAttributeNames (const Aws::Map< Aws::String, Aws::String > &value)
 
ScanRequestWithExpressionAttributeNames (Aws::Map< Aws::String, Aws::String > &&value)
 
ScanRequestAddExpressionAttributeNames (const Aws::String &key, const Aws::String &value)
 
ScanRequestAddExpressionAttributeNames (Aws::String &&key, const Aws::String &value)
 
ScanRequestAddExpressionAttributeNames (const Aws::String &key, Aws::String &&value)
 
ScanRequestAddExpressionAttributeNames (Aws::String &&key, Aws::String &&value)
 
ScanRequestAddExpressionAttributeNames (const char *key, Aws::String &&value)
 
ScanRequestAddExpressionAttributeNames (Aws::String &&key, const char *value)
 
ScanRequestAddExpressionAttributeNames (const char *key, const char *value)
 
const Aws::Map< Aws::String, AttributeValue > & GetExpressionAttributeValues () const
 
bool ExpressionAttributeValuesHasBeenSet () const
 
void SetExpressionAttributeValues (const Aws::Map< Aws::String, AttributeValue > &value)
 
void SetExpressionAttributeValues (Aws::Map< Aws::String, AttributeValue > &&value)
 
ScanRequestWithExpressionAttributeValues (const Aws::Map< Aws::String, AttributeValue > &value)
 
ScanRequestWithExpressionAttributeValues (Aws::Map< Aws::String, AttributeValue > &&value)
 
ScanRequestAddExpressionAttributeValues (const Aws::String &key, const AttributeValue &value)
 
ScanRequestAddExpressionAttributeValues (Aws::String &&key, const AttributeValue &value)
 
ScanRequestAddExpressionAttributeValues (const Aws::String &key, AttributeValue &&value)
 
ScanRequestAddExpressionAttributeValues (Aws::String &&key, AttributeValue &&value)
 
ScanRequestAddExpressionAttributeValues (const char *key, AttributeValue &&value)
 
ScanRequestAddExpressionAttributeValues (const char *key, const AttributeValue &value)
 
bool GetConsistentRead () const
 
bool ConsistentReadHasBeenSet () const
 
void SetConsistentRead (bool value)
 
ScanRequestWithConsistentRead (bool 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 Scan operation.

See Also:

AWS API Reference

Definition at line 32 of file ScanRequest.h.

Constructor & Destructor Documentation

◆ ScanRequest()

Aws::DynamoDB::Model::ScanRequest::ScanRequest ( )

Member Function Documentation

◆ AddAttributesToGet() [1/3]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::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 208 of file ScanRequest.h.

◆ AddAttributesToGet() [2/3]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::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 216 of file ScanRequest.h.

◆ AddAttributesToGet() [3/3]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::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 224 of file ScanRequest.h.

◆ AddExclusiveStartKey() [1/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddExclusiveStartKey ( const Aws::String key,
const AttributeValue value 
)
inline

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

Definition at line 744 of file ScanRequest.h.

◆ AddExclusiveStartKey() [2/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddExclusiveStartKey ( Aws::String &&  key,
const AttributeValue value 
)
inline

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

Definition at line 755 of file ScanRequest.h.

◆ AddExclusiveStartKey() [3/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddExclusiveStartKey ( const Aws::String key,
AttributeValue &&  value 
)
inline

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

Definition at line 766 of file ScanRequest.h.

◆ AddExclusiveStartKey() [4/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddExclusiveStartKey ( Aws::String &&  key,
AttributeValue &&  value 
)
inline

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

Definition at line 777 of file ScanRequest.h.

◆ AddExclusiveStartKey() [5/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddExclusiveStartKey ( const char *  key,
AttributeValue &&  value 
)
inline

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

Definition at line 788 of file ScanRequest.h.

◆ AddExclusiveStartKey() [6/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddExclusiveStartKey ( const char *  key,
const AttributeValue value 
)
inline

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

Definition at line 799 of file ScanRequest.h.

◆ AddExpressionAttributeNames() [1/7]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::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 1328 of file ScanRequest.h.

◆ AddExpressionAttributeNames() [2/7]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::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 1355 of file ScanRequest.h.

◆ AddExpressionAttributeNames() [3/7]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::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 1382 of file ScanRequest.h.

◆ AddExpressionAttributeNames() [4/7]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::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 1409 of file ScanRequest.h.

◆ AddExpressionAttributeNames() [5/7]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::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 1436 of file ScanRequest.h.

◆ AddExpressionAttributeNames() [6/7]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::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 1463 of file ScanRequest.h.

◆ AddExpressionAttributeNames() [7/7]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::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 1490 of file ScanRequest.h.

◆ AddExpressionAttributeValues() [1/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddExpressionAttributeValues ( const Aws::String key,
const AttributeValue value 
)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1610 of file ScanRequest.h.

◆ AddExpressionAttributeValues() [2/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddExpressionAttributeValues ( Aws::String &&  key,
const AttributeValue value 
)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1627 of file ScanRequest.h.

◆ AddExpressionAttributeValues() [3/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddExpressionAttributeValues ( const Aws::String key,
AttributeValue &&  value 
)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1644 of file ScanRequest.h.

◆ AddExpressionAttributeValues() [4/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddExpressionAttributeValues ( Aws::String &&  key,
AttributeValue &&  value 
)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1661 of file ScanRequest.h.

◆ AddExpressionAttributeValues() [5/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddExpressionAttributeValues ( const char *  key,
AttributeValue &&  value 
)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1678 of file ScanRequest.h.

◆ AddExpressionAttributeValues() [6/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddExpressionAttributeValues ( const char *  key,
const AttributeValue value 
)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1695 of file ScanRequest.h.

◆ AddScanFilter() [1/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddScanFilter ( const Aws::String key,
const Condition value 
)
inline

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

Definition at line 577 of file ScanRequest.h.

◆ AddScanFilter() [2/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddScanFilter ( Aws::String &&  key,
const Condition value 
)
inline

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

Definition at line 585 of file ScanRequest.h.

◆ AddScanFilter() [3/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddScanFilter ( const Aws::String key,
Condition &&  value 
)
inline

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

Definition at line 593 of file ScanRequest.h.

◆ AddScanFilter() [4/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddScanFilter ( Aws::String &&  key,
Condition &&  value 
)
inline

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

Definition at line 601 of file ScanRequest.h.

◆ AddScanFilter() [5/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddScanFilter ( const char *  key,
Condition &&  value 
)
inline

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

Definition at line 609 of file ScanRequest.h.

◆ AddScanFilter() [6/6]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::AddScanFilter ( const char *  key,
const Condition value 
)
inline

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

Definition at line 617 of file ScanRequest.h.

◆ AttributesToGetHasBeenSet()

bool Aws::DynamoDB::Model::ScanRequest::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 168 of file ScanRequest.h.

◆ ConditionalOperatorHasBeenSet()

bool Aws::DynamoDB::Model::ScanRequest::ConditionalOperatorHasBeenSet ( ) const
inline

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

Definition at line 634 of file ScanRequest.h.

◆ ConsistentReadHasBeenSet()

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

A Boolean value that determines the read consistency model during the scan:

  • If ConsistentRead is false, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem, or DeleteItem).

  • If ConsistentRead is true, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.

The default setting for ConsistentRead is false.

The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

Definition at line 1728 of file ScanRequest.h.

◆ ExclusiveStartKeyHasBeenSet()

bool Aws::DynamoDB::Model::ScanRequest::ExclusiveStartKeyHasBeenSet ( ) const
inline

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

Definition at line 689 of file ScanRequest.h.

◆ ExpressionAttributeNamesHasBeenSet()

bool Aws::DynamoDB::Model::ScanRequest::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 1193 of file ScanRequest.h.

◆ ExpressionAttributeValuesHasBeenSet()

bool Aws::DynamoDB::Model::ScanRequest::ExpressionAttributeValuesHasBeenSet ( ) const
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1525 of file ScanRequest.h.

◆ FilterExpressionHasBeenSet()

bool Aws::DynamoDB::Model::ScanRequest::FilterExpressionHasBeenSet ( ) const
inline

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1066 of file ScanRequest.h.

◆ GetAttributesToGet()

const Aws::Vector<Aws::String>& Aws::DynamoDB::Model::ScanRequest::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 160 of file ScanRequest.h.

◆ GetConditionalOperator()

const ConditionalOperator& Aws::DynamoDB::Model::ScanRequest::GetConditionalOperator ( ) const
inline

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

Definition at line 626 of file ScanRequest.h.

◆ GetConsistentRead()

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

A Boolean value that determines the read consistency model during the scan:

  • If ConsistentRead is false, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem, or DeleteItem).

  • If ConsistentRead is true, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.

The default setting for ConsistentRead is false.

The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

Definition at line 1712 of file ScanRequest.h.

◆ GetExclusiveStartKey()

const Aws::Map<Aws::String, AttributeValue>& Aws::DynamoDB::Model::ScanRequest::GetExclusiveStartKey ( ) const
inline

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

Definition at line 678 of file ScanRequest.h.

◆ GetExpressionAttributeNames()

const Aws::Map<Aws::String, Aws::String>& Aws::DynamoDB::Model::ScanRequest::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 1166 of file ScanRequest.h.

◆ GetExpressionAttributeValues()

const Aws::Map<Aws::String, AttributeValue>& Aws::DynamoDB::Model::ScanRequest::GetExpressionAttributeValues ( ) const
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1508 of file ScanRequest.h.

◆ GetFilterExpression()

const Aws::String& Aws::DynamoDB::Model::ScanRequest::GetFilterExpression ( ) const
inline

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1054 of file ScanRequest.h.

◆ GetIndexName()

const Aws::String& Aws::DynamoDB::Model::ScanRequest::GetIndexName ( ) const
inline

The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.

Definition at line 102 of file ScanRequest.h.

◆ GetLimit()

int Aws::DynamoDB::Model::ScanRequest::GetLimit ( ) const
inline

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Working with Queries in the Amazon DynamoDB Developer Guide.

Definition at line 240 of file ScanRequest.h.

◆ GetProjectionExpression()

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

A string that identifies one or more attributes to retrieve from the specified table or index. 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 will be returned. If any of the requested attributes are not found, they will not appear in the result.

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

Definition at line 957 of file ScanRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::DynamoDB::DynamoDBRequest.

◆ GetReturnConsumedCapacity()

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

Definition at line 803 of file ScanRequest.h.

◆ GetScanFilter()

const Aws::Map<Aws::String, Condition>& Aws::DynamoDB::Model::ScanRequest::GetScanFilter ( ) const
inline

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

Definition at line 529 of file ScanRequest.h.

◆ GetSegment()

int Aws::DynamoDB::Model::ScanRequest::GetSegment ( ) const
inline

For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.

The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.

The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.

If you provide Segment, you must also provide TotalSegments.

Definition at line 896 of file ScanRequest.h.

◆ GetSelect()

const Select& Aws::DynamoDB::Model::ScanRequest::GetSelect ( ) const
inline

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

  • ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

  • ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

  • COUNT - Returns the number of matching items, rather than the matching items themselves.

  • SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.

    If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

Definition at line 325 of file ScanRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 41 of file ScanRequest.h.

◆ GetTableName()

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

The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs.

Definition at line 52 of file ScanRequest.h.

◆ GetTotalSegments()

int Aws::DynamoDB::Model::ScanRequest::GetTotalSegments ( ) const
inline

For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.

The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.

If you specify TotalSegments, you must also specify Segment.

Definition at line 834 of file ScanRequest.h.

◆ IndexNameHasBeenSet()

bool Aws::DynamoDB::Model::ScanRequest::IndexNameHasBeenSet ( ) const
inline

The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.

Definition at line 109 of file ScanRequest.h.

◆ LimitHasBeenSet()

bool Aws::DynamoDB::Model::ScanRequest::LimitHasBeenSet ( ) const
inline

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Working with Queries in the Amazon DynamoDB Developer Guide.

Definition at line 255 of file ScanRequest.h.

◆ ProjectionExpressionHasBeenSet()

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

A string that identifies one or more attributes to retrieve from the specified table or index. 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 will be returned. If any of the requested attributes are not found, they will not appear in the result.

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

Definition at line 969 of file ScanRequest.h.

◆ ReturnConsumedCapacityHasBeenSet()

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

Definition at line 806 of file ScanRequest.h.

◆ ScanFilterHasBeenSet()

bool Aws::DynamoDB::Model::ScanRequest::ScanFilterHasBeenSet ( ) const
inline

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

Definition at line 537 of file ScanRequest.h.

◆ SegmentHasBeenSet()

bool Aws::DynamoDB::Model::ScanRequest::SegmentHasBeenSet ( ) const
inline

For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.

The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.

The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.

If you provide Segment, you must also provide TotalSegments.

Definition at line 912 of file ScanRequest.h.

◆ SelectHasBeenSet()

bool Aws::DynamoDB::Model::ScanRequest::SelectHasBeenSet ( ) const
inline

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

  • ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

  • ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

  • COUNT - Returns the number of matching items, rather than the matching items themselves.

  • SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.

    If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

Definition at line 364 of file ScanRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAttributesToGet() [1/2]

void Aws::DynamoDB::Model::ScanRequest::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 176 of file ScanRequest.h.

◆ SetAttributesToGet() [2/2]

void Aws::DynamoDB::Model::ScanRequest::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 184 of file ScanRequest.h.

◆ SetConditionalOperator() [1/2]

void Aws::DynamoDB::Model::ScanRequest::SetConditionalOperator ( const ConditionalOperator value)
inline

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

Definition at line 642 of file ScanRequest.h.

◆ SetConditionalOperator() [2/2]

void Aws::DynamoDB::Model::ScanRequest::SetConditionalOperator ( ConditionalOperator &&  value)
inline

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

Definition at line 650 of file ScanRequest.h.

◆ SetConsistentRead()

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

A Boolean value that determines the read consistency model during the scan:

  • If ConsistentRead is false, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem, or DeleteItem).

  • If ConsistentRead is true, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.

The default setting for ConsistentRead is false.

The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

Definition at line 1744 of file ScanRequest.h.

◆ SetExclusiveStartKey() [1/2]

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

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

Definition at line 700 of file ScanRequest.h.

◆ SetExclusiveStartKey() [2/2]

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

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

Definition at line 711 of file ScanRequest.h.

◆ SetExpressionAttributeNames() [1/2]

void Aws::DynamoDB::Model::ScanRequest::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 1220 of file ScanRequest.h.

◆ SetExpressionAttributeNames() [2/2]

void Aws::DynamoDB::Model::ScanRequest::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 1247 of file ScanRequest.h.

◆ SetExpressionAttributeValues() [1/2]

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

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1542 of file ScanRequest.h.

◆ SetExpressionAttributeValues() [2/2]

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

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1559 of file ScanRequest.h.

◆ SetFilterExpression() [1/3]

void Aws::DynamoDB::Model::ScanRequest::SetFilterExpression ( const Aws::String value)
inline

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1078 of file ScanRequest.h.

◆ SetFilterExpression() [2/3]

void Aws::DynamoDB::Model::ScanRequest::SetFilterExpression ( Aws::String &&  value)
inline

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1090 of file ScanRequest.h.

◆ SetFilterExpression() [3/3]

void Aws::DynamoDB::Model::ScanRequest::SetFilterExpression ( const char *  value)
inline

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1102 of file ScanRequest.h.

◆ SetIndexName() [1/3]

void Aws::DynamoDB::Model::ScanRequest::SetIndexName ( const Aws::String value)
inline

The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.

Definition at line 116 of file ScanRequest.h.

◆ SetIndexName() [2/3]

void Aws::DynamoDB::Model::ScanRequest::SetIndexName ( Aws::String &&  value)
inline

The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.

Definition at line 123 of file ScanRequest.h.

◆ SetIndexName() [3/3]

void Aws::DynamoDB::Model::ScanRequest::SetIndexName ( const char *  value)
inline

The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.

Definition at line 130 of file ScanRequest.h.

◆ SetLimit()

void Aws::DynamoDB::Model::ScanRequest::SetLimit ( int  value)
inline

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Working with Queries in the Amazon DynamoDB Developer Guide.

Definition at line 270 of file ScanRequest.h.

◆ SetProjectionExpression() [1/3]

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

A string that identifies one or more attributes to retrieve from the specified table or index. 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 will be returned. If any of the requested attributes are not found, they will not appear in the result.

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

Definition at line 981 of file ScanRequest.h.

◆ SetProjectionExpression() [2/3]

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

A string that identifies one or more attributes to retrieve from the specified table or index. 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 will be returned. If any of the requested attributes are not found, they will not appear in the result.

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

Definition at line 993 of file ScanRequest.h.

◆ SetProjectionExpression() [3/3]

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

A string that identifies one or more attributes to retrieve from the specified table or index. 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 will be returned. If any of the requested attributes are not found, they will not appear in the result.

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

Definition at line 1005 of file ScanRequest.h.

◆ SetReturnConsumedCapacity() [1/2]

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

Definition at line 809 of file ScanRequest.h.

◆ SetReturnConsumedCapacity() [2/2]

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

Definition at line 812 of file ScanRequest.h.

◆ SetScanFilter() [1/2]

void Aws::DynamoDB::Model::ScanRequest::SetScanFilter ( const Aws::Map< Aws::String, Condition > &  value)
inline

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

Definition at line 545 of file ScanRequest.h.

◆ SetScanFilter() [2/2]

void Aws::DynamoDB::Model::ScanRequest::SetScanFilter ( Aws::Map< Aws::String, Condition > &&  value)
inline

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

Definition at line 553 of file ScanRequest.h.

◆ SetSegment()

void Aws::DynamoDB::Model::ScanRequest::SetSegment ( int  value)
inline

For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.

The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.

The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.

If you provide Segment, you must also provide TotalSegments.

Definition at line 928 of file ScanRequest.h.

◆ SetSelect() [1/2]

void Aws::DynamoDB::Model::ScanRequest::SetSelect ( const Select value)
inline

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

  • ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

  • ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

  • COUNT - Returns the number of matching items, rather than the matching items themselves.

  • SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.

    If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

Definition at line 403 of file ScanRequest.h.

◆ SetSelect() [2/2]

void Aws::DynamoDB::Model::ScanRequest::SetSelect ( Select &&  value)
inline

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

  • ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

  • ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

  • COUNT - Returns the number of matching items, rather than the matching items themselves.

  • SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.

    If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

Definition at line 442 of file ScanRequest.h.

◆ SetTableName() [1/3]

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

The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs.

Definition at line 64 of file ScanRequest.h.

◆ SetTableName() [2/3]

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

The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs.

Definition at line 70 of file ScanRequest.h.

◆ SetTableName() [3/3]

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

The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs.

Definition at line 76 of file ScanRequest.h.

◆ SetTotalSegments()

void Aws::DynamoDB::Model::ScanRequest::SetTotalSegments ( int  value)
inline

For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.

The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.

If you specify TotalSegments, you must also specify Segment.

Definition at line 864 of file ScanRequest.h.

◆ TableNameHasBeenSet()

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

The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs.

Definition at line 58 of file ScanRequest.h.

◆ TotalSegmentsHasBeenSet()

bool Aws::DynamoDB::Model::ScanRequest::TotalSegmentsHasBeenSet ( ) const
inline

For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.

The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.

If you specify TotalSegments, you must also specify Segment.

Definition at line 849 of file ScanRequest.h.

◆ WithAttributesToGet() [1/2]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::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 192 of file ScanRequest.h.

◆ WithAttributesToGet() [2/2]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::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 200 of file ScanRequest.h.

◆ WithConditionalOperator() [1/2]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithConditionalOperator ( const ConditionalOperator value)
inline

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

Definition at line 658 of file ScanRequest.h.

◆ WithConditionalOperator() [2/2]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithConditionalOperator ( ConditionalOperator &&  value)
inline

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

Definition at line 666 of file ScanRequest.h.

◆ WithConsistentRead()

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

A Boolean value that determines the read consistency model during the scan:

  • If ConsistentRead is false, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem, or DeleteItem).

  • If ConsistentRead is true, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.

The default setting for ConsistentRead is false.

The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

Definition at line 1760 of file ScanRequest.h.

◆ WithExclusiveStartKey() [1/2]

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

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

Definition at line 722 of file ScanRequest.h.

◆ WithExclusiveStartKey() [2/2]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithExclusiveStartKey ( Aws::Map< Aws::String, AttributeValue > &&  value)
inline

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

Definition at line 733 of file ScanRequest.h.

◆ WithExpressionAttributeNames() [1/2]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::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 1274 of file ScanRequest.h.

◆ WithExpressionAttributeNames() [2/2]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::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 1301 of file ScanRequest.h.

◆ WithExpressionAttributeValues() [1/2]

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

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1576 of file ScanRequest.h.

◆ WithExpressionAttributeValues() [2/2]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithExpressionAttributeValues ( Aws::Map< Aws::String, AttributeValue > &&  value)
inline

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1593 of file ScanRequest.h.

◆ WithFilterExpression() [1/3]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithFilterExpression ( const Aws::String value)
inline

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1114 of file ScanRequest.h.

◆ WithFilterExpression() [2/3]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithFilterExpression ( Aws::String &&  value)
inline

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1126 of file ScanRequest.h.

◆ WithFilterExpression() [3/3]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithFilterExpression ( const char *  value)
inline

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

Definition at line 1138 of file ScanRequest.h.

◆ WithIndexName() [1/3]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithIndexName ( const Aws::String value)
inline

The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.

Definition at line 137 of file ScanRequest.h.

◆ WithIndexName() [2/3]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithIndexName ( Aws::String &&  value)
inline

The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.

Definition at line 144 of file ScanRequest.h.

◆ WithIndexName() [3/3]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithIndexName ( const char *  value)
inline

The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.

Definition at line 151 of file ScanRequest.h.

◆ WithLimit()

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithLimit ( int  value)
inline

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Working with Queries in the Amazon DynamoDB Developer Guide.

Definition at line 285 of file ScanRequest.h.

◆ WithProjectionExpression() [1/3]

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

A string that identifies one or more attributes to retrieve from the specified table or index. 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 will be returned. If any of the requested attributes are not found, they will not appear in the result.

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

Definition at line 1017 of file ScanRequest.h.

◆ WithProjectionExpression() [2/3]

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

A string that identifies one or more attributes to retrieve from the specified table or index. 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 will be returned. If any of the requested attributes are not found, they will not appear in the result.

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

Definition at line 1029 of file ScanRequest.h.

◆ WithProjectionExpression() [3/3]

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

A string that identifies one or more attributes to retrieve from the specified table or index. 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 will be returned. If any of the requested attributes are not found, they will not appear in the result.

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

Definition at line 1041 of file ScanRequest.h.

◆ WithReturnConsumedCapacity() [1/2]

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

Definition at line 815 of file ScanRequest.h.

◆ WithReturnConsumedCapacity() [2/2]

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

Definition at line 818 of file ScanRequest.h.

◆ WithScanFilter() [1/2]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithScanFilter ( const Aws::Map< Aws::String, Condition > &  value)
inline

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

Definition at line 561 of file ScanRequest.h.

◆ WithScanFilter() [2/2]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithScanFilter ( Aws::Map< Aws::String, Condition > &&  value)
inline

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

Definition at line 569 of file ScanRequest.h.

◆ WithSegment()

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithSegment ( int  value)
inline

For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.

The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.

The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.

If you provide Segment, you must also provide TotalSegments.

Definition at line 944 of file ScanRequest.h.

◆ WithSelect() [1/2]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithSelect ( const Select value)
inline

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

  • ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

  • ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

  • COUNT - Returns the number of matching items, rather than the matching items themselves.

  • SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.

    If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

Definition at line 481 of file ScanRequest.h.

◆ WithSelect() [2/2]

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithSelect ( Select &&  value)
inline

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

  • ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

  • ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

  • COUNT - Returns the number of matching items, rather than the matching items themselves.

  • SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.

    If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

Definition at line 520 of file ScanRequest.h.

◆ WithTableName() [1/3]

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

The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs.

Definition at line 82 of file ScanRequest.h.

◆ WithTableName() [2/3]

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

The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs.

Definition at line 88 of file ScanRequest.h.

◆ WithTableName() [3/3]

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

The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs.

Definition at line 94 of file ScanRequest.h.

◆ WithTotalSegments()

ScanRequest& Aws::DynamoDB::Model::ScanRequest::WithTotalSegments ( int  value)
inline

For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.

The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.

If you specify TotalSegments, you must also specify Segment.

Definition at line 879 of file ScanRequest.h.


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