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.LexModels.GetBots

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns bot information as follows:

If you provide the nameContains field, the response includes information for the $LATEST version of all bots whose name contains the specified string.
If you don't specify the nameContains field, the operation returns information about the $LATEST version of all of your bots.

This operation requires permission for the lex:GetBots action.

This operation returns paginated results.

Synopsis

data GetBots = GetBots' {
- nameContains :: Maybe Text
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
}
newGetBots :: GetBots
getBots_nameContains :: Lens' GetBots (Maybe Text)
getBots_nextToken :: Lens' GetBots (Maybe Text)
getBots_maxResults :: Lens' GetBots (Maybe Natural)
data GetBotsResponse = GetBotsResponse' {
- bots :: Maybe [BotMetadata]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetBotsResponse :: Int -> GetBotsResponse
getBotsResponse_bots :: Lens' GetBotsResponse (Maybe [BotMetadata])
getBotsResponse_nextToken :: Lens' GetBotsResponse (Maybe Text)
getBotsResponse_httpStatus :: Lens' GetBotsResponse Int

Creating a Request

data GetBots Source #

See: newGetBots smart constructor.

Constructors

GetBots'

Fields

nameContains :: Maybe Text
Substring to match in bot names. A bot will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
nextToken :: Maybe Text
A pagination token that fetches the next page of bots. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of bots, specify the pagination token in the next request.
maxResults :: Maybe Natural
The maximum number of bots to return in the response that the request will return. The default is 10.

Instances

Instances details

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

newGetBots :: GetBots Source #

Create a value of GetBots 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:nameContains:GetBots', getBots_nameContains - Substring to match in bot names. A bot will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

$sel:nextToken:GetBots', getBots_nextToken - A pagination token that fetches the next page of bots. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of bots, specify the pagination token in the next request.

$sel:maxResults:GetBots', getBots_maxResults - The maximum number of bots to return in the response that the request will return. The default is 10.

Request Lenses

getBots_nameContains :: Lens' GetBots (Maybe Text) Source #

Substring to match in bot names. A bot will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

getBots_nextToken :: Lens' GetBots (Maybe Text) Source #

A pagination token that fetches the next page of bots. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of bots, specify the pagination token in the next request.

getBots_maxResults :: Lens' GetBots (Maybe Natural) Source #

The maximum number of bots to return in the response that the request will return. The default is 10.

Destructuring the Response

data GetBotsResponse Source #

See: newGetBotsResponse smart constructor.

Constructors

GetBotsResponse'
Fields bots :: Maybe [BotMetadata] An array of `botMetadata` objects, with one entry for each bot. nextToken :: Maybe Text If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of bots. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetBotsResponse Source #

Arguments

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

Create a value of GetBotsResponse 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:bots:GetBotsResponse', getBotsResponse_bots - An array of botMetadata objects, with one entry for each bot.

$sel:nextToken:GetBots', getBotsResponse_nextToken - If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of bots.

$sel:httpStatus:GetBotsResponse', getBotsResponse_httpStatus - The response's http status code.

Response Lenses

getBotsResponse_bots :: Lens' GetBotsResponse (Maybe [BotMetadata]) Source #

An array of botMetadata objects, with one entry for each bot.

getBotsResponse_nextToken :: Lens' GetBotsResponse (Maybe Text) Source #

If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of bots.

getBotsResponse_httpStatus :: Lens' GetBotsResponse Int Source #

The response's http status code.