Amazonka.Kendra.ListExperiences

Lists one or more Amazon Kendra experiences. 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.

Creating a Request

data ListExperiences

See: newListExperiences smart constructor.

Constructors

ListExperiences'

Fields

• maxResults :: Maybe Natural

  The maximum number of returned Amazon Kendra experiences.

• nextToken :: Maybe Text

  If the previous response was incomplete (because there is 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 Amazon Kendra experiences.

• indexId :: Text

  The identifier of the index for your Amazon Kendra experience.

Instances

ToJSON ListExperiences

Defined in Amazonka.Kendra.ListExperiences

Methods

toJSON :: ListExperiences -> Value

toEncoding :: ListExperiences -> Encoding

toJSONList :: [ListExperiences] -> Value

toEncodingList :: [ListExperiences] -> Encoding

ToHeaders ListExperiences

Defined in Amazonka.Kendra.ListExperiences

Methods

toHeaders :: ListExperiences -> [Header]

ToPath ListExperiences

Defined in Amazonka.Kendra.ListExperiences

Methods

toPath :: ListExperiences -> ByteString

ToQuery ListExperiences

Defined in Amazonka.Kendra.ListExperiences

Methods

toQuery :: ListExperiences -> QueryString

AWSRequest ListExperiences

Defined in Amazonka.Kendra.ListExperiences

Associated Types

type AWSResponse ListExperiences

Methods

request :: (Service -> Service) -> ListExperiences -> Request ListExperiences

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListExperiences -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListExperiences)))

Generic ListExperiences

Defined in Amazonka.Kendra.ListExperiences

Associated Types

type Rep ListExperiences :: Type -> Type

Methods

from :: ListExperiences -> Rep ListExperiences x

to :: Rep ListExperiences x -> ListExperiences

Read ListExperiences

Defined in Amazonka.Kendra.ListExperiences

Methods

readsPrec :: Int -> ReadS ListExperiences

readList :: ReadS [ListExperiences]

readPrec :: ReadPrec ListExperiences

readListPrec :: ReadPrec [ListExperiences]

Show ListExperiences

Defined in Amazonka.Kendra.ListExperiences

Methods

showsPrec :: Int -> ListExperiences -> ShowS

show :: ListExperiences -> String

showList :: [ListExperiences] -> ShowS

NFData ListExperiences

Defined in Amazonka.Kendra.ListExperiences

Methods

rnf :: ListExperiences -> ()

Eq ListExperiences

Defined in Amazonka.Kendra.ListExperiences

Methods

(==) :: ListExperiences -> ListExperiences -> Bool

(/=) :: ListExperiences -> ListExperiences -> Bool

Hashable ListExperiences

Defined in Amazonka.Kendra.ListExperiences

Methods

hashWithSalt :: Int -> ListExperiences -> Int

hash :: ListExperiences -> Int

type AWSResponse ListExperiences

Defined in Amazonka.Kendra.ListExperiences

type AWSResponse ListExperiences = ListExperiencesResponse

type Rep ListExperiences

Defined in Amazonka.Kendra.ListExperiences

type Rep ListExperiences = D1 ('MetaData "ListExperiences" "Amazonka.Kendra.ListExperiences" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListExperiences'" '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))))

newListExperiences

Arguments

:: Text

$sel:indexId:ListExperiences'

-> ListExperiences

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

ListExperiences, listExperiences_maxResults - The maximum number of returned Amazon Kendra experiences.

ListExperiences, listExperiences_nextToken - If the previous response was incomplete (because there is 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 Amazon Kendra experiences.

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

Request Lenses

listExperiences_maxResults :: Lens' ListExperiences (Maybe Natural)

The maximum number of returned Amazon Kendra experiences.

listExperiences_nextToken :: Lens' ListExperiences (Maybe Text)

If the previous response was incomplete (because there is 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 Amazon Kendra experiences.

listExperiences_indexId :: Lens' ListExperiences Text

The identifier of the index for your Amazon Kendra experience.

Destructuring the Response

data ListExperiencesResponse

See: newListExperiencesResponse smart constructor.

Constructors

ListExperiencesResponse'

Fields

• nextToken :: Maybe Text

  If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of Amazon Kendra experiences.

• summaryItems :: Maybe [ExperiencesSummary]

  An array of summary information for one or more Amazon Kendra experiences.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListExperiencesResponse

Defined in Amazonka.Kendra.ListExperiences

Associated Types

type Rep ListExperiencesResponse :: Type -> Type

Methods

from :: ListExperiencesResponse -> Rep ListExperiencesResponse x

to :: Rep ListExperiencesResponse x -> ListExperiencesResponse

Read ListExperiencesResponse

Defined in Amazonka.Kendra.ListExperiences

Methods

readsPrec :: Int -> ReadS ListExperiencesResponse

readList :: ReadS [ListExperiencesResponse]

readPrec :: ReadPrec ListExperiencesResponse

readListPrec :: ReadPrec [ListExperiencesResponse]

Show ListExperiencesResponse

Defined in Amazonka.Kendra.ListExperiences

Methods

showsPrec :: Int -> ListExperiencesResponse -> ShowS

show :: ListExperiencesResponse -> String

showList :: [ListExperiencesResponse] -> ShowS

NFData ListExperiencesResponse

Defined in Amazonka.Kendra.ListExperiences

Methods

rnf :: ListExperiencesResponse -> ()

Eq ListExperiencesResponse

Defined in Amazonka.Kendra.ListExperiences

Methods

(==) :: ListExperiencesResponse -> ListExperiencesResponse -> Bool

(/=) :: ListExperiencesResponse -> ListExperiencesResponse -> Bool

type Rep ListExperiencesResponse

Defined in Amazonka.Kendra.ListExperiences

type Rep ListExperiencesResponse = D1 ('MetaData "ListExperiencesResponse" "Amazonka.Kendra.ListExperiences" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListExperiencesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "summaryItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExperiencesSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListExperiencesResponse

Arguments

:: Int

$sel:httpStatus:ListExperiencesResponse'

-> ListExperiencesResponse

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

ListExperiences, listExperiencesResponse_nextToken - If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of Amazon Kendra experiences.

$sel:summaryItems:ListExperiencesResponse', listExperiencesResponse_summaryItems - An array of summary information for one or more Amazon Kendra experiences.

$sel:httpStatus:ListExperiencesResponse', listExperiencesResponse_httpStatus - The response's http status code.

Response Lenses

listExperiencesResponse_nextToken :: Lens' ListExperiencesResponse (Maybe Text)

If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of Amazon Kendra experiences.

listExperiencesResponse_summaryItems :: Lens' ListExperiencesResponse (Maybe [ExperiencesSummary])

An array of summary information for one or more Amazon Kendra experiences.

listExperiencesResponse_httpStatus :: Lens' ListExperiencesResponse Int

The response's http status code.