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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the content.

This operation returns paginated results.

Creating a Request

data ListContents Source #

See: newListContents smart constructor.

Constructors

ListContents'
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.

Instances

Instances details

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

newListContents Source #

Arguments

:: Text	`ListContents`
-> ListContents

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

ListContents, listContents_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.

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

Request Lenses

listContents_maxResults :: Lens' ListContents (Maybe Natural) Source #

The maximum number of results to return per page.

listContents_nextToken :: Lens' ListContents (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.

listContents_knowledgeBaseId :: Lens' ListContents Text Source #

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

Destructuring the Response

data ListContentsResponse Source #

See: newListContentsResponse smart constructor.

Constructors

ListContentsResponse'
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] Information about the content.

Instances

Instances details

Generic ListContentsResponse Source #
Instance details Defined in Amazonka.Wisdom.ListContents Associated Types type Rep ListContentsResponse :: Type -> Type # Methods from :: ListContentsResponse -> Rep ListContentsResponse x # to :: Rep ListContentsResponse x -> ListContentsResponse #
Read ListContentsResponse Source #
Instance details Defined in Amazonka.Wisdom.ListContents Methods readsPrec :: Int -> ReadS ListContentsResponse # readList :: ReadS [ListContentsResponse] # readPrec :: ReadPrec ListContentsResponse # readListPrec :: ReadPrec [ListContentsResponse] #
Show ListContentsResponse Source #
Instance details Defined in Amazonka.Wisdom.ListContents Methods showsPrec :: Int -> ListContentsResponse -> ShowS # show :: ListContentsResponse -> String # showList :: [ListContentsResponse] -> ShowS #
NFData ListContentsResponse Source #
Instance details Defined in Amazonka.Wisdom.ListContents Methods rnf :: ListContentsResponse -> () #
Eq ListContentsResponse Source #
Instance details Defined in Amazonka.Wisdom.ListContents Methods (==) :: ListContentsResponse -> ListContentsResponse -> Bool # (/=) :: ListContentsResponse -> ListContentsResponse -> Bool #
type Rep ListContentsResponse Source #
Instance details Defined in Amazonka.Wisdom.ListContents type Rep ListContentsResponse = D1 ('MetaData "ListContentsResponse" "Amazonka.Wisdom.ListContents" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "ListContentsResponse'" '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]))))

newListContentsResponse Source #

Arguments

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

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

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

$sel:httpStatus:ListContentsResponse', listContentsResponse_httpStatus - The response's http status code.

$sel:contentSummaries:ListContentsResponse', listContentsResponse_contentSummaries - Information about the content.

Response Lenses

listContentsResponse_nextToken :: Lens' ListContentsResponse (Maybe Text) Source #

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

listContentsResponse_httpStatus :: Lens' ListContentsResponse Int Source #

The response's http status code.

listContentsResponse_contentSummaries :: Lens' ListContentsResponse [ContentSummary] Source #

Information about the content.