Skip to content

List Intents

lexmodelsv2_list_intents R Documentation

Get a list of intents that meet the specified criteria

Description

Get a list of intents that meet the specified criteria.

Usage

lexmodelsv2_list_intents(botId, botVersion, localeId, sortBy, filters,
  maxResults, nextToken)

Arguments

botId

[required] The unique identifier of the bot that contains the intent.

botVersion

[required] The version of the bot that contains the intent.

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

Determines the sort order for the response from the list_intents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.

filters

Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.

maxResults

The maximum number of 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_intents operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a list_intents request to return the next page of results. For a complete set of results, call the list_intents operation until the nextToken returned in the response is null.

Value

A list with the following syntax: 

list(
  botId = "string",
  botVersion = "string",
  localeId = "string",
  intentSummaries = list(
    list(
      intentId = "string",
      intentName = "string",
      description = "string",
      parentIntentSignature = "string",
      inputContexts = list(
        list(
          name = "string"
        )
      ),
      outputContexts = list(
        list(
          name = "string",
          timeToLiveInSeconds = 123,
          turnsToLive = 123
        )
      ),
      lastUpdatedDateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_intents(
  botId = "string",
  botVersion = "string",
  localeId = "string",
  sortBy = list(
    attribute = "IntentName"|"LastUpdatedDateTime",
    order = "Ascending"|"Descending"
  ),
  filters = list(
    list(
      name = "IntentName",
      values = list(
        "string"
      ),
      operator = "CO"|"EQ"
    )
  ),
  maxResults = 123,
  nextToken = "string"
)