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.Wisdom.SearchContent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.

This operation returns paginated results.

Synopsis

data SearchContent = SearchContent' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- knowledgeBaseId :: Text
- searchExpression :: SearchExpression
}
newSearchContent :: Text -> SearchExpression -> SearchContent
searchContent_maxResults :: Lens' SearchContent (Maybe Natural)
searchContent_nextToken :: Lens' SearchContent (Maybe Text)
searchContent_knowledgeBaseId :: Lens' SearchContent Text
searchContent_searchExpression :: Lens' SearchContent SearchExpression
data SearchContentResponse = SearchContentResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- contentSummaries :: [ContentSummary]
}
newSearchContentResponse :: Int -> SearchContentResponse
searchContentResponse_nextToken :: Lens' SearchContentResponse (Maybe Text)
searchContentResponse_httpStatus :: Lens' SearchContentResponse Int
searchContentResponse_contentSummaries :: Lens' SearchContentResponse [ContentSummary]

Creating a Request

data SearchContent Source #

See: newSearchContent smart constructor.

Constructors

SearchContent'

Fields

maxResults :: Maybe Natural
The maximum number of results to return per page.
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.
knowledgeBaseId :: Text
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
searchExpression :: SearchExpression
The search expression to filter results.

Instances

Instances details

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

newSearchContent Source #

Arguments

:: Text	`SearchContent`
-> SearchExpression	`$sel:searchExpression:SearchContent'`
-> SearchContent

Create a value of SearchContent 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:maxResults:SearchContent', searchContent_maxResults - The maximum number of results to return per page.

SearchContent, searchContent_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.

SearchContent, searchContent_knowledgeBaseId - The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

$sel:searchExpression:SearchContent', searchContent_searchExpression - The search expression to filter results.

Request Lenses

searchContent_maxResults :: Lens' SearchContent (Maybe Natural) Source #

The maximum number of results to return per page.

searchContent_nextToken :: Lens' SearchContent (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.

searchContent_knowledgeBaseId :: Lens' SearchContent Text Source #

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

searchContent_searchExpression :: Lens' SearchContent SearchExpression Source #

The search expression to filter results.

Destructuring the Response

data SearchContentResponse Source #

See: newSearchContentResponse smart constructor.

Constructors

SearchContentResponse'
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. contentSummaries :: [ContentSummary] Summary information about the content.

Instances

Instances details

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

newSearchContentResponse Source #

Arguments

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

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

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

$sel:httpStatus:SearchContentResponse', searchContentResponse_httpStatus - The response's http status code.

$sel:contentSummaries:SearchContentResponse', searchContentResponse_contentSummaries - Summary information about the content.

Response Lenses

searchContentResponse_nextToken :: Lens' SearchContentResponse (Maybe Text) Source #

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

searchContentResponse_httpStatus :: Lens' SearchContentResponse Int Source #

The response's http status code.

searchContentResponse_contentSummaries :: Lens' SearchContentResponse [ContentSummary] Source #

Summary information about the content.