Class: Aws::DynamoDB::Types::KeysAndAttributes

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-dynamodb/types.rb

Overview

Note:

When making an API call, you may pass KeysAndAttributes data as a hash:

{
  keys: [ # required
    {
      "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
    },
  ],
  attributes_to_get: ["AttributeName"],
  consistent_read: false,
  projection_expression: "ProjectionExpression",
  expression_attribute_names: {
    "ExpressionAttributeNameVariable" => "AttributeName",
  },
}

Represents a set of primary keys and, for each key, the attributes to retrieve from the table.

For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key. For a composite primary key, you must provide both the partition key and the sort key.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attributes_to_get ⇒ Array<String>

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

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html

Returns:

  • (Array<String>) 


3835
3836
3837
3838
3839
3840
3841
3842
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 3835

class KeysAndAttributes < Struct.new(
  :keys,
  :attributes_to_get,
  :consistent_read,
  :projection_expression,
  :expression_attribute_names)
  include Aws::Structure
end

#consistent_read ⇒ Boolean

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

Returns:

  • (Boolean) 


3835
3836
3837
3838
3839
3840
3841
3842
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 3835

class KeysAndAttributes < Struct.new(
  :keys,
  :attributes_to_get,
  :consistent_read,
  :projection_expression,
  :expression_attribute_names)
  include Aws::Structure
end

#expression_attribute_names ⇒ Hash<String,String>

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`

^

<note markdown=“1”> Tokens that begin with the : character are *expression attribute values*, which are placeholders for the actual value at runtime.

</note>

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

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html

Returns:

  • (Hash<String,String>) 


3835
3836
3837
3838
3839
3840
3841
3842
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 3835

class KeysAndAttributes < Struct.new(
  :keys,
  :attributes_to_get,
  :consistent_read,
  :projection_expression,
  :expression_attribute_names)
  include Aws::Structure
end

#keys ⇒ Array<Hash<String,Types::AttributeValue>>

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

Returns:



3835
3836
3837
3838
3839
3840
3841
3842
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 3835

class KeysAndAttributes < Struct.new(
  :keys,
  :attributes_to_get,
  :consistent_read,
  :projection_expression,
  :expression_attribute_names)
  include Aws::Structure
end

#projection_expression ⇒ String

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ‘ProjectionExpression` must be separated by commas.

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

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

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html

Returns:

  • (String) 


3835
3836
3837
3838
3839
3840
3841
3842
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 3835

class KeysAndAttributes < Struct.new(
  :keys,
  :attributes_to_get,
  :consistent_read,
  :projection_expression,
  :expression_attribute_names)
  include Aws::Structure
end