List Built In Intents

lexmodelsv2_list_built_in_intents

R Documentation

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot

Description

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature parameter when you call the create_intent operation. For more information, see create_intent.

Usage

lexmodelsv2_list_built_in_intents(localeId, sortBy, maxResults,
  nextToken)

Arguments

localeId	[required] The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
sortBy	Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.
maxResults	The maximum number of built-in intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken	If the response from the list_built_in_intents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Value

A list with the following syntax:

list(
  builtInIntentSummaries = list(
    list(
      intentSignature = "string",
      description = "string"
    )
  ),
  nextToken = "string",
  localeId = "string"
)

Request syntax

svc$list_built_in_intents(
  localeId = "string",
  sortBy = list(
    attribute = "IntentSignature",
    order = "Ascending"|"Descending"
  ),
  maxResults = 123,
  nextToken = "string"
)