Amazonka.CloudDirectory.Types.BatchListIndex

Documentation

data BatchListIndex

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

See: newBatchListIndex smart constructor.

Constructors

BatchListIndex'

Fields

• maxResults :: Maybe Natural

  The maximum number of results to retrieve.

• nextToken :: Maybe Text

  The pagination token.

• rangesOnIndexedValues :: Maybe [ObjectAttributeRange]

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

• indexReference :: ObjectReference

  The reference to the index to list.

Instances

ToJSON BatchListIndex

Defined in Amazonka.CloudDirectory.Types.BatchListIndex

Methods

toJSON :: BatchListIndex -> Value

toEncoding :: BatchListIndex -> Encoding

toJSONList :: [BatchListIndex] -> Value

toEncodingList :: [BatchListIndex] -> Encoding

Generic BatchListIndex

Defined in Amazonka.CloudDirectory.Types.BatchListIndex

Associated Types

type Rep BatchListIndex :: Type -> Type

Methods

from :: BatchListIndex -> Rep BatchListIndex x

to :: Rep BatchListIndex x -> BatchListIndex

Read BatchListIndex

Defined in Amazonka.CloudDirectory.Types.BatchListIndex

Methods

readsPrec :: Int -> ReadS BatchListIndex

readList :: ReadS [BatchListIndex]

readPrec :: ReadPrec BatchListIndex

readListPrec :: ReadPrec [BatchListIndex]

Show BatchListIndex

Defined in Amazonka.CloudDirectory.Types.BatchListIndex

Methods

showsPrec :: Int -> BatchListIndex -> ShowS

show :: BatchListIndex -> String

showList :: [BatchListIndex] -> ShowS

NFData BatchListIndex

Defined in Amazonka.CloudDirectory.Types.BatchListIndex

Methods

rnf :: BatchListIndex -> ()

Eq BatchListIndex

Defined in Amazonka.CloudDirectory.Types.BatchListIndex

Methods

(==) :: BatchListIndex -> BatchListIndex -> Bool

(/=) :: BatchListIndex -> BatchListIndex -> Bool

Hashable BatchListIndex

Defined in Amazonka.CloudDirectory.Types.BatchListIndex

Methods

hashWithSalt :: Int -> BatchListIndex -> Int

hash :: BatchListIndex -> Int

type Rep BatchListIndex

Defined in Amazonka.CloudDirectory.Types.BatchListIndex

type Rep BatchListIndex = D1 ('MetaData "BatchListIndex" "Amazonka.CloudDirectory.Types.BatchListIndex" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "BatchListIndex'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "rangesOnIndexedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ObjectAttributeRange])) :*: S1 ('MetaSel ('Just "indexReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectReference))))

newBatchListIndex

Arguments

:: ObjectReference

$sel:indexReference:BatchListIndex'

-> BatchListIndex

Create a value of BatchListIndex with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:BatchListIndex', batchListIndex_maxResults - The maximum number of results to retrieve.

$sel:nextToken:BatchListIndex', batchListIndex_nextToken - The pagination token.

$sel:rangesOnIndexedValues:BatchListIndex', batchListIndex_rangesOnIndexedValues - Specifies the ranges of indexed values that you want to query.

$sel:indexReference:BatchListIndex', batchListIndex_indexReference - The reference to the index to list.

batchListIndex_maxResults :: Lens' BatchListIndex (Maybe Natural)

The maximum number of results to retrieve.

batchListIndex_nextToken :: Lens' BatchListIndex (Maybe Text)

The pagination token.

batchListIndex_rangesOnIndexedValues :: Lens' BatchListIndex (Maybe [ObjectAttributeRange])

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

batchListIndex_indexReference :: Lens' BatchListIndex ObjectReference

The reference to the index to list.