AttributesToGet => ArrayRef[Str]

This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

ConditionalOperator => Str

A logical operator to apply to the conditions in a ScanFilter map:

• "AND" - If all of the conditions evaluate to true, then the entire map evaluates to true.
• "OR" - If at least one of the conditions evaluate to true, then the entire map evaluates to true.

If you omit ConditionalOperator, then "AND" is the default.

The operation will succeed only if the entire map evaluates to true.

This parameter does not support attributes of type List or Map.

ConsistentRead => Bool

• If ConsistentRead is "false", then Scan will use eventually consistent reads. The data returned from Scan might not contain the results of other recently completed write operations (PutItem, UpdateItem or DeleteItem). The Scan response might include some stale data.
• If ConsistentRead is "true", then Scan will use strongly consistent reads. 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", meaning that eventually consistent reads will be used.

Strongly consistent reads are not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

ExclusiveStartKey => Paws::DynamoDB::Key

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.

ExpressionAttributeNames => Paws::DynamoDB::ExpressionAttributeNameMap

• 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 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:

•

"{""

You could then use this substitution in an expression, as in this example:

•

""

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

ExpressionAttributeValues => Paws::DynamoDB::ExpressionAttributeValueMap

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 Specifying Conditions in the Amazon DynamoDB Developer Guide.

FilterExpression => Str

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.

FilterExpression replaces the legacy ScanFilter and ConditionalOperator parameters.

IndexName => Str

Limit => Int

ProjectionExpression => Str

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

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

ProjectionExpression replaces the legacy AttributesToGet parameter.

ReturnConsumedCapacity => Str

ScanFilter => Paws::DynamoDB::FilterConditionMap

A condition that evaluates the scan results and returns only the desired values.

This parameter does not support attributes of type List or Map.

If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

Each ScanFilter element consists of an attribute name to compare, along with the following:

• AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .

  For type Number, value comparisons are numeric.

  String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, "a" is greater than "A", and "a" is greater than "B". For a list of code values, see http://en.wikipedia.org/wiki/ASCII

  For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

  For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

• ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.

  The following comparison operators are available:

  "EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN"

  For complete descriptions of all comparison operators, see Condition.

Segment => Int

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.

Select => Str

• "ALL_ATTRIBUTES" - Returns all of the item 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 neither Select nor AttributesToGet are specified, DynamoDB defaults to "ALL_ATTRIBUTES". You cannot use both AttributesToGet and Select 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.)

REQUIRED TableName => Str

TotalSegments => Int

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.