Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Wisdom.SearchSessions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Searches for sessions.

This operation returns paginated results.

Synopsis

data SearchSessions = SearchSessions' {
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- assistantId :: Text
- searchExpression :: SearchExpression
}
newSearchSessions :: Text -> SearchExpression -> SearchSessions
searchSessions_nextToken :: Lens' SearchSessions (Maybe Text)
searchSessions_maxResults :: Lens' SearchSessions (Maybe Natural)
searchSessions_assistantId :: Lens' SearchSessions Text
searchSessions_searchExpression :: Lens' SearchSessions SearchExpression
data SearchSessionsResponse = SearchSessionsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- sessionSummaries :: [SessionSummary]
}
newSearchSessionsResponse :: Int -> SearchSessionsResponse
searchSessionsResponse_nextToken :: Lens' SearchSessionsResponse (Maybe Text)
searchSessionsResponse_httpStatus :: Lens' SearchSessionsResponse Int
searchSessionsResponse_sessionSummaries :: Lens' SearchSessionsResponse [SessionSummary]

Creating a Request

data SearchSessions Source #

See: newSearchSessions smart constructor.

Constructors

SearchSessions'

Fields

nextToken :: Maybe Text
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
maxResults :: Maybe Natural
The maximum number of results to return per page.
assistantId :: Text
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
searchExpression :: SearchExpression
The search expression to filter results.

Instances

Instances details

Eq SearchSessions Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Methods (==) :: SearchSessions -> SearchSessions -> Bool # (/=) :: SearchSessions -> SearchSessions -> Bool #
Read SearchSessions Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Methods readsPrec :: Int -> ReadS SearchSessions # readList :: ReadS [SearchSessions] # readPrec :: ReadPrec SearchSessions # readListPrec :: ReadPrec [SearchSessions] #
Show SearchSessions Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Methods showsPrec :: Int -> SearchSessions -> ShowS # show :: SearchSessions -> String # showList :: [SearchSessions] -> ShowS #
Generic SearchSessions Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Associated Types type Rep SearchSessions :: Type -> Type # Methods from :: SearchSessions -> Rep SearchSessions x # to :: Rep SearchSessions x -> SearchSessions #
NFData SearchSessions Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Methods rnf :: SearchSessions -> () #
Hashable SearchSessions Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Methods hashWithSalt :: Int -> SearchSessions -> Int # hash :: SearchSessions -> Int #
ToJSON SearchSessions Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Methods toJSON :: SearchSessions -> Value # toEncoding :: SearchSessions -> Encoding # toJSONList :: [SearchSessions] -> Value # toEncodingList :: [SearchSessions] -> Encoding #
AWSPager SearchSessions Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Methods page :: SearchSessions -> AWSResponse SearchSessions -> Maybe SearchSessions #
AWSRequest SearchSessions Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Associated Types type AWSResponse SearchSessions # Methods request :: SearchSessions -> Request SearchSessions # response :: MonadResource m => Logger -> Service -> Proxy SearchSessions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchSessions))) #
ToHeaders SearchSessions Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Methods toHeaders :: SearchSessions -> [Header] #
ToPath SearchSessions Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Methods toPath :: SearchSessions -> ByteString #
ToQuery SearchSessions Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Methods toQuery :: SearchSessions -> QueryString #
type Rep SearchSessions Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions type Rep SearchSessions = D1 ('MetaData "SearchSessions" "Amazonka.Wisdom.SearchSessions" "libZSservicesZSamazonka-wisdomZSamazonka-wisdom" 'False) (C1 ('MetaCons "SearchSessions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "assistantId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "searchExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SearchExpression))))
type AWSResponse SearchSessions Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions type AWSResponse SearchSessions = SearchSessionsResponse

newSearchSessions Source #

Arguments

:: Text	`$sel:assistantId:SearchSessions'`
-> SearchExpression	`$sel:searchExpression:SearchSessions'`
-> SearchSessions

Create a value of SearchSessions 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:nextToken:SearchSessions', searchSessions_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

$sel:maxResults:SearchSessions', searchSessions_maxResults - The maximum number of results to return per page.

$sel:assistantId:SearchSessions', searchSessions_assistantId - The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

$sel:searchExpression:SearchSessions', searchSessions_searchExpression - The search expression to filter results.

Request Lenses

searchSessions_nextToken :: Lens' SearchSessions (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

searchSessions_maxResults :: Lens' SearchSessions (Maybe Natural) Source #

The maximum number of results to return per page.

searchSessions_assistantId :: Lens' SearchSessions Text Source #

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

searchSessions_searchExpression :: Lens' SearchSessions SearchExpression Source #

The search expression to filter results.

Destructuring the Response

data SearchSessionsResponse Source #

See: newSearchSessionsResponse smart constructor.

Constructors

SearchSessionsResponse'
Fields nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. httpStatus :: Int The response's http status code. sessionSummaries :: [SessionSummary] Summary information about the sessions.

Instances

Instances details

Eq SearchSessionsResponse Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Methods (==) :: SearchSessionsResponse -> SearchSessionsResponse -> Bool # (/=) :: SearchSessionsResponse -> SearchSessionsResponse -> Bool #
Read SearchSessionsResponse Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Methods readsPrec :: Int -> ReadS SearchSessionsResponse # readList :: ReadS [SearchSessionsResponse] # readPrec :: ReadPrec SearchSessionsResponse # readListPrec :: ReadPrec [SearchSessionsResponse] #
Show SearchSessionsResponse Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Methods showsPrec :: Int -> SearchSessionsResponse -> ShowS # show :: SearchSessionsResponse -> String # showList :: [SearchSessionsResponse] -> ShowS #
Generic SearchSessionsResponse Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Associated Types type Rep SearchSessionsResponse :: Type -> Type # Methods from :: SearchSessionsResponse -> Rep SearchSessionsResponse x # to :: Rep SearchSessionsResponse x -> SearchSessionsResponse #
NFData SearchSessionsResponse Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions Methods rnf :: SearchSessionsResponse -> () #
type Rep SearchSessionsResponse Source #
Instance details Defined in Amazonka.Wisdom.SearchSessions type Rep SearchSessionsResponse = D1 ('MetaData "SearchSessionsResponse" "Amazonka.Wisdom.SearchSessions" "libZSservicesZSamazonka-wisdomZSamazonka-wisdom" 'False) (C1 ('MetaCons "SearchSessionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "sessionSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SessionSummary]))))

newSearchSessionsResponse Source #

Arguments

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

Create a value of SearchSessionsResponse 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:nextToken:SearchSessions', searchSessionsResponse_nextToken - If there are additional results, this is the token for the next set of results.

$sel:httpStatus:SearchSessionsResponse', searchSessionsResponse_httpStatus - The response's http status code.

$sel:sessionSummaries:SearchSessionsResponse', searchSessionsResponse_sessionSummaries - Summary information about the sessions.

Response Lenses

searchSessionsResponse_nextToken :: Lens' SearchSessionsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

searchSessionsResponse_httpStatus :: Lens' SearchSessionsResponse Int Source #

The response's http status code.

searchSessionsResponse_sessionSummaries :: Lens' SearchSessionsResponse [SessionSummary] Source #

Summary information about the sessions.