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

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

Overview

Note:

When making an API call, you may pass Get data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#expression_attribute_namesHash<String,String>

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

Returns:

  • (Hash<String,String>)


4179
4180
4181
4182
4183
4184
4185
4186
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4179

class Get < Struct.new(
  :key,
  :table_name,
  :projection_expression,
  :expression_attribute_names)
  SENSITIVE = []
  include Aws::Structure
end

#keyHash<String,Types::AttributeValue>

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

Returns:



4179
4180
4181
4182
4183
4184
4185
4186
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4179

class Get < Struct.new(
  :key,
  :table_name,
  :projection_expression,
  :expression_attribute_names)
  SENSITIVE = []
  include Aws::Structure
end

#projection_expressionString

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)


4179
4180
4181
4182
4183
4184
4185
4186
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4179

class Get < Struct.new(
  :key,
  :table_name,
  :projection_expression,
  :expression_attribute_names)
  SENSITIVE = []
  include Aws::Structure
end

#table_nameString

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

Returns:

  • (String)


4179
4180
4181
4182
4183
4184
4185
4186
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4179

class Get < Struct.new(
  :key,
  :table_name,
  :projection_expression,
  :expression_attribute_names)
  SENSITIVE = []
  include Aws::Structure
end