Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudDirectory.ListFacetNames

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the names of facets that exist in a schema.

This operation returns paginated results.

Creating a Request

data ListFacetNames Source #

See: newListFacetNames smart constructor.

Constructors

ListFacetNames'
Fields nextToken :: Maybe Text The pagination token. maxResults :: Maybe Natural The maximum number of results to retrieve. schemaArn :: Text The Amazon Resource Name (ARN) to retrieve facet names from.

Instances

Instances details

Eq ListFacetNames Source #
Instance details Defined in Amazonka.CloudDirectory.ListFacetNames Methods (==) :: ListFacetNames -> ListFacetNames -> Bool # (/=) :: ListFacetNames -> ListFacetNames -> Bool #
Read ListFacetNames Source #
Instance details Defined in Amazonka.CloudDirectory.ListFacetNames Methods readsPrec :: Int -> ReadS ListFacetNames # readList :: ReadS [ListFacetNames] # readPrec :: ReadPrec ListFacetNames # readListPrec :: ReadPrec [ListFacetNames] #
Show ListFacetNames Source #
Instance details Defined in Amazonka.CloudDirectory.ListFacetNames Methods showsPrec :: Int -> ListFacetNames -> ShowS # show :: ListFacetNames -> String # showList :: [ListFacetNames] -> ShowS #
Generic ListFacetNames Source #
Instance details Defined in Amazonka.CloudDirectory.ListFacetNames Associated Types type Rep ListFacetNames :: Type -> Type # Methods from :: ListFacetNames -> Rep ListFacetNames x # to :: Rep ListFacetNames x -> ListFacetNames #
NFData ListFacetNames Source #
Instance details Defined in Amazonka.CloudDirectory.ListFacetNames Methods rnf :: ListFacetNames -> () #
Hashable ListFacetNames Source #
Instance details Defined in Amazonka.CloudDirectory.ListFacetNames Methods hashWithSalt :: Int -> ListFacetNames -> Int # hash :: ListFacetNames -> Int #
ToJSON ListFacetNames Source #
Instance details Defined in Amazonka.CloudDirectory.ListFacetNames Methods toJSON :: ListFacetNames -> Value # toEncoding :: ListFacetNames -> Encoding # toJSONList :: [ListFacetNames] -> Value # toEncodingList :: [ListFacetNames] -> Encoding #
AWSPager ListFacetNames Source #
Instance details Defined in Amazonka.CloudDirectory.ListFacetNames Methods page :: ListFacetNames -> AWSResponse ListFacetNames -> Maybe ListFacetNames #
AWSRequest ListFacetNames Source #
Instance details Defined in Amazonka.CloudDirectory.ListFacetNames Associated Types type AWSResponse ListFacetNames # Methods request :: ListFacetNames -> Request ListFacetNames # response :: MonadResource m => Logger -> Service -> Proxy ListFacetNames -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListFacetNames))) #
ToHeaders ListFacetNames Source #
Instance details Defined in Amazonka.CloudDirectory.ListFacetNames Methods toHeaders :: ListFacetNames -> [Header] #
ToPath ListFacetNames Source #
Instance details Defined in Amazonka.CloudDirectory.ListFacetNames Methods toPath :: ListFacetNames -> ByteString #
ToQuery ListFacetNames Source #
Instance details Defined in Amazonka.CloudDirectory.ListFacetNames Methods toQuery :: ListFacetNames -> QueryString #
type Rep ListFacetNames Source #
Instance details Defined in Amazonka.CloudDirectory.ListFacetNames type Rep ListFacetNames = D1 ('MetaData "ListFacetNames" "Amazonka.CloudDirectory.ListFacetNames" "libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory" 'False) (C1 ('MetaCons "ListFacetNames'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "schemaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListFacetNames Source #
Instance details Defined in Amazonka.CloudDirectory.ListFacetNames type AWSResponse ListFacetNames = ListFacetNamesResponse

newListFacetNames Source #

Arguments

:: Text	`$sel:schemaArn:ListFacetNames'`
-> ListFacetNames

Create a value of ListFacetNames 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:nextToken:ListFacetNames', listFacetNames_nextToken - The pagination token.

$sel:maxResults:ListFacetNames', listFacetNames_maxResults - The maximum number of results to retrieve.

$sel:schemaArn:ListFacetNames', listFacetNames_schemaArn - The Amazon Resource Name (ARN) to retrieve facet names from.

Request Lenses

listFacetNames_nextToken :: Lens' ListFacetNames (Maybe Text) Source #

The pagination token.

listFacetNames_maxResults :: Lens' ListFacetNames (Maybe Natural) Source #

The maximum number of results to retrieve.

listFacetNames_schemaArn :: Lens' ListFacetNames Text Source #

The Amazon Resource Name (ARN) to retrieve facet names from.

Destructuring the Response

data ListFacetNamesResponse Source #

See: newListFacetNamesResponse smart constructor.

Constructors

ListFacetNamesResponse'
Fields nextToken :: Maybe Text The pagination token. facetNames :: Maybe [Text] The names of facets that exist within the schema. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListFacetNamesResponse Source #

Arguments

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

Create a value of ListFacetNamesResponse 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:nextToken:ListFacetNames', listFacetNamesResponse_nextToken - The pagination token.

$sel:facetNames:ListFacetNamesResponse', listFacetNamesResponse_facetNames - The names of facets that exist within the schema.

$sel:httpStatus:ListFacetNamesResponse', listFacetNamesResponse_httpStatus - The response's http status code.

Response Lenses

listFacetNamesResponse_nextToken :: Lens' ListFacetNamesResponse (Maybe Text) Source #

The pagination token.

listFacetNamesResponse_facetNames :: Lens' ListFacetNamesResponse (Maybe [Text]) Source #

The names of facets that exist within the schema.

listFacetNamesResponse_httpStatus :: Lens' ListFacetNamesResponse Int Source #

The response's http status code.