class Aws::CloudDirectory::Types::BatchListIndex

Lists objects attached to the specified index inside a BatchRead operation. For more information, see ListIndex and BatchReadRequest$Operations.

@note When making an API call, you may pass BatchListIndex

data as a hash:

    {
      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",
    }

@!attribute [rw] ranges_on_indexed_values

Specifies the ranges of indexed values that you want to query.
@return [Array<Types::ObjectAttributeRange>]

@!attribute [rw] index_reference

The reference to the index to list.
@return [Types::ObjectReference]

@!attribute [rw] max_results

The maximum number of results to retrieve.
@return [Integer]

@!attribute [rw] next_token

The pagination token.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/BatchListIndex AWS API Documentation

Constants

SENSITIVE