/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace DynamoDB { namespace Model { /** *

Represents the input of a Scan operation.

See * Also:

AWS * API Reference

*/ class ScanRequest : public DynamoDBRequest { public: AWS_DYNAMODB_API ScanRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "Scan"; } AWS_DYNAMODB_API Aws::String SerializePayload() const override; AWS_DYNAMODB_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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

*/ inline const Aws::String& GetTableName() const{ return m_tableName; } /** *

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

*/ inline bool TableNameHasBeenSet() const { return m_tableNameHasBeenSet; } /** *

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

*/ inline void SetTableName(const Aws::String& value) { m_tableNameHasBeenSet = true; m_tableName = value; } /** *

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

*/ inline void SetTableName(Aws::String&& value) { m_tableNameHasBeenSet = true; m_tableName = std::move(value); } /** *

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

*/ inline void SetTableName(const char* value) { m_tableNameHasBeenSet = true; m_tableName.assign(value); } /** *

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

*/ inline ScanRequest& WithTableName(const Aws::String& value) { SetTableName(value); return *this;} /** *

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

*/ inline ScanRequest& WithTableName(Aws::String&& value) { SetTableName(std::move(value)); return *this;} /** *

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

*/ inline ScanRequest& WithTableName(const char* value) { SetTableName(value); return *this;} /** *

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.

*/ inline const Aws::String& GetIndexName() const{ return m_indexName; } /** *

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.

*/ inline bool IndexNameHasBeenSet() const { return m_indexNameHasBeenSet; } /** *

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.

*/ inline void SetIndexName(const Aws::String& value) { m_indexNameHasBeenSet = true; m_indexName = value; } /** *

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.

*/ inline void SetIndexName(Aws::String&& value) { m_indexNameHasBeenSet = true; m_indexName = std::move(value); } /** *

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.

*/ inline void SetIndexName(const char* value) { m_indexNameHasBeenSet = true; m_indexName.assign(value); } /** *

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.

*/ inline ScanRequest& WithIndexName(const Aws::String& value) { SetIndexName(value); return *this;} /** *

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.

*/ inline ScanRequest& WithIndexName(Aws::String&& value) { SetIndexName(std::move(value)); return *this;} /** *

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.

*/ inline ScanRequest& WithIndexName(const char* value) { SetIndexName(value); return *this;} /** *

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

*/ inline const Aws::Vector& GetAttributesToGet() const{ return m_attributesToGet; } /** *

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

*/ inline bool AttributesToGetHasBeenSet() const { return m_attributesToGetHasBeenSet; } /** *

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

*/ inline void SetAttributesToGet(const Aws::Vector& value) { m_attributesToGetHasBeenSet = true; m_attributesToGet = value; } /** *

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

*/ inline void SetAttributesToGet(Aws::Vector&& value) { m_attributesToGetHasBeenSet = true; m_attributesToGet = std::move(value); } /** *

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

*/ inline ScanRequest& WithAttributesToGet(const Aws::Vector& value) { SetAttributesToGet(value); return *this;} /** *

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

*/ inline ScanRequest& WithAttributesToGet(Aws::Vector&& value) { SetAttributesToGet(std::move(value)); return *this;} /** *

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

*/ inline ScanRequest& AddAttributesToGet(const Aws::String& value) { m_attributesToGetHasBeenSet = true; m_attributesToGet.push_back(value); return *this; } /** *

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

*/ inline ScanRequest& AddAttributesToGet(Aws::String&& value) { m_attributesToGetHasBeenSet = true; m_attributesToGet.push_back(std::move(value)); return *this; } /** *

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

*/ inline ScanRequest& AddAttributesToGet(const char* value) { m_attributesToGetHasBeenSet = true; m_attributesToGet.push_back(value); return *this; } /** *

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.

*/ inline int GetLimit() const{ return m_limit; } /** *

*/ inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; } /** *

*/ inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; } /** *

*/ inline ScanRequest& WithLimit(int value) { SetLimit(value); return *this;} /** *

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. Note that this uses the same quantity of read * capacity units as getting the items, and is subject to the same item size * calculations.
SPECIFIC_ATTRIBUTES - Returns only * the attributes listed in ProjectionExpression. This return value is * equivalent to specifying ProjectionExpression 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 * ProjectionExpression 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 ProjectionExpression together in a * single request, unless the value for Select is * SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying * ProjectionExpression 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.

*/ inline const Select& GetSelect() const{ return m_select; } /** *

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. Note that this uses the same quantity of read * capacity units as getting the items, and is subject to the same item size * calculations.
SPECIFIC_ATTRIBUTES - Returns only * the attributes listed in ProjectionExpression. This return value is * equivalent to specifying ProjectionExpression 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 you use the * ProjectionExpression parameter, then the value for * Select can only be SPECIFIC_ATTRIBUTES. Any other * value for Select will return an error.

*/ inline bool SelectHasBeenSet() const { return m_selectHasBeenSet; } /** *

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. Note that this uses the same quantity of read * capacity units as getting the items, and is subject to the same item size * calculations.
SPECIFIC_ATTRIBUTES - Returns only * the attributes listed in ProjectionExpression. This return value is * equivalent to specifying ProjectionExpression 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 you use the * ProjectionExpression parameter, then the value for * Select can only be SPECIFIC_ATTRIBUTES. Any other * value for Select will return an error.

*/ inline void SetSelect(const Select& value) { m_selectHasBeenSet = true; m_select = value; } /** *

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. Note that this uses the same quantity of read * capacity units as getting the items, and is subject to the same item size * calculations.
SPECIFIC_ATTRIBUTES - Returns only * the attributes listed in ProjectionExpression. This return value is * equivalent to specifying ProjectionExpression 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 you use the * ProjectionExpression parameter, then the value for * Select can only be SPECIFIC_ATTRIBUTES. Any other * value for Select will return an error.

*/ inline void SetSelect(Select&& value) { m_selectHasBeenSet = true; m_select = std::move(value); } /** *

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. Note that this uses the same quantity of read * capacity units as getting the items, and is subject to the same item size * calculations.
SPECIFIC_ATTRIBUTES - Returns only * the attributes listed in ProjectionExpression. This return value is * equivalent to specifying ProjectionExpression 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 you use the * ProjectionExpression parameter, then the value for * Select can only be SPECIFIC_ATTRIBUTES. Any other * value for Select will return an error.

*/ inline ScanRequest& WithSelect(const Select& value) { SetSelect(value); return *this;} /** *

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. Note that this uses the same quantity of read * capacity units as getting the items, and is subject to the same item size * calculations.
SPECIFIC_ATTRIBUTES - Returns only * the attributes listed in ProjectionExpression. This return value is * equivalent to specifying ProjectionExpression 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 you use the * ProjectionExpression parameter, then the value for * Select can only be SPECIFIC_ATTRIBUTES. Any other * value for Select will return an error.

*/ inline ScanRequest& WithSelect(Select&& value) { SetSelect(std::move(value)); return *this;} /** *

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

*/ inline const Aws::Map& GetScanFilter() const{ return m_scanFilter; } /** *

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

*/ inline bool ScanFilterHasBeenSet() const { return m_scanFilterHasBeenSet; } /** *

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

*/ inline void SetScanFilter(const Aws::Map& value) { m_scanFilterHasBeenSet = true; m_scanFilter = value; } /** *

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

*/ inline void SetScanFilter(Aws::Map&& value) { m_scanFilterHasBeenSet = true; m_scanFilter = std::move(value); } /** *

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

*/ inline ScanRequest& WithScanFilter(const Aws::Map& value) { SetScanFilter(value); return *this;} /** *

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

*/ inline ScanRequest& WithScanFilter(Aws::Map&& value) { SetScanFilter(std::move(value)); return *this;} /** *

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

*/ inline ScanRequest& AddScanFilter(const Aws::String& key, const Condition& value) { m_scanFilterHasBeenSet = true; m_scanFilter.emplace(key, value); return *this; } /** *

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

*/ inline ScanRequest& AddScanFilter(Aws::String&& key, const Condition& value) { m_scanFilterHasBeenSet = true; m_scanFilter.emplace(std::move(key), value); return *this; } /** *

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

*/ inline ScanRequest& AddScanFilter(const Aws::String& key, Condition&& value) { m_scanFilterHasBeenSet = true; m_scanFilter.emplace(key, std::move(value)); return *this; } /** *

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

*/ inline ScanRequest& AddScanFilter(Aws::String&& key, Condition&& value) { m_scanFilterHasBeenSet = true; m_scanFilter.emplace(std::move(key), std::move(value)); return *this; } /** *

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

*/ inline ScanRequest& AddScanFilter(const char* key, Condition&& value) { m_scanFilterHasBeenSet = true; m_scanFilter.emplace(key, std::move(value)); return *this; } /** *

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

*/ inline ScanRequest& AddScanFilter(const char* key, const Condition& value) { m_scanFilterHasBeenSet = true; m_scanFilter.emplace(key, value); return *this; } /** *

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

*/ inline const ConditionalOperator& GetConditionalOperator() const{ return m_conditionalOperator; } /** *

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

*/ inline bool ConditionalOperatorHasBeenSet() const { return m_conditionalOperatorHasBeenSet; } /** *

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

*/ inline void SetConditionalOperator(const ConditionalOperator& value) { m_conditionalOperatorHasBeenSet = true; m_conditionalOperator = value; } /** *

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

*/ inline void SetConditionalOperator(ConditionalOperator&& value) { m_conditionalOperatorHasBeenSet = true; m_conditionalOperator = std::move(value); } /** *

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

*/ inline ScanRequest& WithConditionalOperator(const ConditionalOperator& value) { SetConditionalOperator(value); return *this;} /** *

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

*/ inline ScanRequest& WithConditionalOperator(ConditionalOperator&& value) { SetConditionalOperator(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Map& GetExclusiveStartKey() const{ return m_exclusiveStartKey; } /** *

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.

*/ inline bool ExclusiveStartKeyHasBeenSet() const { return m_exclusiveStartKeyHasBeenSet; } /** *

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.

*/ inline void SetExclusiveStartKey(const Aws::Map& value) { m_exclusiveStartKeyHasBeenSet = true; m_exclusiveStartKey = value; } /** *

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.

*/ inline void SetExclusiveStartKey(Aws::Map&& value) { m_exclusiveStartKeyHasBeenSet = true; m_exclusiveStartKey = std::move(value); } /** *

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.

*/ inline ScanRequest& WithExclusiveStartKey(const Aws::Map& value) { SetExclusiveStartKey(value); return *this;} /** *

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.

*/ inline ScanRequest& WithExclusiveStartKey(Aws::Map&& value) { SetExclusiveStartKey(std::move(value)); return *this;} /** *

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.

*/ inline ScanRequest& AddExclusiveStartKey(const Aws::String& key, const AttributeValue& value) { m_exclusiveStartKeyHasBeenSet = true; m_exclusiveStartKey.emplace(key, value); return *this; } /** *

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.

*/ inline ScanRequest& AddExclusiveStartKey(Aws::String&& key, const AttributeValue& value) { m_exclusiveStartKeyHasBeenSet = true; m_exclusiveStartKey.emplace(std::move(key), value); return *this; } /** *

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.

*/ inline ScanRequest& AddExclusiveStartKey(const Aws::String& key, AttributeValue&& value) { m_exclusiveStartKeyHasBeenSet = true; m_exclusiveStartKey.emplace(key, std::move(value)); return *this; } /** *

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.

*/ inline ScanRequest& AddExclusiveStartKey(Aws::String&& key, AttributeValue&& value) { m_exclusiveStartKeyHasBeenSet = true; m_exclusiveStartKey.emplace(std::move(key), std::move(value)); return *this; } /** *

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.

*/ inline ScanRequest& AddExclusiveStartKey(const char* key, AttributeValue&& value) { m_exclusiveStartKeyHasBeenSet = true; m_exclusiveStartKey.emplace(key, std::move(value)); return *this; } /** *

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.

*/ inline ScanRequest& AddExclusiveStartKey(const char* key, const AttributeValue& value) { m_exclusiveStartKeyHasBeenSet = true; m_exclusiveStartKey.emplace(key, value); return *this; } inline const ReturnConsumedCapacity& GetReturnConsumedCapacity() const{ return m_returnConsumedCapacity; } inline bool ReturnConsumedCapacityHasBeenSet() const { return m_returnConsumedCapacityHasBeenSet; } inline void SetReturnConsumedCapacity(const ReturnConsumedCapacity& value) { m_returnConsumedCapacityHasBeenSet = true; m_returnConsumedCapacity = value; } inline void SetReturnConsumedCapacity(ReturnConsumedCapacity&& value) { m_returnConsumedCapacityHasBeenSet = true; m_returnConsumedCapacity = std::move(value); } inline ScanRequest& WithReturnConsumedCapacity(const ReturnConsumedCapacity& value) { SetReturnConsumedCapacity(value); return *this;} inline ScanRequest& WithReturnConsumedCapacity(ReturnConsumedCapacity&& value) { SetReturnConsumedCapacity(std::move(value)); return *this;} /** *

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.

*/ inline int GetTotalSegments() const{ return m_totalSegments; } /** *

If * you specify TotalSegments, you must also specify * Segment.

*/ inline bool TotalSegmentsHasBeenSet() const { return m_totalSegmentsHasBeenSet; } /** *

If * you specify TotalSegments, you must also specify * Segment.

*/ inline void SetTotalSegments(int value) { m_totalSegmentsHasBeenSet = true; m_totalSegments = value; } /** *

If * you specify TotalSegments, you must also specify * Segment.

*/ inline ScanRequest& WithTotalSegments(int value) { SetTotalSegments(value); return *this;} /** *

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.

*/ inline int GetSegment() const{ return m_segment; } /** *

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

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.

*/ inline bool SegmentHasBeenSet() const { return m_segmentHasBeenSet; } /** *

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

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.

*/ inline void SetSegment(int value) { m_segmentHasBeenSet = true; m_segment = value; } /** *

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

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.

*/ inline ScanRequest& WithSegment(int value) { SetSegment(value); return *this;} /** *

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.

*/ inline const Aws::String& GetProjectionExpression() const{ return m_projectionExpression; } /** *

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.

*/ inline bool ProjectionExpressionHasBeenSet() const { return m_projectionExpressionHasBeenSet; } /** *

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.

*/ inline void SetProjectionExpression(const Aws::String& value) { m_projectionExpressionHasBeenSet = true; m_projectionExpression = value; } /** *

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.

*/ inline void SetProjectionExpression(Aws::String&& value) { m_projectionExpressionHasBeenSet = true; m_projectionExpression = std::move(value); } /** *

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.

*/ inline void SetProjectionExpression(const char* value) { m_projectionExpressionHasBeenSet = true; m_projectionExpression.assign(value); } /** *

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.

*/ inline ScanRequest& WithProjectionExpression(const Aws::String& value) { SetProjectionExpression(value); return *this;} /** *

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.

*/ inline ScanRequest& WithProjectionExpression(Aws::String&& value) { SetProjectionExpression(std::move(value)); return *this;} /** *

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.

*/ inline ScanRequest& WithProjectionExpression(const char* value) { SetProjectionExpression(value); return *this;} /** *

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.

*/ inline const Aws::String& GetFilterExpression() const{ return m_filterExpression; } /** *

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.

*/ inline bool FilterExpressionHasBeenSet() const { return m_filterExpressionHasBeenSet; } /** *

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.

*/ inline void SetFilterExpression(const Aws::String& value) { m_filterExpressionHasBeenSet = true; m_filterExpression = value; } /** *

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.

*/ inline void SetFilterExpression(Aws::String&& value) { m_filterExpressionHasBeenSet = true; m_filterExpression = std::move(value); } /** *

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.

*/ inline void SetFilterExpression(const char* value) { m_filterExpressionHasBeenSet = true; m_filterExpression.assign(value); } /** *

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.

*/ inline ScanRequest& WithFilterExpression(const Aws::String& value) { SetFilterExpression(value); return *this;} /** *

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.

*/ inline ScanRequest& WithFilterExpression(Aws::String&& value) { SetFilterExpression(std::move(value)); return *this;} /** *

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.

*/ inline ScanRequest& WithFilterExpression(const char* value) { SetFilterExpression(value); return *this;} /** *

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.

*/ inline const Aws::Map& GetExpressionAttributeNames() const{ return m_expressionAttributeNames; } /** *

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 *

{"#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.

*/ inline bool ExpressionAttributeNamesHasBeenSet() const { return m_expressionAttributeNamesHasBeenSet; } /** *

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 *

{"#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.

*/ inline void SetExpressionAttributeNames(const Aws::Map& value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames = value; } /** *

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 *

{"#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.

*/ inline void SetExpressionAttributeNames(Aws::Map&& value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames = std::move(value); } /** *

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 *

{"#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.

*/ inline ScanRequest& WithExpressionAttributeNames(const Aws::Map& value) { SetExpressionAttributeNames(value); return *this;} /** *

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 *

{"#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.

*/ inline ScanRequest& WithExpressionAttributeNames(Aws::Map&& value) { SetExpressionAttributeNames(std::move(value)); return *this;} /** *

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 *

{"#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.

*/ inline ScanRequest& AddExpressionAttributeNames(const Aws::String& key, const Aws::String& value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(key, value); return *this; } /** *

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 *

{"#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.

*/ inline ScanRequest& AddExpressionAttributeNames(Aws::String&& key, const Aws::String& value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(std::move(key), value); return *this; } /** *

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 *

{"#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.

*/ inline ScanRequest& AddExpressionAttributeNames(const Aws::String& key, Aws::String&& value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(key, std::move(value)); return *this; } /** *

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 *

{"#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.

*/ inline ScanRequest& AddExpressionAttributeNames(Aws::String&& key, Aws::String&& value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(std::move(key), std::move(value)); return *this; } /** *

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 *

{"#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.

*/ inline ScanRequest& AddExpressionAttributeNames(const char* key, Aws::String&& value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(key, std::move(value)); return *this; } /** *

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 *

{"#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.

*/ inline ScanRequest& AddExpressionAttributeNames(Aws::String&& key, const char* value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(std::move(key), value); return *this; } /** *

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 *

{"#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.

*/ inline ScanRequest& AddExpressionAttributeNames(const char* key, const char* value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(key, value); return *this; } /** *

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.

*/ inline const Aws::Map& GetExpressionAttributeValues() const{ return m_expressionAttributeValues; } /** *

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

* 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.

*/ inline bool ExpressionAttributeValuesHasBeenSet() const { return m_expressionAttributeValuesHasBeenSet; } /** *

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

* 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.

*/ inline void SetExpressionAttributeValues(const Aws::Map& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues = value; } /** *

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

* 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.

*/ inline void SetExpressionAttributeValues(Aws::Map&& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues = std::move(value); } /** *

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

* 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.

*/ inline ScanRequest& WithExpressionAttributeValues(const Aws::Map& value) { SetExpressionAttributeValues(value); return *this;} /** *

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

* 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.

*/ inline ScanRequest& WithExpressionAttributeValues(Aws::Map&& value) { SetExpressionAttributeValues(std::move(value)); return *this;} /** *

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

* 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.

*/ inline ScanRequest& AddExpressionAttributeValues(const Aws::String& key, const AttributeValue& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues.emplace(key, value); return *this; } /** *

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

* 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.

*/ inline ScanRequest& AddExpressionAttributeValues(Aws::String&& key, const AttributeValue& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues.emplace(std::move(key), value); return *this; } /** *

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

* 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.

*/ inline ScanRequest& AddExpressionAttributeValues(const Aws::String& key, AttributeValue&& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues.emplace(key, std::move(value)); return *this; } /** *

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

* 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.

*/ inline ScanRequest& AddExpressionAttributeValues(Aws::String&& key, AttributeValue&& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues.emplace(std::move(key), std::move(value)); return *this; } /** *

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

* 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.

*/ inline ScanRequest& AddExpressionAttributeValues(const char* key, AttributeValue&& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues.emplace(key, std::move(value)); return *this; } /** *

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

* 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.

*/ inline ScanRequest& AddExpressionAttributeValues(const char* key, const AttributeValue& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues.emplace(key, value); return *this; } /** *

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.

*/ inline bool GetConsistentRead() const{ return m_consistentRead; } /** *

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.

*/ inline bool ConsistentReadHasBeenSet() const { return m_consistentReadHasBeenSet; } /** *

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.

*/ inline void SetConsistentRead(bool value) { m_consistentReadHasBeenSet = true; m_consistentRead = value; } /** *

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.

*/ inline ScanRequest& WithConsistentRead(bool value) { SetConsistentRead(value); return *this;} private: Aws::String m_tableName; bool m_tableNameHasBeenSet = false; Aws::String m_indexName; bool m_indexNameHasBeenSet = false; Aws::Vector m_attributesToGet; bool m_attributesToGetHasBeenSet = false; int m_limit; bool m_limitHasBeenSet = false; Select m_select; bool m_selectHasBeenSet = false; Aws::Map m_scanFilter; bool m_scanFilterHasBeenSet = false; ConditionalOperator m_conditionalOperator; bool m_conditionalOperatorHasBeenSet = false; Aws::Map m_exclusiveStartKey; bool m_exclusiveStartKeyHasBeenSet = false; ReturnConsumedCapacity m_returnConsumedCapacity; bool m_returnConsumedCapacityHasBeenSet = false; int m_totalSegments; bool m_totalSegmentsHasBeenSet = false; int m_segment; bool m_segmentHasBeenSet = false; Aws::String m_projectionExpression; bool m_projectionExpressionHasBeenSet = false; Aws::String m_filterExpression; bool m_filterExpressionHasBeenSet = false; Aws::Map m_expressionAttributeNames; bool m_expressionAttributeNamesHasBeenSet = false; Aws::Map m_expressionAttributeValues; bool m_expressionAttributeValuesHasBeenSet = false; bool m_consistentRead; bool m_consistentReadHasBeenSet = false; }; } // namespace Model } // namespace DynamoDB } // namespace Aws