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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.

DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Synopsis

Creating a Request

data DescribePrincipalMapping Source #

See: newDescribePrincipalMapping smart constructor.

Constructors

DescribePrincipalMapping'

Fields

dataSourceId :: Maybe Text
The identifier of the data source to check the processing of PUT and DELETE actions for mapping users to their groups.
indexId :: Text
The identifier of the index required to check the processing of PUT and DELETE actions for mapping users to their groups.
groupId :: Text
The identifier of the group required to check the processing of PUT and DELETE actions for mapping users to their groups.

Instances

Instances details

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

newDescribePrincipalMapping Source #

Arguments

:: Text	`DescribePrincipalMapping`
-> Text	`DescribePrincipalMapping`
-> DescribePrincipalMapping

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

DescribePrincipalMapping, describePrincipalMapping_dataSourceId - The identifier of the data source to check the processing of PUT and DELETE actions for mapping users to their groups.

DescribePrincipalMapping, describePrincipalMapping_indexId - The identifier of the index required to check the processing of PUT and DELETE actions for mapping users to their groups.

DescribePrincipalMapping, describePrincipalMapping_groupId - The identifier of the group required to check the processing of PUT and DELETE actions for mapping users to their groups.

Request Lenses

describePrincipalMapping_dataSourceId :: Lens' DescribePrincipalMapping (Maybe Text) Source #

The identifier of the data source to check the processing of PUT and DELETE actions for mapping users to their groups.

describePrincipalMapping_indexId :: Lens' DescribePrincipalMapping Text Source #

The identifier of the index required to check the processing of PUT and DELETE actions for mapping users to their groups.

describePrincipalMapping_groupId :: Lens' DescribePrincipalMapping Text Source #

The identifier of the group required to check the processing of PUT and DELETE actions for mapping users to their groups.

Destructuring the Response

data DescribePrincipalMappingResponse Source #

See: newDescribePrincipalMappingResponse smart constructor.

Constructors

DescribePrincipalMappingResponse'

Fields

dataSourceId :: Maybe Text
Shows the identifier of the data source to see information on the processing of PUT and DELETE actions for mapping users to their groups.
groupId :: Maybe Text
Shows the identifier of the group to see information on the processing of PUT and DELETE actions for mapping users to their groups.
groupOrderingIdSummaries :: Maybe [GroupOrderingIdSummary]
Shows the following information on the processing of PUT and DELETE actions for mapping users to their groups:
- Status – the status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.
- Last updated – the last date-time an action was updated.
- Received – the last date-time an action was received or submitted.
- Ordering ID – the latest action that should process and apply after other actions.
- Failure reason – the reason an action could not be processed.
indexId :: Maybe Text
Shows the identifier of the index to see information on the processing of PUT and DELETE actions for mapping users to their groups.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribePrincipalMappingResponse Source #

Arguments

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

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

DescribePrincipalMapping, describePrincipalMappingResponse_dataSourceId - Shows the identifier of the data source to see information on the processing of PUT and DELETE actions for mapping users to their groups.

DescribePrincipalMapping, describePrincipalMappingResponse_groupId - Shows the identifier of the group to see information on the processing of PUT and DELETE actions for mapping users to their groups.

$sel:groupOrderingIdSummaries:DescribePrincipalMappingResponse', describePrincipalMappingResponse_groupOrderingIdSummaries - Shows the following information on the processing of PUT and DELETE actions for mapping users to their groups:

Status – the status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.
Last updated – the last date-time an action was updated.
Received – the last date-time an action was received or submitted.
Ordering ID – the latest action that should process and apply after other actions.
Failure reason – the reason an action could not be processed.

DescribePrincipalMapping, describePrincipalMappingResponse_indexId - Shows the identifier of the index to see information on the processing of PUT and DELETE actions for mapping users to their groups.

$sel:httpStatus:DescribePrincipalMappingResponse', describePrincipalMappingResponse_httpStatus - The response's http status code.

Response Lenses

describePrincipalMappingResponse_dataSourceId :: Lens' DescribePrincipalMappingResponse (Maybe Text) Source #

Shows the identifier of the data source to see information on the processing of PUT and DELETE actions for mapping users to their groups.

describePrincipalMappingResponse_groupId :: Lens' DescribePrincipalMappingResponse (Maybe Text) Source #

Shows the identifier of the group to see information on the processing of PUT and DELETE actions for mapping users to their groups.

describePrincipalMappingResponse_groupOrderingIdSummaries :: Lens' DescribePrincipalMappingResponse (Maybe [GroupOrderingIdSummary]) Source #

Shows the following information on the processing of PUT and DELETE actions for mapping users to their groups:

Status – the status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.
Last updated – the last date-time an action was updated.
Received – the last date-time an action was received or submitted.
Ordering ID – the latest action that should process and apply after other actions.
Failure reason – the reason an action could not be processed.

describePrincipalMappingResponse_indexId :: Lens' DescribePrincipalMappingResponse (Maybe Text) Source #

Shows the identifier of the index to see information on the processing of PUT and DELETE actions for mapping users to their groups.

describePrincipalMappingResponse_httpStatus :: Lens' DescribePrincipalMappingResponse Int Source #

The response's http status code.