[ aws . lexv2-models ]
list-slots
Description
Gets a list of slots that match the specified criteria.
See also: AWS API Documentation
Synopsis
list-slots
--bot-id <value>
--bot-version <value>
--locale-id <value>
--intent-id <value>
[--sort-by <value>]
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options
--bot-id (string)
--bot-version (string)
--locale-id (string)
--intent-id (string)
--sort-by (structure)
Determines the sort order for the response from the ListSlots operation. You can choose to sort by the slot name or last updated date in either ascending or descending order.
attribute -> (string)
order -> (string)
Shorthand Syntax:
attribute=string,order=string
JSON Syntax:
{
"attribute": "SlotName"|"LastUpdatedDateTime",
"order": "Ascending"|"Descending"
}
--filters (list)
Provides the specification of a filter used to limit the slots 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 ListSlots operation.
name -> (string)
values -> (list)
The value to use to filter the response.
(string)
operator -> (string)
EQ when the ListSlots operation should return only aliases that equal the specified value. Specify CO when the ListSlots operation should return aliases that contain the specified value.Shorthand Syntax:
name=string,values=string,string,operator=string ...
JSON Syntax:
[
{
"name": "SlotName",
"values": ["string", ...],
"operator": "CO"|"EQ"
}
...
]
--max-results (integer)
--next-token (string)
ListSlots 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.--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.
Global Options
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output
botId -> (string)
botVersion -> (string)
localeId -> (string)
intentId -> (string)
slotSummaries -> (list)
Summary information for the slots 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 slots available, the nextToken field contains a token to get the next page of results.
(structure)
Summary information about a slot, a value that the bot elicits from the user.
slotId -> (string)
slotName -> (string)
description -> (string)
slotConstraint -> (string)
slotTypeId -> (string)
valueElicitationPromptSpecification -> (structure)
Prompts that are sent to the user to elicit a value for the slot.
messageGroups -> (list)
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
subtitle -> (string)
imageUrl -> (string)
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
value -> (string)
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and its type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
subtitle -> (string)
imageUrl -> (string)
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
value -> (string)
maxRetries -> (integer)
allowInterrupt -> (boolean)
messageSelectionStrategy -> (string)
promptAttemptsSpecification -> (map)
Specifies the advanced settings on each attempt of the prompt.
key -> (string)
value -> (structure)
Specifies the settings on a prompt attempt.
allowInterrupt -> (boolean)
allowedInputTypes -> (structure)
Indicates the allowed input types of the prompt attempt.
allowAudioInput -> (boolean)
allowDTMFInput -> (boolean)
audioAndDTMFInputSpecification -> (structure)
Specifies the settings on audio and DTMF input.
startTimeoutMs -> (integer)
audioSpecification -> (structure)
Specifies the settings on audio input.
maxLengthMs -> (integer)
endTimeoutMs -> (integer)
dtmfSpecification -> (structure)
Specifies the settings on DTMF input.
maxLength -> (integer)
endTimeoutMs -> (integer)
deletionCharacter -> (string)
endCharacter -> (string)
textInputSpecification -> (structure)
Specifies the settings on text input.
startTimeoutMs -> (integer)
lastUpdatedDateTime -> (timestamp)
nextToken -> (string)
ListSlots operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListSlots operation request to get the next page of results.
© Copyright 2025, Amazon Web Services. Created using Sphinx.