Class: Aws::DynamoDB::Types::FilterSpecification

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

Overview

Contains the filter criteria used to limit which items are included in an export. If you don't include this parameter, all items and attributes are exported.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#expression_attribute_names ⇒ Hash<String,String>

One or more substitution tokens for attribute names in an expression. For more information, see Expression Attribute Names in the Amazon DynamoDB Developer Guide.

Returns:

  • (Hash<String,String>) 


4087
4088
4089
4090
4091
4092
4093
4094
4095
 
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4087

class FilterSpecification < Struct.new(
  :filter_expression,
  :projection_expression,
  :key_condition_expression,
  :expression_attribute_names,
  :expression_attribute_values)
  SENSITIVE = []
  include Aws::Structure
end

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

One or more values that can be substituted in an expression. For more information, see Expression Attribute Values in the Amazon DynamoDB Developer Guide.

Returns:



4087
4088
4089
4090
4091
4092
4093
4094
4095
 
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4087

class FilterSpecification < Struct.new(
  :filter_expression,
  :projection_expression,
  :key_condition_expression,
  :expression_attribute_names,
  :expression_attribute_values)
  SENSITIVE = []
  include Aws::Structure
end

#filter_expression ⇒ String

A condition that filters which items are included in the export. This parameter uses the same syntax as FilterExpression in Query and Scan. If you don't provide KeyConditionExpression, this expression can also reference key attributes. If you don't specify this parameter, all items are included in the export.

Returns:

  • (String) 


4087
4088
4089
4090
4091
4092
4093
4094
4095
 
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4087

class FilterSpecification < Struct.new(
  :filter_expression,
  :projection_expression,
  :key_condition_expression,
  :expression_attribute_names,
  :expression_attribute_values)
  SENSITIVE = []
  include Aws::Structure
end

#key_condition_expression ⇒ String

A condition expression that filters items by key values. The expression must test equality on a single partition key value and can optionally compare a sort key value. This parameter uses the same syntax as KeyConditionExpression in Query. When you provide this parameter, FilterExpression can only reference non-key attributes. If you don't specify this parameter, all items are eligible for export.

Returns:

  • (String) 


4087
4088
4089
4090
4091
4092
4093
4094
4095
 
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4087

class FilterSpecification < Struct.new(
  :filter_expression,
  :projection_expression,
  :key_condition_expression,
  :expression_attribute_names,
  :expression_attribute_values)
  SENSITIVE = []
  include Aws::Structure
end

#projection_expression ⇒ String

The attributes you want to retrieve for items included in the export. Separate attribute names in the expression with commas. If you don't specify this parameter, all attributes are returned.

Returns:

  • (String) 


4087
4088
4089
4090
4091
4092
4093
4094
4095
 
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4087

class FilterSpecification < Struct.new(
  :filter_expression,
  :projection_expression,
  :key_condition_expression,
  :expression_attribute_names,
  :expression_attribute_values)
  SENSITIVE = []
  include Aws::Structure
end