You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudDirectory::Types::ListIndexRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudDirectory::Types::ListIndexRequest
- Defined in:
- (unknown)
Overview
When passing ListIndexRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
directory_arn: "Arn", # required
ranges_on_indexed_values: [
{
attribute_key: {
schema_arn: "Arn", # required
facet_name: "FacetName", # required
name: "AttributeName", # required
},
range: {
start_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
start_value: {
string_value: "StringAttributeValue",
binary_value: "data",
boolean_value: false,
number_value: "NumberAttributeValue",
datetime_value: Time.now,
},
end_mode: "FIRST", # required, accepts FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
end_value: {
string_value: "StringAttributeValue",
binary_value: "data",
boolean_value: false,
number_value: "NumberAttributeValue",
datetime_value: Time.now,
},
},
},
],
index_reference: { # required
selector: "SelectorObjectReference",
},
max_results: 1,
next_token: "NextToken",
consistency_level: "SERIALIZABLE", # accepts SERIALIZABLE, EVENTUAL
}
Instance Attribute Summary collapse
-
#consistency_level ⇒ String
The consistency level to execute the request at.
-
#directory_arn ⇒ String
The ARN of the directory that the index exists in.
-
#index_reference ⇒ Types::ObjectReference
The reference to the index to list.
-
#max_results ⇒ Integer
The maximum number of objects in a single page to retrieve from the index during a request.
-
#next_token ⇒ String
The pagination token.
-
#ranges_on_indexed_values ⇒ Array<Types::ObjectAttributeRange>
Specifies the ranges of indexed values that you want to query.
Instance Attribute Details
#consistency_level ⇒ String
The consistency level to execute the request at.
Possible values:
- SERIALIZABLE
- EVENTUAL
#directory_arn ⇒ String
The ARN of the directory that the index exists in.
#index_reference ⇒ Types::ObjectReference
The reference to the index to list.
#max_results ⇒ Integer
The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits.
#next_token ⇒ String
The pagination token.
#ranges_on_indexed_values ⇒ Array<Types::ObjectAttributeRange>
Specifies the ranges of indexed values that you want to query.