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.ListAttachedIndices

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists indices attached to the specified object.

This operation returns paginated results.

Synopsis

data ListAttachedIndices = ListAttachedIndices' {
- consistencyLevel :: Maybe ConsistencyLevel
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- directoryArn :: Text
- targetReference :: ObjectReference
}
newListAttachedIndices :: Text -> ObjectReference -> ListAttachedIndices
listAttachedIndices_consistencyLevel :: Lens' ListAttachedIndices (Maybe ConsistencyLevel)
listAttachedIndices_maxResults :: Lens' ListAttachedIndices (Maybe Natural)
listAttachedIndices_nextToken :: Lens' ListAttachedIndices (Maybe Text)
listAttachedIndices_directoryArn :: Lens' ListAttachedIndices Text
listAttachedIndices_targetReference :: Lens' ListAttachedIndices ObjectReference
data ListAttachedIndicesResponse = ListAttachedIndicesResponse' {
- indexAttachments :: Maybe [IndexAttachment]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListAttachedIndicesResponse :: Int -> ListAttachedIndicesResponse
listAttachedIndicesResponse_indexAttachments :: Lens' ListAttachedIndicesResponse (Maybe [IndexAttachment])
listAttachedIndicesResponse_nextToken :: Lens' ListAttachedIndicesResponse (Maybe Text)
listAttachedIndicesResponse_httpStatus :: Lens' ListAttachedIndicesResponse Int

Creating a Request

data ListAttachedIndices Source #

See: newListAttachedIndices smart constructor.

Constructors

ListAttachedIndices'
Fields consistencyLevel :: Maybe ConsistencyLevel The consistency level to use for this operation. maxResults :: Maybe Natural The maximum number of results to retrieve. nextToken :: Maybe Text The pagination token. directoryArn :: Text The ARN of the directory. targetReference :: ObjectReference A reference to the object that has indices attached.

Instances

Instances details

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

newListAttachedIndices Source #

Arguments

:: Text	`ListAttachedIndices`
-> ObjectReference	`ListAttachedIndices`
-> ListAttachedIndices

Create a value of ListAttachedIndices 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:ListAttachedIndices', listAttachedIndices_consistencyLevel - The consistency level to use for this operation.

ListAttachedIndices, listAttachedIndices_maxResults - The maximum number of results to retrieve.

ListAttachedIndices, listAttachedIndices_nextToken - The pagination token.

ListAttachedIndices, listAttachedIndices_directoryArn - The ARN of the directory.

ListAttachedIndices, listAttachedIndices_targetReference - A reference to the object that has indices attached.

Request Lenses

listAttachedIndices_consistencyLevel :: Lens' ListAttachedIndices (Maybe ConsistencyLevel) Source #

The consistency level to use for this operation.

listAttachedIndices_maxResults :: Lens' ListAttachedIndices (Maybe Natural) Source #

The maximum number of results to retrieve.

listAttachedIndices_nextToken :: Lens' ListAttachedIndices (Maybe Text) Source #

The pagination token.

listAttachedIndices_directoryArn :: Lens' ListAttachedIndices Text Source #

The ARN of the directory.

listAttachedIndices_targetReference :: Lens' ListAttachedIndices ObjectReference Source #

A reference to the object that has indices attached.

Destructuring the Response

data ListAttachedIndicesResponse Source #

See: newListAttachedIndicesResponse smart constructor.

Constructors

ListAttachedIndicesResponse'
Fields indexAttachments :: Maybe [IndexAttachment] The indices attached to the specified object. nextToken :: Maybe Text The pagination token. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListAttachedIndicesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListAttachedIndices Associated Types type Rep ListAttachedIndicesResponse :: Type -> Type # Methods from :: ListAttachedIndicesResponse -> Rep ListAttachedIndicesResponse x # to :: Rep ListAttachedIndicesResponse x -> ListAttachedIndicesResponse #
Read ListAttachedIndicesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListAttachedIndices Methods readsPrec :: Int -> ReadS ListAttachedIndicesResponse # readList :: ReadS [ListAttachedIndicesResponse] # readPrec :: ReadPrec ListAttachedIndicesResponse # readListPrec :: ReadPrec [ListAttachedIndicesResponse] #
Show ListAttachedIndicesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListAttachedIndices Methods showsPrec :: Int -> ListAttachedIndicesResponse -> ShowS # show :: ListAttachedIndicesResponse -> String # showList :: [ListAttachedIndicesResponse] -> ShowS #
NFData ListAttachedIndicesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListAttachedIndices Methods rnf :: ListAttachedIndicesResponse -> () #
Eq ListAttachedIndicesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListAttachedIndices Methods (==) :: ListAttachedIndicesResponse -> ListAttachedIndicesResponse -> Bool # (/=) :: ListAttachedIndicesResponse -> ListAttachedIndicesResponse -> Bool #
type Rep ListAttachedIndicesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListAttachedIndices type Rep ListAttachedIndicesResponse = D1 ('MetaData "ListAttachedIndicesResponse" "Amazonka.CloudDirectory.ListAttachedIndices" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListAttachedIndicesResponse'" '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))))

newListAttachedIndicesResponse Source #

Arguments

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

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

ListAttachedIndicesResponse, listAttachedIndicesResponse_indexAttachments - The indices attached to the specified object.

ListAttachedIndices, listAttachedIndicesResponse_nextToken - The pagination token.

$sel:httpStatus:ListAttachedIndicesResponse', listAttachedIndicesResponse_httpStatus - The response's http status code.

Response Lenses

listAttachedIndicesResponse_indexAttachments :: Lens' ListAttachedIndicesResponse (Maybe [IndexAttachment]) Source #

The indices attached to the specified object.

listAttachedIndicesResponse_nextToken :: Lens' ListAttachedIndicesResponse (Maybe Text) Source #

The pagination token.

listAttachedIndicesResponse_httpStatus :: Lens' ListAttachedIndicesResponse Int Source #

The response's http status code.