Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudDirectory.ListIndex

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists objects attached to the specified index.

This operation returns paginated results.

Synopsis

data ListIndex = ListIndex' {
- consistencyLevel :: Maybe ConsistencyLevel
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- rangesOnIndexedValues :: Maybe [ObjectAttributeRange]
- directoryArn :: Text
- indexReference :: ObjectReference
}
newListIndex :: Text -> ObjectReference -> ListIndex
listIndex_consistencyLevel :: Lens' ListIndex (Maybe ConsistencyLevel)
listIndex_maxResults :: Lens' ListIndex (Maybe Natural)
listIndex_nextToken :: Lens' ListIndex (Maybe Text)
listIndex_rangesOnIndexedValues :: Lens' ListIndex (Maybe [ObjectAttributeRange])
listIndex_directoryArn :: Lens' ListIndex Text
listIndex_indexReference :: Lens' ListIndex ObjectReference
data ListIndexResponse = ListIndexResponse' {
- indexAttachments :: Maybe [IndexAttachment]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListIndexResponse :: Int -> ListIndexResponse
listIndexResponse_indexAttachments :: Lens' ListIndexResponse (Maybe [IndexAttachment])
listIndexResponse_nextToken :: Lens' ListIndexResponse (Maybe Text)
listIndexResponse_httpStatus :: Lens' ListIndexResponse Int

Creating a Request

data ListIndex Source #

See: newListIndex smart constructor.

Constructors

ListIndex'

Fields

consistencyLevel :: Maybe ConsistencyLevel
The consistency level to execute the request at.
maxResults :: Maybe Natural
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.
nextToken :: Maybe Text
The pagination token.
rangesOnIndexedValues :: Maybe [ObjectAttributeRange]
Specifies the ranges of indexed values that you want to query.
directoryArn :: Text
The ARN of the directory that the index exists in.
indexReference :: ObjectReference
The reference to the index to list.

Instances

Instances details

ToJSON ListIndex Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Methods toJSON :: ListIndex -> Value # toEncoding :: ListIndex -> Encoding # toJSONList :: [ListIndex] -> Value # toEncodingList :: [ListIndex] -> Encoding #
ToHeaders ListIndex Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Methods toHeaders :: ListIndex -> [Header] #
ToPath ListIndex Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Methods toPath :: ListIndex -> ByteString #
ToQuery ListIndex Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Methods toQuery :: ListIndex -> QueryString #
AWSPager ListIndex Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Methods page :: ListIndex -> AWSResponse ListIndex -> Maybe ListIndex #
AWSRequest ListIndex Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Associated Types type AWSResponse ListIndex # Methods request :: (Service -> Service) -> ListIndex -> Request ListIndex # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListIndex -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListIndex))) #
Generic ListIndex Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Associated Types type Rep ListIndex :: Type -> Type # Methods from :: ListIndex -> Rep ListIndex x # to :: Rep ListIndex x -> ListIndex #
Read ListIndex Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Methods readsPrec :: Int -> ReadS ListIndex # readList :: ReadS [ListIndex] # readPrec :: ReadPrec ListIndex # readListPrec :: ReadPrec [ListIndex] #
Show ListIndex Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Methods showsPrec :: Int -> ListIndex -> ShowS # show :: ListIndex -> String # showList :: [ListIndex] -> ShowS #
NFData ListIndex Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Methods rnf :: ListIndex -> () #
Eq ListIndex Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Methods (==) :: ListIndex -> ListIndex -> Bool # (/=) :: ListIndex -> ListIndex -> Bool #
Hashable ListIndex Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Methods hashWithSalt :: Int -> ListIndex -> Int # hash :: ListIndex -> Int #
type AWSResponse ListIndex Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex type AWSResponse ListIndex = ListIndexResponse
type Rep ListIndex Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex type Rep ListIndex = D1 ('MetaData "ListIndex" "Amazonka.CloudDirectory.ListIndex" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListIndex'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "consistencyLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConsistencyLevel)) :: (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 "directoryArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectReference)))))

newListIndex Source #

Arguments

:: Text	`ListIndex`
-> ObjectReference	`ListIndex`
-> ListIndex

Create a value of ListIndex 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:consistencyLevel:ListIndex', listIndex_consistencyLevel - The consistency level to execute the request at.

ListIndex, listIndex_maxResults - 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.

ListIndex, listIndex_nextToken - The pagination token.

ListIndex, listIndex_rangesOnIndexedValues - Specifies the ranges of indexed values that you want to query.

ListIndex, listIndex_directoryArn - The ARN of the directory that the index exists in.

ListIndex, listIndex_indexReference - The reference to the index to list.

Request Lenses

listIndex_consistencyLevel :: Lens' ListIndex (Maybe ConsistencyLevel) Source #

The consistency level to execute the request at.

listIndex_maxResults :: Lens' ListIndex (Maybe Natural) Source #

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.

listIndex_nextToken :: Lens' ListIndex (Maybe Text) Source #

The pagination token.

listIndex_rangesOnIndexedValues :: Lens' ListIndex (Maybe [ObjectAttributeRange]) Source #

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

listIndex_directoryArn :: Lens' ListIndex Text Source #

The ARN of the directory that the index exists in.

listIndex_indexReference :: Lens' ListIndex ObjectReference Source #

The reference to the index to list.

Destructuring the Response

data ListIndexResponse Source #

See: newListIndexResponse smart constructor.

Constructors

ListIndexResponse'
Fields indexAttachments :: Maybe [IndexAttachment] The objects and indexed values attached to the index. nextToken :: Maybe Text The pagination token. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListIndexResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Associated Types type Rep ListIndexResponse :: Type -> Type # Methods from :: ListIndexResponse -> Rep ListIndexResponse x # to :: Rep ListIndexResponse x -> ListIndexResponse #
Read ListIndexResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Methods readsPrec :: Int -> ReadS ListIndexResponse # readList :: ReadS [ListIndexResponse] # readPrec :: ReadPrec ListIndexResponse # readListPrec :: ReadPrec [ListIndexResponse] #
Show ListIndexResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Methods showsPrec :: Int -> ListIndexResponse -> ShowS # show :: ListIndexResponse -> String # showList :: [ListIndexResponse] -> ShowS #
NFData ListIndexResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Methods rnf :: ListIndexResponse -> () #
Eq ListIndexResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex Methods (==) :: ListIndexResponse -> ListIndexResponse -> Bool # (/=) :: ListIndexResponse -> ListIndexResponse -> Bool #
type Rep ListIndexResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListIndex type Rep ListIndexResponse = D1 ('MetaData "ListIndexResponse" "Amazonka.CloudDirectory.ListIndex" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListIndexResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IndexAttachment])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListIndexResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListIndexResponse'`
-> ListIndexResponse

Create a value of ListIndexResponse 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:

ListIndexResponse, listIndexResponse_indexAttachments - The objects and indexed values attached to the index.

ListIndex, listIndexResponse_nextToken - The pagination token.

$sel:httpStatus:ListIndexResponse', listIndexResponse_httpStatus - The response's http status code.

Response Lenses

listIndexResponse_indexAttachments :: Lens' ListIndexResponse (Maybe [IndexAttachment]) Source #

The objects and indexed values attached to the index.

listIndexResponse_nextToken :: Lens' ListIndexResponse (Maybe Text) Source #

The pagination token.

listIndexResponse_httpStatus :: Lens' ListIndexResponse Int Source #

The response's http status code.