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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about an access control configuration that you created for your documents in 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 DescribeAccessControlConfiguration Source #

See: newDescribeAccessControlConfiguration smart constructor.

Constructors

DescribeAccessControlConfiguration'
Fields indexId :: Text The identifier of the index for an access control configuration. id :: Text The identifier of the access control configuration you want to get information on.

Instances

Instances details

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

newDescribeAccessControlConfiguration Source #

Arguments

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

Create a value of DescribeAccessControlConfiguration 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:indexId:DescribeAccessControlConfiguration', describeAccessControlConfiguration_indexId - The identifier of the index for an access control configuration.

DescribeAccessControlConfiguration, describeAccessControlConfiguration_id - The identifier of the access control configuration you want to get information on.

Request Lenses

describeAccessControlConfiguration_indexId :: Lens' DescribeAccessControlConfiguration Text Source #

The identifier of the index for an access control configuration.

describeAccessControlConfiguration_id :: Lens' DescribeAccessControlConfiguration Text Source #

The identifier of the access control configuration you want to get information on.

Destructuring the Response

data DescribeAccessControlConfigurationResponse Source #

See: newDescribeAccessControlConfigurationResponse smart constructor.

Constructors

DescribeAccessControlConfigurationResponse'

Fields

accessControlList :: Maybe [Principal]
Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
description :: Maybe Text
The description for the access control configuration.
errorMessage :: Maybe Text
The error message containing details if there are issues processing the access control configuration.
hierarchicalAccessControlList :: Maybe (NonEmpty HierarchicalPrincipal)
The list of principal lists that define the hierarchy for which documents users should have access to.
httpStatus :: Int
The response's http status code.
name :: Text
The name for the access control configuration.

Instances

Instances details

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

newDescribeAccessControlConfigurationResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeAccessControlConfigurationResponse'`
-> Text	`DescribeAccessControlConfigurationResponse`
-> DescribeAccessControlConfigurationResponse

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

DescribeAccessControlConfigurationResponse, describeAccessControlConfigurationResponse_accessControlList - Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

$sel:description:DescribeAccessControlConfigurationResponse', describeAccessControlConfigurationResponse_description - The description for the access control configuration.

DescribeAccessControlConfigurationResponse, describeAccessControlConfigurationResponse_errorMessage - The error message containing details if there are issues processing the access control configuration.

DescribeAccessControlConfigurationResponse, describeAccessControlConfigurationResponse_hierarchicalAccessControlList - The list of principal lists that define the hierarchy for which documents users should have access to.

$sel:httpStatus:DescribeAccessControlConfigurationResponse', describeAccessControlConfigurationResponse_httpStatus - The response's http status code.

DescribeAccessControlConfigurationResponse, describeAccessControlConfigurationResponse_name - The name for the access control configuration.

Response Lenses

describeAccessControlConfigurationResponse_accessControlList :: Lens' DescribeAccessControlConfigurationResponse (Maybe [Principal]) Source #

Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

describeAccessControlConfigurationResponse_description :: Lens' DescribeAccessControlConfigurationResponse (Maybe Text) Source #

The description for the access control configuration.

describeAccessControlConfigurationResponse_errorMessage :: Lens' DescribeAccessControlConfigurationResponse (Maybe Text) Source #

The error message containing details if there are issues processing the access control configuration.

describeAccessControlConfigurationResponse_hierarchicalAccessControlList :: Lens' DescribeAccessControlConfigurationResponse (Maybe (NonEmpty HierarchicalPrincipal)) Source #

The list of principal lists that define the hierarchy for which documents users should have access to.

describeAccessControlConfigurationResponse_httpStatus :: Lens' DescribeAccessControlConfigurationResponse Int Source #

The response's http status code.

describeAccessControlConfigurationResponse_name :: Lens' DescribeAccessControlConfigurationResponse Text Source #

The name for the access control configuration.