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

Class: Aws::CloudDirectory::Types::ListIndexRequest

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

Overview

Note:

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

Instance Attribute Details

#consistency_levelString

The consistency level to execute the request at.

Returns:

  • (String)


4887
4888
4889
4890
4891
4892
4893
4894
4895
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4887

class ListIndexRequest < Struct.new(
  :directory_arn,
  :ranges_on_indexed_values,
  :index_reference,
  :max_results,
  :next_token,
  :consistency_level)
  include Aws::Structure
end

#directory_arnString

The ARN of the directory that the index exists in.

Returns:

  • (String)


4887
4888
4889
4890
4891
4892
4893
4894
4895
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4887

class ListIndexRequest < Struct.new(
  :directory_arn,
  :ranges_on_indexed_values,
  :index_reference,
  :max_results,
  :next_token,
  :consistency_level)
  include Aws::Structure
end

#index_referenceTypes::ObjectReference

The reference to the index to list.



4887
4888
4889
4890
4891
4892
4893
4894
4895
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4887

class ListIndexRequest < Struct.new(
  :directory_arn,
  :ranges_on_indexed_values,
  :index_reference,
  :max_results,
  :next_token,
  :consistency_level)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of objects in a single page to retrieve from the index during a request. For more information, see AWS Directory Service Limits.

Returns:

  • (Integer)


4887
4888
4889
4890
4891
4892
4893
4894
4895
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4887

class ListIndexRequest < Struct.new(
  :directory_arn,
  :ranges_on_indexed_values,
  :index_reference,
  :max_results,
  :next_token,
  :consistency_level)
  include Aws::Structure
end

#next_tokenString

The pagination token.

Returns:

  • (String)


4887
4888
4889
4890
4891
4892
4893
4894
4895
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4887

class ListIndexRequest < Struct.new(
  :directory_arn,
  :ranges_on_indexed_values,
  :index_reference,
  :max_results,
  :next_token,
  :consistency_level)
  include Aws::Structure
end

#ranges_on_indexed_valuesArray<Types::ObjectAttributeRange>

Specifies the ranges of indexed values that you want to query.

Returns:



4887
4888
4889
4890
4891
4892
4893
4894
4895
# File 'gems/aws-sdk-clouddirectory/lib/aws-sdk-clouddirectory/types.rb', line 4887

class ListIndexRequest < Struct.new(
  :directory_arn,
  :ranges_on_indexed_values,
  :index_reference,
  :max_results,
  :next_token,
  :consistency_level)
  include Aws::Structure
end