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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves attributes attached to the facet.

This operation returns paginated results.

Synopsis

data ListFacetAttributes = ListFacetAttributes' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- schemaArn :: Text
- name :: Text
}
newListFacetAttributes :: Text -> Text -> ListFacetAttributes
listFacetAttributes_maxResults :: Lens' ListFacetAttributes (Maybe Natural)
listFacetAttributes_nextToken :: Lens' ListFacetAttributes (Maybe Text)
listFacetAttributes_schemaArn :: Lens' ListFacetAttributes Text
listFacetAttributes_name :: Lens' ListFacetAttributes Text
data ListFacetAttributesResponse = ListFacetAttributesResponse' {
- attributes :: Maybe [FacetAttribute]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListFacetAttributesResponse :: Int -> ListFacetAttributesResponse
listFacetAttributesResponse_attributes :: Lens' ListFacetAttributesResponse (Maybe [FacetAttribute])
listFacetAttributesResponse_nextToken :: Lens' ListFacetAttributesResponse (Maybe Text)
listFacetAttributesResponse_httpStatus :: Lens' ListFacetAttributesResponse Int

Creating a Request

data ListFacetAttributes Source #

See: newListFacetAttributes smart constructor.

Constructors

ListFacetAttributes'
Fields maxResults :: Maybe Natural The maximum number of results to retrieve. nextToken :: Maybe Text The pagination token. schemaArn :: Text The ARN of the schema where the facet resides. name :: Text The name of the facet whose attributes will be retrieved.

Instances

Instances details

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

newListFacetAttributes Source #

Arguments

:: Text	`ListFacetAttributes`
-> Text	`ListFacetAttributes`
-> ListFacetAttributes

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

ListFacetAttributes, listFacetAttributes_maxResults - The maximum number of results to retrieve.

ListFacetAttributes, listFacetAttributes_nextToken - The pagination token.

ListFacetAttributes, listFacetAttributes_schemaArn - The ARN of the schema where the facet resides.

ListFacetAttributes, listFacetAttributes_name - The name of the facet whose attributes will be retrieved.

Request Lenses

listFacetAttributes_maxResults :: Lens' ListFacetAttributes (Maybe Natural) Source #

The maximum number of results to retrieve.

listFacetAttributes_nextToken :: Lens' ListFacetAttributes (Maybe Text) Source #

The pagination token.

listFacetAttributes_schemaArn :: Lens' ListFacetAttributes Text Source #

The ARN of the schema where the facet resides.

listFacetAttributes_name :: Lens' ListFacetAttributes Text Source #

The name of the facet whose attributes will be retrieved.

Destructuring the Response

data ListFacetAttributesResponse Source #

See: newListFacetAttributesResponse smart constructor.

Constructors

ListFacetAttributesResponse'
Fields attributes :: Maybe [FacetAttribute] The attributes attached to the facet. nextToken :: Maybe Text The pagination token. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListFacetAttributesResponse Source #

Arguments

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

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

ListFacetAttributesResponse, listFacetAttributesResponse_attributes - The attributes attached to the facet.

ListFacetAttributes, listFacetAttributesResponse_nextToken - The pagination token.

$sel:httpStatus:ListFacetAttributesResponse', listFacetAttributesResponse_httpStatus - The response's http status code.

Response Lenses

listFacetAttributesResponse_attributes :: Lens' ListFacetAttributesResponse (Maybe [FacetAttribute]) Source #

The attributes attached to the facet.

listFacetAttributesResponse_nextToken :: Lens' ListFacetAttributesResponse (Maybe Text) Source #

The pagination token.

listFacetAttributesResponse_httpStatus :: Lens' ListFacetAttributesResponse Int Source #

The response's http status code.