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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about your 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

data DescribeExperience = DescribeExperience' {
- id :: Text
- indexId :: Text
}
newDescribeExperience :: Text -> Text -> DescribeExperience
describeExperience_id :: Lens' DescribeExperience Text
describeExperience_indexId :: Lens' DescribeExperience Text
data DescribeExperienceResponse = DescribeExperienceResponse' {
- configuration :: Maybe ExperienceConfiguration
- createdAt :: Maybe POSIX
- description :: Maybe Text
- endpoints :: Maybe (NonEmpty ExperienceEndpoint)
- errorMessage :: Maybe Text
- id :: Maybe Text
- indexId :: Maybe Text
- name :: Maybe Text
- roleArn :: Maybe Text
- status :: Maybe ExperienceStatus
- updatedAt :: Maybe POSIX
- httpStatus :: Int
}
newDescribeExperienceResponse :: Int -> DescribeExperienceResponse
describeExperienceResponse_configuration :: Lens' DescribeExperienceResponse (Maybe ExperienceConfiguration)
describeExperienceResponse_createdAt :: Lens' DescribeExperienceResponse (Maybe UTCTime)
describeExperienceResponse_description :: Lens' DescribeExperienceResponse (Maybe Text)
describeExperienceResponse_endpoints :: Lens' DescribeExperienceResponse (Maybe (NonEmpty ExperienceEndpoint))
describeExperienceResponse_errorMessage :: Lens' DescribeExperienceResponse (Maybe Text)
describeExperienceResponse_id :: Lens' DescribeExperienceResponse (Maybe Text)
describeExperienceResponse_indexId :: Lens' DescribeExperienceResponse (Maybe Text)
describeExperienceResponse_name :: Lens' DescribeExperienceResponse (Maybe Text)
describeExperienceResponse_roleArn :: Lens' DescribeExperienceResponse (Maybe Text)
describeExperienceResponse_status :: Lens' DescribeExperienceResponse (Maybe ExperienceStatus)
describeExperienceResponse_updatedAt :: Lens' DescribeExperienceResponse (Maybe UTCTime)
describeExperienceResponse_httpStatus :: Lens' DescribeExperienceResponse Int

Creating a Request

data DescribeExperience Source #

See: newDescribeExperience smart constructor.

Constructors

DescribeExperience'
Fields id :: Text The identifier of your Amazon Kendra experience you want to get information on. indexId :: Text The identifier of the index for your Amazon Kendra experience.

Instances

Instances details

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

newDescribeExperience Source #

Arguments

:: Text	`DescribeExperience`
-> Text	`DescribeExperience`
-> DescribeExperience

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

DescribeExperience, describeExperience_id - The identifier of your Amazon Kendra experience you want to get information on.

DescribeExperience, describeExperience_indexId - The identifier of the index for your Amazon Kendra experience.

Request Lenses

describeExperience_id :: Lens' DescribeExperience Text Source #

The identifier of your Amazon Kendra experience you want to get information on.

describeExperience_indexId :: Lens' DescribeExperience Text Source #

The identifier of the index for your Amazon Kendra experience.

Destructuring the Response

data DescribeExperienceResponse Source #

See: newDescribeExperienceResponse smart constructor.

Constructors

DescribeExperienceResponse'

Fields

