Network.AWS.CloudDirectory.ListIndex

Lists objects attached to the specified index.

This operation returns paginated results.

Creating a Request

listIndex

Arguments

:: Text

liDirectoryARN

-> ObjectReference

liIndexReference

-> ListIndex

Creates a value of ListIndex with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• liRangesOnIndexedValues - Specifies the ranges of indexed values that you want to query.
• liConsistencyLevel - The consistency level to execute the request at.
• liNextToken - The pagination token.
• liMaxResults - 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 .
• liDirectoryARN - The ARN of the directory that the index exists in.
• liIndexReference - The reference to the index to list.

data ListIndex

See: listIndex smart constructor.

Instances

Eq ListIndex

Methods

(==) :: ListIndex -> ListIndex -> Bool

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

Data ListIndex

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListIndex -> c ListIndex

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListIndex

toConstr :: ListIndex -> Constr

dataTypeOf :: ListIndex -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListIndex)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListIndex)

gmapT :: (forall b. Data b => b -> b) -> ListIndex -> ListIndex

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListIndex -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListIndex -> r

gmapQ :: (forall d. Data d => d -> u) -> ListIndex -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListIndex -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListIndex -> m ListIndex

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListIndex -> m ListIndex

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListIndex -> m ListIndex

Read ListIndex

Methods

readsPrec :: Int -> ReadS ListIndex

readList :: ReadS [ListIndex]

readPrec :: ReadPrec ListIndex

readListPrec :: ReadPrec [ListIndex]

Show ListIndex

Methods

showsPrec :: Int -> ListIndex -> ShowS

show :: ListIndex -> String

showList :: [ListIndex] -> ShowS

Generic ListIndex

Associated Types

type Rep ListIndex :: * -> *

Methods

from :: ListIndex -> Rep ListIndex x

to :: Rep ListIndex x -> ListIndex

Hashable ListIndex

Methods

hashWithSalt :: Int -> ListIndex -> Int

hash :: ListIndex -> Int

ToJSON ListIndex

Methods

toJSON :: ListIndex -> Value

toEncoding :: ListIndex -> Encoding

toJSONList :: [ListIndex] -> Value

toEncodingList :: [ListIndex] -> Encoding

NFData ListIndex

Methods

rnf :: ListIndex -> ()

AWSPager ListIndex

Methods

page :: ListIndex -> Rs ListIndex -> Maybe ListIndex

AWSRequest ListIndex

Associated Types

type Rs ListIndex :: *

Methods

request :: ListIndex -> Request ListIndex

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListIndex -> ClientResponse -> m (Response ListIndex)

ToHeaders ListIndex

Methods

toHeaders :: ListIndex -> [Header]

ToPath ListIndex

Methods

toPath :: ListIndex -> ByteString

ToQuery ListIndex

Methods

toQuery :: ListIndex -> QueryString

type Rep ListIndex

type Rep ListIndex = D1 * (MetaData "ListIndex" "Network.AWS.CloudDirectory.ListIndex" "amazonka-clouddirectory-1.6.0-8IFjLCYNMx175Dinq6Lqlq" False) (C1 * (MetaCons "ListIndex'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_liRangesOnIndexedValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ObjectAttributeRange]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_liConsistencyLevel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ConsistencyLevel))) (S1 * (MetaSel (Just Symbol "_liNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_liMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) ((:*:) * (S1 * (MetaSel (Just Symbol "_liDirectoryARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_liIndexReference") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ObjectReference))))))

type Rs ListIndex

type Rs ListIndex = ListIndexResponse

Request Lenses

liRangesOnIndexedValues :: Lens' ListIndex [ObjectAttributeRange]

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

liConsistencyLevel :: Lens' ListIndex (Maybe ConsistencyLevel)

The consistency level to execute the request at.

liNextToken :: Lens' ListIndex (Maybe Text)

The pagination token.

liMaxResults :: Lens' ListIndex (Maybe Natural)

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 .

liDirectoryARN :: Lens' ListIndex Text

The ARN of the directory that the index exists in.

liIndexReference :: Lens' ListIndex ObjectReference

The reference to the index to list.

Destructuring the Response

listIndexResponse

Arguments

:: Int

lirsResponseStatus

-> ListIndexResponse

Creates a value of ListIndexResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lirsIndexAttachments - The objects and indexed values attached to the index.
• lirsNextToken - The pagination token.
• lirsResponseStatus - -- | The response status code.

data ListIndexResponse

See: listIndexResponse smart constructor.

Instances

Eq ListIndexResponse

Methods

(==) :: ListIndexResponse -> ListIndexResponse -> Bool

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

Data ListIndexResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListIndexResponse -> c ListIndexResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListIndexResponse

toConstr :: ListIndexResponse -> Constr

dataTypeOf :: ListIndexResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListIndexResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListIndexResponse)

gmapT :: (forall b. Data b => b -> b) -> ListIndexResponse -> ListIndexResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListIndexResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListIndexResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListIndexResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListIndexResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListIndexResponse -> m ListIndexResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListIndexResponse -> m ListIndexResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListIndexResponse -> m ListIndexResponse

Read ListIndexResponse

Methods

readsPrec :: Int -> ReadS ListIndexResponse

readList :: ReadS [ListIndexResponse]

readPrec :: ReadPrec ListIndexResponse

readListPrec :: ReadPrec [ListIndexResponse]

Show ListIndexResponse

Methods

showsPrec :: Int -> ListIndexResponse -> ShowS

show :: ListIndexResponse -> String

showList :: [ListIndexResponse] -> ShowS

Generic ListIndexResponse

Associated Types

type Rep ListIndexResponse :: * -> *

Methods

from :: ListIndexResponse -> Rep ListIndexResponse x

to :: Rep ListIndexResponse x -> ListIndexResponse

NFData ListIndexResponse

Methods

rnf :: ListIndexResponse -> ()

type Rep ListIndexResponse

type Rep ListIndexResponse = D1 * (MetaData "ListIndexResponse" "Network.AWS.CloudDirectory.ListIndex" "amazonka-clouddirectory-1.6.0-8IFjLCYNMx175Dinq6Lqlq" False) (C1 * (MetaCons "ListIndexResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lirsIndexAttachments") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [IndexAttachment]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lirsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lirsIndexAttachments :: Lens' ListIndexResponse [IndexAttachment]

The objects and indexed values attached to the index.

lirsNextToken :: Lens' ListIndexResponse (Maybe Text)

The pagination token.

lirsResponseStatus :: Lens' ListIndexResponse Int

• - | The response status code.