Skip to content

List Bots

connect_list_bots R Documentation

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

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.

Usage

connect_list_bots(InstanceId, NextToken, MaxResults, LexVersion)

Arguments

InstanceId

[required] The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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.

MaxResults

The maximum number of results to return per page.

LexVersion

[required] The version of Amazon Lex or Amazon Lex V2.

Value

A list with the following syntax: 

list(
  LexBots = list(
    list(
      LexBot = list(
        Name = "string",
        LexRegion = "string"
      ),
      LexV2Bot = list(
        AliasArn = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_bots(
  InstanceId = "string",
  NextToken = "string",
  MaxResults = 123,
  LexVersion = "V1"|"V2"
)