amazonka-connect-2.0: Amazon Connect Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Connect.ListLexBots

Description

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

Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.

This operation returns paginated results.

Synopsis

Creating a Request

data ListLexBots Source #

See: newListLexBots smart constructor.

Constructors

ListLexBots' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of results to return per page. If no value is specified, the default is 10.

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

Instances

Instances details
ToHeaders ListLexBots Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

Methods

toHeaders :: ListLexBots -> [Header] #

ToPath ListLexBots Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

ToQuery ListLexBots Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

AWSPager ListLexBots Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

AWSRequest ListLexBots Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

Associated Types

type AWSResponse ListLexBots #

Generic ListLexBots Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

Associated Types

type Rep ListLexBots :: Type -> Type #

Read ListLexBots Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

Show ListLexBots Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

NFData ListLexBots Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

Methods

rnf :: ListLexBots -> () #

Eq ListLexBots Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

Hashable ListLexBots Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

type AWSResponse ListLexBots Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

type Rep ListLexBots Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

type Rep ListLexBots = D1 ('MetaData "ListLexBots" "Amazonka.Connect.ListLexBots" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "ListLexBots'" '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))))

newListLexBots Source #

Create a value of ListLexBots 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:ListLexBots', listLexBots_maxResults - The maximum number of results to return per page. If no value is specified, the default is 10.

ListLexBots, listLexBots_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.

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

Request Lenses

listLexBots_maxResults :: Lens' ListLexBots (Maybe Natural) Source #

The maximum number of results to return per page. If no value is specified, the default is 10.

listLexBots_nextToken :: Lens' ListLexBots (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.

listLexBots_instanceId :: Lens' ListLexBots Text Source #

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

Destructuring the Response

data ListLexBotsResponse Source #

See: newListLexBotsResponse smart constructor.

Constructors

ListLexBotsResponse' 

Fields

  • lexBots :: Maybe [LexBot]

    The names and Amazon Web Services Regions of the Amazon Lex 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 ListLexBotsResponse Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

Associated Types

type Rep ListLexBotsResponse :: Type -> Type #

Read ListLexBotsResponse Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

Show ListLexBotsResponse Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

NFData ListLexBotsResponse Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

Methods

rnf :: ListLexBotsResponse -> () #

Eq ListLexBotsResponse Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

type Rep ListLexBotsResponse Source # 
Instance details

Defined in Amazonka.Connect.ListLexBots

type Rep ListLexBotsResponse = D1 ('MetaData "ListLexBotsResponse" "Amazonka.Connect.ListLexBots" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "ListLexBotsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lexBots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LexBot])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListLexBotsResponse Source #

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

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

$sel:httpStatus:ListLexBotsResponse', listLexBotsResponse_httpStatus - The response's http status code.

Response Lenses

listLexBotsResponse_lexBots :: Lens' ListLexBotsResponse (Maybe [LexBot]) Source #

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

listLexBotsResponse_nextToken :: Lens' ListLexBotsResponse (Maybe Text) Source #

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