[ aws . lexv2-models ]

list-intents

Description

Get a list of intents that meet the specified criteria.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-intents
--bot-id <value>
--bot-version <value>
--locale-id <value>
[--sort-by <value>]
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--bot-id (string)

The unique identifier of the bot that contains the intent.

--bot-version (string)

The version of the bot that contains the intent.

--locale-id (string)

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 .

--sort-by (structure)

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

attribute -> (string)

The attribute to use to sort the list of intents.

order -> (string)

The order to sort the list. You can choose ascending or descending.

Shorthand Syntax:

attribute=string,order=string

JSON Syntax:

{
  "attribute": "IntentName"|"LastUpdatedDateTime",
  "order": "Ascending"|"Descending"
}

--filters (list)

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.

(structure)

Filters the response from the ListIntents operation.

name -> (string)

The name of the field to use for the filter.

values -> (list)

The value to use for the filter.

(string)

operator -> (string)

The operator to use for the filter. Specify EQ when the ListIntents operation should return only aliases that equal the specified value. Specify CO when the ListIntents operation should return aliases that contain the specified value.

Shorthand Syntax:

name=string,values=string,string,operator=string ...

JSON Syntax:

[
  {
    "name": "IntentName",
    "values": ["string", ...],
    "operator": "CO"|"EQ"
  }
  ...
]

--max-results (integer)

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.

--next-token (string)

If the response from the ListIntents 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 ListIntents request to return the next page of results. For a complete set of results, call the ListIntents operation until the nextToken returned in the response is null.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

botId -> (string)

The identifier of the bot that contains the intent.

botVersion -> (string)

The version of the bot that contains the intent.

localeId -> (string)

The language and locale of the intents in the list.

intentSummaries -> (list)

Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.

(structure)

Summary information about an intent returned by the ListIntents operation.

intentId -> (string)

The unique identifier assigned to the intent. Use this ID to get detailed information about the intent with the DescribeIntent operation.

intentName -> (string)

The name of the intent.

description -> (string)

The description of the intent.

parentIntentSignature -> (string)

If this intent is derived from a built-in intent, the name of the parent intent.

inputContexts -> (list)

The input contexts that must be active for this intent to be considered for recognition.

(structure)

The name of a context that must be active for an intent to be selected by Amazon Lex.

name -> (string)

The name of the context.

outputContexts -> (list)

The output contexts that are activated when this intent is fulfilled.

(structure)

Describes a session context that is activated when an intent is fulfilled.

name -> (string)

The name of the output context.

timeToLiveInSeconds -> (integer)

The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.

turnsToLive -> (integer)

The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.

lastUpdatedDateTime -> (timestamp)

The timestamp of the date and time that the intent was last updated.

nextToken -> (string)

A token that indicates whether there are more results to return in a response to the ListIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListIntents operation request to get the next page of results.