You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DynamoDB::Types::Get

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Get as input to an Aws::Client method, you can use a vanilla Hash:

{
  key: { # required
    "AttributeName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  table_name: "TableName", # required
  projection_expression: "ProjectionExpression",
  expression_attribute_names: {
    "ExpressionAttributeNameVariable" => "AttributeName",
  },
}

Specifies an item and related attribute values to retrieve in a TransactGetItem object.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#expression_attribute_names ⇒ Hash<String,String>

One or more substitution tokens for attribute names in the ProjectionExpression parameter.

Returns:

  • (Hash<String,String>) —

    One or more substitution tokens for attribute names in the ProjectionExpression parameter.

#key ⇒ Hash<String,Types::AttributeValue>

A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve.

Returns:

  • (Hash<String,Types::AttributeValue>) —

    A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve.

#projection_expression ⇒ String

A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result.

Returns:

  • (String) —

    A string that identifies one or more attributes of the specified item to retrieve from the table.

#table_name ⇒ String

The name of the table from which to retrieve the specified item.

Returns:

  • (String) —

    The name of the table from which to retrieve the specified item.