configuration :: Maybe ExperienceConfiguration
Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.
createdAt :: Maybe POSIX
Shows the date-time your Amazon Kendra experience was created.
description :: Maybe Text
Shows the description for your Amazon Kendra experience.
endpoints :: Maybe (NonEmpty ExperienceEndpoint)
Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
errorMessage :: Maybe Text
The reason your Amazon Kendra experience could not properly process.
id :: Maybe Text
Shows the identifier of your Amazon Kendra experience.
indexId :: Maybe Text
Shows the identifier of the index for your Amazon Kendra experience.
name :: Maybe Text
Shows the name of your Amazon Kendra experience.
roleArn :: Maybe Text
Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information.
status :: Maybe ExperienceStatus
The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.
updatedAt :: Maybe POSIX
Shows the date-time your Amazon Kendra experience was last updated.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeExperienceResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeExperience Associated Types type Rep DescribeExperienceResponse :: Type -> Type # Methods from :: DescribeExperienceResponse -> Rep DescribeExperienceResponse x # to :: Rep DescribeExperienceResponse x -> DescribeExperienceResponse #
Read DescribeExperienceResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeExperience Methods readsPrec :: Int -> ReadS DescribeExperienceResponse # readList :: ReadS [DescribeExperienceResponse] # readPrec :: ReadPrec DescribeExperienceResponse # readListPrec :: ReadPrec [DescribeExperienceResponse] #
Show DescribeExperienceResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeExperience Methods showsPrec :: Int -> DescribeExperienceResponse -> ShowS # show :: DescribeExperienceResponse -> String # showList :: [DescribeExperienceResponse] -> ShowS #
NFData DescribeExperienceResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeExperience Methods rnf :: DescribeExperienceResponse -> () #
Eq DescribeExperienceResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeExperience Methods (==) :: DescribeExperienceResponse -> DescribeExperienceResponse -> Bool # (/=) :: DescribeExperienceResponse -> DescribeExperienceResponse -> Bool #
type Rep DescribeExperienceResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeExperience type Rep DescribeExperienceResponse = D1 ('MetaData "DescribeExperienceResponse" "Amazonka.Kendra.DescribeExperience" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeExperienceResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExperienceConfiguration)) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "endpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ExperienceEndpoint))) :: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExperienceStatus)) :: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeExperienceResponse Source #

Arguments

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

Create a value of DescribeExperienceResponse 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:configuration:DescribeExperienceResponse', describeExperienceResponse_configuration - Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

DescribeExperienceResponse, describeExperienceResponse_createdAt - Shows the date-time your Amazon Kendra experience was created.

$sel:description:DescribeExperienceResponse', describeExperienceResponse_description - Shows the description for your Amazon Kendra experience.

DescribeExperienceResponse, describeExperienceResponse_endpoints - Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

DescribeExperienceResponse, describeExperienceResponse_errorMessage - The reason your Amazon Kendra experience could not properly process.

DescribeExperience, describeExperienceResponse_id - Shows the identifier of your Amazon Kendra experience.

DescribeExperience, describeExperienceResponse_indexId - Shows the identifier of the index for your Amazon Kendra experience.

DescribeExperienceResponse, describeExperienceResponse_name - Shows the name of your Amazon Kendra experience.

DescribeExperienceResponse, describeExperienceResponse_roleArn - Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information.

DescribeExperienceResponse, describeExperienceResponse_status - The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.

DescribeExperienceResponse, describeExperienceResponse_updatedAt - Shows the date-time your Amazon Kendra experience was last updated.

$sel:httpStatus:DescribeExperienceResponse', describeExperienceResponse_httpStatus - The response's http status code.

Response Lenses

describeExperienceResponse_configuration :: Lens' DescribeExperienceResponse (Maybe ExperienceConfiguration) Source #

Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

describeExperienceResponse_createdAt :: Lens' DescribeExperienceResponse (Maybe UTCTime) Source #

Shows the date-time your Amazon Kendra experience was created.

describeExperienceResponse_description :: Lens' DescribeExperienceResponse (Maybe Text) Source #

Shows the description for your Amazon Kendra experience.

describeExperienceResponse_endpoints :: Lens' DescribeExperienceResponse (Maybe (NonEmpty ExperienceEndpoint)) Source #

Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

describeExperienceResponse_errorMessage :: Lens' DescribeExperienceResponse (Maybe Text) Source #

The reason your Amazon Kendra experience could not properly process.

describeExperienceResponse_id :: Lens' DescribeExperienceResponse (Maybe Text) Source #

Shows the identifier of your Amazon Kendra experience.

describeExperienceResponse_indexId :: Lens' DescribeExperienceResponse (Maybe Text) Source #

Shows the identifier of the index for your Amazon Kendra experience.

describeExperienceResponse_name :: Lens' DescribeExperienceResponse (Maybe Text) Source #

Shows the name of your Amazon Kendra experience.

describeExperienceResponse_roleArn :: Lens' DescribeExperienceResponse (Maybe Text) Source #

Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information.

describeExperienceResponse_status :: Lens' DescribeExperienceResponse (Maybe ExperienceStatus) Source #

The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.

describeExperienceResponse_updatedAt :: Lens' DescribeExperienceResponse (Maybe UTCTime) Source #

Shows the date-time your Amazon Kendra experience was last updated.

describeExperienceResponse_httpStatus :: Lens' DescribeExperienceResponse Int Source #

The response's http status code.