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.Kendra.ListEntityPersonas

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists specific permissions of users and groups with access to your Amazon Kendra experience.

Synopsis

data ListEntityPersonas = ListEntityPersonas' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- id :: Text
- indexId :: Text
}
newListEntityPersonas :: Text -> Text -> ListEntityPersonas
listEntityPersonas_maxResults :: Lens' ListEntityPersonas (Maybe Natural)
listEntityPersonas_nextToken :: Lens' ListEntityPersonas (Maybe Text)
listEntityPersonas_id :: Lens' ListEntityPersonas Text
listEntityPersonas_indexId :: Lens' ListEntityPersonas Text
data ListEntityPersonasResponse = ListEntityPersonasResponse' {
- nextToken :: Maybe Text
- summaryItems :: Maybe [PersonasSummary]
- httpStatus :: Int
}
newListEntityPersonasResponse :: Int -> ListEntityPersonasResponse
listEntityPersonasResponse_nextToken :: Lens' ListEntityPersonasResponse (Maybe Text)
listEntityPersonasResponse_summaryItems :: Lens' ListEntityPersonasResponse (Maybe [PersonasSummary])
listEntityPersonasResponse_httpStatus :: Lens' ListEntityPersonasResponse Int

Creating a Request

data ListEntityPersonas Source #

See: newListEntityPersonas smart constructor.

Constructors

ListEntityPersonas'

Fields

maxResults :: Maybe Natural
The maximum number of returned users or groups.
nextToken :: Maybe Text
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of users or groups.
id :: Text
The identifier of your Amazon Kendra experience.
indexId :: Text
The identifier of the index for your Amazon Kendra experience.

Instances

Instances details

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

newListEntityPersonas Source #

Arguments

:: Text	`ListEntityPersonas`
-> Text	`$sel:indexId:ListEntityPersonas'`
-> ListEntityPersonas

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

ListEntityPersonas, listEntityPersonas_maxResults - The maximum number of returned users or groups.

ListEntityPersonas, listEntityPersonas_nextToken - If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of users or groups.

ListEntityPersonas, listEntityPersonas_id - The identifier of your Amazon Kendra experience.

$sel:indexId:ListEntityPersonas', listEntityPersonas_indexId - The identifier of the index for your Amazon Kendra experience.

Request Lenses

listEntityPersonas_maxResults :: Lens' ListEntityPersonas (Maybe Natural) Source #

The maximum number of returned users or groups.

listEntityPersonas_nextToken :: Lens' ListEntityPersonas (Maybe Text) Source #

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of users or groups.

listEntityPersonas_id :: Lens' ListEntityPersonas Text Source #

The identifier of your Amazon Kendra experience.

listEntityPersonas_indexId :: Lens' ListEntityPersonas Text Source #

The identifier of the index for your Amazon Kendra experience.

Destructuring the Response

data ListEntityPersonasResponse Source #

See: newListEntityPersonasResponse smart constructor.

Constructors

ListEntityPersonasResponse'
Fields nextToken :: Maybe Text If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of users or groups. summaryItems :: Maybe [PersonasSummary] An array of summary information for one or more users or groups. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListEntityPersonasResponse Source #

Arguments

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

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

ListEntityPersonas, listEntityPersonasResponse_nextToken - If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of users or groups.

$sel:summaryItems:ListEntityPersonasResponse', listEntityPersonasResponse_summaryItems - An array of summary information for one or more users or groups.

$sel:httpStatus:ListEntityPersonasResponse', listEntityPersonasResponse_httpStatus - The response's http status code.

Response Lenses

listEntityPersonasResponse_nextToken :: Lens' ListEntityPersonasResponse (Maybe Text) Source #

If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of users or groups.

listEntityPersonasResponse_summaryItems :: Lens' ListEntityPersonasResponse (Maybe [PersonasSummary]) Source #

An array of summary information for one or more users or groups.

listEntityPersonasResponse_httpStatus :: Lens' ListEntityPersonasResponse Int Source #

The response's http status code.