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.Connect.ListBots

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This API is in preview release for Amazon Connect and is subject to change.

For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.

This operation returns paginated results.

Synopsis

data ListBots = ListBots' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- instanceId :: Text
- lexVersion :: LexVersion
}
newListBots :: Text -> LexVersion -> ListBots
listBots_maxResults :: Lens' ListBots (Maybe Natural)
listBots_nextToken :: Lens' ListBots (Maybe Text)
listBots_instanceId :: Lens' ListBots Text
listBots_lexVersion :: Lens' ListBots LexVersion
data ListBotsResponse = ListBotsResponse' {
- lexBots :: Maybe [LexBotConfig]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListBotsResponse :: Int -> ListBotsResponse
listBotsResponse_lexBots :: Lens' ListBotsResponse (Maybe [LexBotConfig])
listBotsResponse_nextToken :: Lens' ListBotsResponse (Maybe Text)
listBotsResponse_httpStatus :: Lens' ListBotsResponse Int

Creating a Request

data ListBots Source #

See: newListBots smart constructor.

Constructors

ListBots'

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.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
lexVersion :: LexVersion
The version of Amazon Lex or Amazon Lex V2.

Instances

Instances details

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

newListBots Source #

Arguments

:: Text	`ListBots`
-> LexVersion	`$sel:lexVersion:ListBots'`
-> ListBots

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

ListBots, listBots_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.

ListBots, listBots_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

$sel:lexVersion:ListBots', listBots_lexVersion - The version of Amazon Lex or Amazon Lex V2.

Request Lenses

listBots_maxResults :: Lens' ListBots (Maybe Natural) Source #

The maximum number of results to return per page.

listBots_nextToken :: Lens' ListBots (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.

listBots_instanceId :: Lens' ListBots Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listBots_lexVersion :: Lens' ListBots LexVersion Source #

The version of Amazon Lex or Amazon Lex V2.

Destructuring the Response

data ListBotsResponse Source #

See: newListBotsResponse smart constructor.

Constructors

ListBotsResponse'
Fields lexBots :: Maybe [LexBotConfig] The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance. 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.

Instances

Instances details

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

newListBotsResponse Source #

Arguments

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

Create a value of ListBotsResponse 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:lexBots:ListBotsResponse', listBotsResponse_lexBots - The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.

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

$sel:httpStatus:ListBotsResponse', listBotsResponse_httpStatus - The response's http status code.

Response Lenses

listBotsResponse_lexBots :: Lens' ListBotsResponse (Maybe [LexBotConfig]) Source #

The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.

listBotsResponse_nextToken :: Lens' ListBotsResponse (Maybe Text) Source #

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

listBotsResponse_httpStatus :: Lens' ListBotsResponse Int Source #

The response's http status code.