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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Synopsis

Creating a Request

data ListAccessControlConfigurations Source #

See: newListAccessControlConfigurations smart constructor.

Constructors

ListAccessControlConfigurations'

Fields

maxResults :: Maybe Natural
The maximum number of access control configurations to return.
nextToken :: Maybe Text
If the previous response was incomplete (because there's 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 access control configurations.
indexId :: Text
The identifier of the index for the access control configuration.

Instances

Instances details

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

newListAccessControlConfigurations Source #

Arguments

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

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

ListAccessControlConfigurations, listAccessControlConfigurations_maxResults - The maximum number of access control configurations to return.

ListAccessControlConfigurations, listAccessControlConfigurations_nextToken - If the previous response was incomplete (because there's 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 access control configurations.

$sel:indexId:ListAccessControlConfigurations', listAccessControlConfigurations_indexId - The identifier of the index for the access control configuration.

Request Lenses

listAccessControlConfigurations_maxResults :: Lens' ListAccessControlConfigurations (Maybe Natural) Source #

The maximum number of access control configurations to return.

listAccessControlConfigurations_nextToken :: Lens' ListAccessControlConfigurations (Maybe Text) Source #

If the previous response was incomplete (because there's 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 access control configurations.

listAccessControlConfigurations_indexId :: Lens' ListAccessControlConfigurations Text Source #

The identifier of the index for the access control configuration.

Destructuring the Response

data ListAccessControlConfigurationsResponse Source #

See: newListAccessControlConfigurationsResponse smart constructor.

Constructors

ListAccessControlConfigurationsResponse'
Fields nextToken :: Maybe Text If the response is truncated, Amazon Kendra returns this token, which you can use in the subsequent request to retrieve the next set of access control configurations. httpStatus :: Int The response's http status code. accessControlConfigurations :: [AccessControlConfigurationSummary] The details of your access control configurations.

Instances

Instances details

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

newListAccessControlConfigurationsResponse Source #

Arguments

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

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

ListAccessControlConfigurations, listAccessControlConfigurationsResponse_nextToken - If the response is truncated, Amazon Kendra returns this token, which you can use in the subsequent request to retrieve the next set of access control configurations.

$sel:httpStatus:ListAccessControlConfigurationsResponse', listAccessControlConfigurationsResponse_httpStatus - The response's http status code.

$sel:accessControlConfigurations:ListAccessControlConfigurationsResponse', listAccessControlConfigurationsResponse_accessControlConfigurations - The details of your access control configurations.

Response Lenses

listAccessControlConfigurationsResponse_nextToken :: Lens' ListAccessControlConfigurationsResponse (Maybe Text) Source #

If the response is truncated, Amazon Kendra returns this token, which you can use in the subsequent request to retrieve the next set of access control configurations.

listAccessControlConfigurationsResponse_httpStatus :: Lens' ListAccessControlConfigurationsResponse Int Source #

The response's http status code.

listAccessControlConfigurationsResponse_accessControlConfigurations :: Lens' ListAccessControlConfigurationsResponse [AccessControlConfigurationSummary] Source #

The details of your access control configurations.