Network.AWS.LexModels.GetBots

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.

Creating a Request

getBots :: GetBots

Creates a value of GetBots with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gbNameContains - 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."
• gbNextToken - 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.
• gbMaxResults - The maximum number of bots to return in the response that the request will return. The default is 10.

data GetBots

See: getBots smart constructor.

Instances

Eq GetBots

Methods

(==) :: GetBots -> GetBots -> Bool

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

Data GetBots

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetBots -> c GetBots

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetBots

toConstr :: GetBots -> Constr

dataTypeOf :: GetBots -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetBots)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetBots)

gmapT :: (forall b. Data b => b -> b) -> GetBots -> GetBots

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetBots -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetBots -> r

gmapQ :: (forall d. Data d => d -> u) -> GetBots -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetBots -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetBots -> m GetBots

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetBots -> m GetBots

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetBots -> m GetBots

Read GetBots

Methods

readsPrec :: Int -> ReadS GetBots

readList :: ReadS [GetBots]

readPrec :: ReadPrec GetBots

readListPrec :: ReadPrec [GetBots]

Show GetBots

Methods

showsPrec :: Int -> GetBots -> ShowS

show :: GetBots -> String

showList :: [GetBots] -> ShowS

Generic GetBots

Associated Types

type Rep GetBots :: * -> *

Methods

from :: GetBots -> Rep GetBots x

to :: Rep GetBots x -> GetBots

Hashable GetBots

Methods

hashWithSalt :: Int -> GetBots -> Int

hash :: GetBots -> Int

NFData GetBots

Methods

rnf :: GetBots -> ()

AWSPager GetBots

Methods

page :: GetBots -> Rs GetBots -> Maybe GetBots

AWSRequest GetBots

Associated Types

type Rs GetBots :: *

Methods

request :: GetBots -> Request GetBots

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetBots -> ClientResponse -> m (Response GetBots)

ToHeaders GetBots

Methods

toHeaders :: GetBots -> [Header]

ToPath GetBots

Methods

toPath :: GetBots -> ByteString

ToQuery GetBots

Methods

toQuery :: GetBots -> QueryString

type Rep GetBots

type Rep GetBots = D1 * (MetaData "GetBots" "Network.AWS.LexModels.GetBots" "amazonka-lex-models-1.6.0-Iv3mghdDvOI9Mj0nI0DuS4" False) (C1 * (MetaCons "GetBots'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gbNameContains") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gbNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gbMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))

type Rs GetBots

type Rs GetBots = GetBotsResponse

Request Lenses

gbNameContains :: Lens' GetBots (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."

gbNextToken :: Lens' GetBots (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.

gbMaxResults :: Lens' GetBots (Maybe Natural)

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

Destructuring the Response

getBotsResponse

Arguments

:: Int

gbsrsResponseStatus

-> GetBotsResponse

Creates a value of GetBotsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gbsrsBots - An array of botMetadata objects, with one entry for each bot.
• gbsrsNextToken - 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.
• gbsrsResponseStatus - -- | The response status code.

data GetBotsResponse

See: getBotsResponse smart constructor.

Instances

Eq GetBotsResponse

Methods

(==) :: GetBotsResponse -> GetBotsResponse -> Bool

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

Data GetBotsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetBotsResponse -> c GetBotsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetBotsResponse

toConstr :: GetBotsResponse -> Constr

dataTypeOf :: GetBotsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetBotsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetBotsResponse)

gmapT :: (forall b. Data b => b -> b) -> GetBotsResponse -> GetBotsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetBotsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetBotsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetBotsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetBotsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetBotsResponse -> m GetBotsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetBotsResponse -> m GetBotsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetBotsResponse -> m GetBotsResponse

Read GetBotsResponse

Methods

readsPrec :: Int -> ReadS GetBotsResponse

readList :: ReadS [GetBotsResponse]

readPrec :: ReadPrec GetBotsResponse

readListPrec :: ReadPrec [GetBotsResponse]

Show GetBotsResponse

Methods

showsPrec :: Int -> GetBotsResponse -> ShowS

show :: GetBotsResponse -> String

showList :: [GetBotsResponse] -> ShowS

Generic GetBotsResponse

Associated Types

type Rep GetBotsResponse :: * -> *

Methods

from :: GetBotsResponse -> Rep GetBotsResponse x

to :: Rep GetBotsResponse x -> GetBotsResponse

NFData GetBotsResponse

Methods

rnf :: GetBotsResponse -> ()

type Rep GetBotsResponse

type Rep GetBotsResponse = D1 * (MetaData "GetBotsResponse" "Network.AWS.LexModels.GetBots" "amazonka-lex-models-1.6.0-Iv3mghdDvOI9Mj0nI0DuS4" False) (C1 * (MetaCons "GetBotsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gbsrsBots") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [BotMetadata]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gbsrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gbsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

gbsrsBots :: Lens' GetBotsResponse [BotMetadata]

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

gbsrsNextToken :: Lens' GetBotsResponse (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.

gbsrsResponseStatus :: Lens' GetBotsResponse Int

• - | The response status code.