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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Synopsis

Creating a Request

data AssociateEntitiesToExperience Source #

See: newAssociateEntitiesToExperience smart constructor.

Constructors

AssociateEntitiesToExperience'
Fields id :: Text The identifier of your Amazon Kendra experience. indexId :: Text The identifier of the index for your Amazon Kendra experience. entityList :: NonEmpty EntityConfiguration Lists users or groups in your IAM Identity Center identity source.

Instances

Instances details

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

newAssociateEntitiesToExperience Source #

Arguments

:: Text	`AssociateEntitiesToExperience`
-> Text	`$sel:indexId:AssociateEntitiesToExperience'`
-> NonEmpty EntityConfiguration	`$sel:entityList:AssociateEntitiesToExperience'`
-> AssociateEntitiesToExperience

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

AssociateEntitiesToExperience, associateEntitiesToExperience_id - The identifier of your Amazon Kendra experience.

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

$sel:entityList:AssociateEntitiesToExperience', associateEntitiesToExperience_entityList - Lists users or groups in your IAM Identity Center identity source.

Request Lenses

associateEntitiesToExperience_id :: Lens' AssociateEntitiesToExperience Text Source #

The identifier of your Amazon Kendra experience.

associateEntitiesToExperience_indexId :: Lens' AssociateEntitiesToExperience Text Source #

The identifier of the index for your Amazon Kendra experience.

associateEntitiesToExperience_entityList :: Lens' AssociateEntitiesToExperience (NonEmpty EntityConfiguration) Source #

Lists users or groups in your IAM Identity Center identity source.

Destructuring the Response

data AssociateEntitiesToExperienceResponse Source #

See: newAssociateEntitiesToExperienceResponse smart constructor.

Constructors

AssociateEntitiesToExperienceResponse'
Fields failedEntityList :: Maybe (NonEmpty FailedEntity) Lists the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newAssociateEntitiesToExperienceResponse Source #

Arguments

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

Create a value of AssociateEntitiesToExperienceResponse 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:failedEntityList:AssociateEntitiesToExperienceResponse', associateEntitiesToExperienceResponse_failedEntityList - Lists the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience.

$sel:httpStatus:AssociateEntitiesToExperienceResponse', associateEntitiesToExperienceResponse_httpStatus - The response's http status code.

Response Lenses

associateEntitiesToExperienceResponse_failedEntityList :: Lens' AssociateEntitiesToExperienceResponse (Maybe (NonEmpty FailedEntity)) Source #

Lists the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience.

associateEntitiesToExperienceResponse_httpStatus :: Lens' AssociateEntitiesToExperienceResponse Int Source #

The response's http status code.