Amazonka.CloudDirectory.ListFacetNames

Retrieves the names of facets that exist in a schema.

This operation returns paginated results.

Creating a Request

data ListFacetNames

See: newListFacetNames smart constructor.

Constructors

ListFacetNames'

Fields

• maxResults :: Maybe Natural

  The maximum number of results to retrieve.

• nextToken :: Maybe Text

  The pagination token.

• schemaArn :: Text

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

Instances

ToJSON ListFacetNames

Defined in Amazonka.CloudDirectory.ListFacetNames

Methods

toJSON :: ListFacetNames -> Value

toEncoding :: ListFacetNames -> Encoding

toJSONList :: [ListFacetNames] -> Value

toEncodingList :: [ListFacetNames] -> Encoding

ToHeaders ListFacetNames

Defined in Amazonka.CloudDirectory.ListFacetNames

Methods

toHeaders :: ListFacetNames -> [Header]

ToPath ListFacetNames

Defined in Amazonka.CloudDirectory.ListFacetNames

Methods

toPath :: ListFacetNames -> ByteString

ToQuery ListFacetNames

Defined in Amazonka.CloudDirectory.ListFacetNames

Methods

toQuery :: ListFacetNames -> QueryString

AWSPager ListFacetNames

Defined in Amazonka.CloudDirectory.ListFacetNames

Methods

page :: ListFacetNames -> AWSResponse ListFacetNames -> Maybe ListFacetNames

AWSRequest ListFacetNames

Defined in Amazonka.CloudDirectory.ListFacetNames

Associated Types

type AWSResponse ListFacetNames

Methods

request :: (Service -> Service) -> ListFacetNames -> Request ListFacetNames

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListFacetNames -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListFacetNames)))

Generic ListFacetNames

Defined in Amazonka.CloudDirectory.ListFacetNames

Associated Types

type Rep ListFacetNames :: Type -> Type

Methods

from :: ListFacetNames -> Rep ListFacetNames x

to :: Rep ListFacetNames x -> ListFacetNames

Read ListFacetNames

Defined in Amazonka.CloudDirectory.ListFacetNames

Methods

readsPrec :: Int -> ReadS ListFacetNames

readList :: ReadS [ListFacetNames]

readPrec :: ReadPrec ListFacetNames

readListPrec :: ReadPrec [ListFacetNames]

Show ListFacetNames

Defined in Amazonka.CloudDirectory.ListFacetNames

Methods

showsPrec :: Int -> ListFacetNames -> ShowS

show :: ListFacetNames -> String

showList :: [ListFacetNames] -> ShowS

NFData ListFacetNames

Defined in Amazonka.CloudDirectory.ListFacetNames

Methods

rnf :: ListFacetNames -> ()

Eq ListFacetNames

Defined in Amazonka.CloudDirectory.ListFacetNames

Methods

(==) :: ListFacetNames -> ListFacetNames -> Bool

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

Hashable ListFacetNames

Defined in Amazonka.CloudDirectory.ListFacetNames

Methods

hashWithSalt :: Int -> ListFacetNames -> Int

hash :: ListFacetNames -> Int

type AWSResponse ListFacetNames

Defined in Amazonka.CloudDirectory.ListFacetNames

type AWSResponse ListFacetNames = ListFacetNamesResponse

type Rep ListFacetNames

Defined in Amazonka.CloudDirectory.ListFacetNames

type Rep ListFacetNames = D1 ('MetaData "ListFacetNames" "Amazonka.CloudDirectory.ListFacetNames" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListFacetNames'" '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))))

newListFacetNames

Arguments

:: Text

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:

ListFacetNames, listFacetNames_maxResults - The maximum number of results to retrieve.

ListFacetNames, listFacetNames_nextToken - The pagination token.

ListFacetNames, listFacetNames_schemaArn - The Amazon Resource Name (ARN) to retrieve facet names from.

Request Lenses

listFacetNames_maxResults :: Lens' ListFacetNames (Maybe Natural)

The maximum number of results to retrieve.

listFacetNames_nextToken :: Lens' ListFacetNames (Maybe Text)

The pagination token.

listFacetNames_schemaArn :: Lens' ListFacetNames Text

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

Destructuring the Response

data ListFacetNamesResponse

See: newListFacetNamesResponse smart constructor.

Constructors

ListFacetNamesResponse'

Fields

• facetNames :: Maybe [Text]

  The names of facets that exist within the schema.

• nextToken :: Maybe Text

  The pagination token.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListFacetNamesResponse

Defined in Amazonka.CloudDirectory.ListFacetNames

Associated Types

type Rep ListFacetNamesResponse :: Type -> Type

Methods

from :: ListFacetNamesResponse -> Rep ListFacetNamesResponse x

to :: Rep ListFacetNamesResponse x -> ListFacetNamesResponse

Read ListFacetNamesResponse

Defined in Amazonka.CloudDirectory.ListFacetNames

Methods

readsPrec :: Int -> ReadS ListFacetNamesResponse

readList :: ReadS [ListFacetNamesResponse]

readPrec :: ReadPrec ListFacetNamesResponse

readListPrec :: ReadPrec [ListFacetNamesResponse]

Show ListFacetNamesResponse

Defined in Amazonka.CloudDirectory.ListFacetNames

Methods

showsPrec :: Int -> ListFacetNamesResponse -> ShowS

show :: ListFacetNamesResponse -> String

showList :: [ListFacetNamesResponse] -> ShowS

NFData ListFacetNamesResponse

Defined in Amazonka.CloudDirectory.ListFacetNames

Methods

rnf :: ListFacetNamesResponse -> ()

Eq ListFacetNamesResponse

Defined in Amazonka.CloudDirectory.ListFacetNames

Methods

(==) :: ListFacetNamesResponse -> ListFacetNamesResponse -> Bool

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

type Rep ListFacetNamesResponse

Defined in Amazonka.CloudDirectory.ListFacetNames

type Rep ListFacetNamesResponse = D1 ('MetaData "ListFacetNamesResponse" "Amazonka.CloudDirectory.ListFacetNames" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListFacetNamesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "facetNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListFacetNamesResponse

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:facetNames:ListFacetNamesResponse', listFacetNamesResponse_facetNames - The names of facets that exist within the schema.

ListFacetNames, listFacetNamesResponse_nextToken - The pagination token.

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

Response Lenses

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

The names of facets that exist within the schema.

listFacetNamesResponse_nextToken :: Lens' ListFacetNamesResponse (Maybe Text)

The pagination token.

listFacetNamesResponse_httpStatus :: Lens' ListFacetNamesResponse Int

The response's http status code.