Spec-Zone.ru › AWS CLI v2

[ aws . lexv2-models ]

list-slots

Описание

Получает список слотов, соответствующих указанным критериям.

См. также: Документацию API AWS

Синтаксис

  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]

Параметры

--bot-id (строка)

Идентификатор бота, содержащего слот.

--bot-version (строка)

Версия бота, содержащего слот.

--locale-id (строка)

Идентификатор языка и региона слотов для вывода списка. Строка должна соответствовать одному из поддерживаемых регионов. Дополнительная информация — в разделе Поддерживаемые языки.

--intent-id (строка)

Уникальный идентификатор интента, содержащего слот.

--sort-by (структура)

Определяет порядок сортировки ответа от операции ListSlots. Можно выбрать сортировку по имени слота или дате последнего обновления в порядке возрастания или убывания.

атрибут -> (строка)

Атрибут, используемый для сортировки списка.

порядок -> (строка)

Порядок сортировки списка. Можно выбрать возрастание или убывание.

Синтаксис в сокращенном виде:

attribute=string,order=string

Синтаксис JSON:

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

--filters (список)

Указывает спецификацию фильтра, используемого для ограничения слотов в ответе только теми, которые соответствуют указанной спецификации фильтра. Можно указать только один фильтр и только одну строку для фильтрации.

(структура)

Фильтры ответы от операции ListSlots.

имя -> (строка)

Имя поля, используемого для фильтрации.

значения -> (список)

Значение, используемое для фильтрации ответа.

(строка)

оператор -> (строка)

Оператор, используемый для фильтра. Укажите EQ, когда операция ListSlots должна возвращать только алиасы, равные указанному значению. Укажите CO, когда операция ListSlots должна возвращать алиасы, содержащие указанное значение.

Синтаксис в сокращенном виде:

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

Синтаксис JSON:

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

--max-results (целое число)

Максимальное количество слотов, возвращаемых на каждой странице результатов. Если результатов меньше, чем размер максимальной страницы, возвращается только фактическое количество результатов.

--next-token (строка)

Если ответ от операции ListSlots содержит больше результатов, чем указано в параметре maxResults, в ответе возвращается маркер. Используйте этот маркер в параметре nextToken, чтобы получить следующую страницу результатов.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, указанному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределяют значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. При предоставлении значения output, он проверит входные данные команды и вернет пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладочный вывод.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (булево)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включить
  • выключить
  • автоматический

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое сопоставляется с двоичным блоком, fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить кли-паджинатор для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы для параметров CLI.

Вывод

botId -> (строка)

Идентификатор бота, содержащего слоты.

botVersion -> (строка)

Версия бота, содержащего слоты.

localeId -> (строка)

Язык и регион слотов в списке.

intentId -> (строка)

Идентификатор интента, содержащего слоты.

slotSummaries -> (список)

Сводная информация о слотах, соответствующих критериям фильтра, указанным в запросе. Длина списка задаётся параметром maxResults запроса. Если доступны дополнительные слоты, поле nextToken содержит маркер для получения следующей страницы результатов.

(структура)

Сводная информация о слоте, значении, которое бот запрашивает у пользователя.

slotId -> (строка)

Уникальный идентификатор слота.

slotName -> (строка)

Имя, заданное слоту.

description -> (строка)

Описание слота.

slotConstraint -> (строка)

Обязательный или необязательный слот. Интент считается завершённым, когда заполнены все обязательные слоты.

slotTypeId -> (строка)

Уникальный идентификатор типа слота, определяющего значения для слота.

valueElicitationPromptSpecification -> (структура)

Подсказки, которые отправляются пользователю для получения значения слота.

messageGroups -> (список)

Коллекция сообщений, которые Amazon Lex может отправить пользователю. Amazon Lex выбирает фактическое сообщение во время выполнения.

(структура)

Предоставляет одно или несколько сообщений, которые Amazon Lex должен отправить пользователю.

message -> (структура)

Основное сообщение, которое Amazon Lex должен отправить пользователю.

plainTextMessage -> (структура)

Сообщение в формате простого текста.

value -> (строка)

Сообщение для отправки пользователю.

customPayload -> (структура)

Сообщение в пользовательском формате, определённом приложением-клиентом.

value -> (строка)

Строка, отправляемая вашему приложению.

ssmlMessage -> (структура)

Сообщение в формате языка разметки для синтеза речи (SSML).

value -> (строка)

Текст SSML, определяющий подсказку.

imageResponseCard -> (структура)

Сообщение, определяющее карточку ответа, которую приложение-клиент может отобразить пользователю.

title -> (строка)

Заголовок для отображения на карточке ответа. Формат заголовка определяется платформой, отображающей карточку ответа.

subtitle -> (строка)

Подзаголовок для отображения на карточке ответа. Формат подзаголовка определяется платформой, отображающей карточку ответа.

imageUrl -> (строка)

URL изображения для отображения на карточке ответа. URL изображения должен быть общедоступным, чтобы платформа, отображающая карточку ответа, имела доступ к изображению.

buttons -> (список)

Список кнопок, которые должны быть отображены на карточке ответа. Расположение кнопок определяется платформой, отображающей кнопки.

(структура)

Описание кнопки для использования на карточке ответа для сбора значений слотов от пользователя.

text -> (строка)

Текст, отображаемый на кнопке. Используйте его, чтобы указать пользователю, какое значение возвращается при выборе этой кнопки.

value -> (строка)

Значение, возвращаемое Amazon Lex, когда пользователь выбирает эту кнопку. Оно должно соответствовать одному из значений слота, настроенных для слота.

variations -> (список)

Варианты сообщений для отправки пользователю. При определении вариантов Amazon Lex выбирает основное сообщение или один из вариантов для отправки пользователю.

(структура)

Объект, предоставляющий текст сообщения и его тип.

plainTextMessage -> (структура)

Сообщение в формате простого текста.

value -> (строка)

Сообщение для отправки пользователю.

customPayload -> (структура)

Сообщение в пользовательском формате, определённом приложением-клиентом.

value -> (строка)

Строка, отправляемая вашему приложению.

ssmlMessage -> (структура)

Сообщение в формате языка разметки для синтеза речи (SSML).

value -> (строка)

Текст SSML, определяющий подсказку.

imageResponseCard -> (структура)

Сообщение, определяющее карточку ответа, которую приложение-клиент может отобразить пользователю.

title -> (строка)

Заголовок для отображения на карточке ответа. Формат заголовка определяется платформой, отображающей карточку ответа.

subtitle -> (строка)

Подзаголовок для отображения на карточке ответа. Формат подзаголовка определяется платформой, отображающей карточку ответа.

imageUrl -> (строка)

URL изображения для отображения на карточке ответа. URL изображения должен быть общедоступным, чтобы платформа, отображающая карточку ответа, имела доступ к изображению.

buttons -> (список)

Список кнопок, которые должны быть отображены на карточке ответа. Расположение кнопок определяется платформой, отображающей кнопки.

(структура)

Описание кнопки для использования на карточке ответа для сбора значений слотов от пользователя.

text -> (строка)

Текст, отображаемый на кнопке. Используйте его, чтобы указать пользователю, какое значение возвращается при выборе этой кнопки.

value -> (строка)

Значение, возвращаемое Amazon Lex, когда пользователь выбирает эту кнопку. Оно должно соответствовать одному из значений слота, настроенных для слота.

maxRetries -> (целое число)

Максимальное количество попыток бота получить ответ от пользователя с помощью этой подсказки.

allowInterrupt -> (булево)

Указывает, может ли пользователь прервать подсказку бота.

messageSelectionStrategy -> (строка)

Указывает, как выбирается сообщение из группы сообщений при повторных попытках.

promptAttemptsSpecification -> (карта)

Указывает расширенные настройки на каждой попытке подсказки.

key -> (строка)

Имя попытки подсказки.

value -> (структура)

Указывает настройки на попытке подсказки.

allowInterrupt -> (булево)

Указывает, может ли пользователь прервать попытку подсказки бота.

allowedInputTypes -> (структура)

Указывает разрешённые типы ввода для попытки подсказки.

allowAudioInput -> (булево)

Указывает, разрешён ли ввод аудио.

allowDTMFInput -> (булево)

Указывает, разрешён ли ввод DTMF.

audioAndDTMFInputSpecification -> (структура)

Указывает настройки для ввода аудио и DTMF.

startTimeoutMs -> (целое число)

Время ожидания бота, прежде чем предположить, что пользователь не будет говорить или нажимать клавиши. Это таймаут общий для ввода аудио и DTMF.

audioSpecification -> (структура)

Указывает настройки для ввода аудио.

maxLengthMs -> (целое число)

Время ожидания Amazon Lex, прежде чем ввод речи будет усечён, и речь будет возвращена приложению.

endTimeoutMs -> (целое число)

Время ожидания бота после того, как пользователь прекратил говорить, для предположения о завершении произнесения.

dtmfSpecification -> (структура)

Указывает настройки для ввода DTMF.

maxLength -> (целое число)

Максимальное количество цифр DTMF, разрешённых в произнесении.

endTimeoutMs -> (целое число)

Время ожидания бота после последнего введённого символа DTMF, прежде чем предположить, что ввод завершён.

deletionCharacter -> (строка)

Символ DTMF, очищающий накопленные цифры DTMF и немедленно завершающий ввод.

endCharacter -> (строка)

Символ DTMF, немедленно завершающий ввод. Если пользователь не нажмёт этот символ, ввод завершается по истечении таймаута.

textInputSpecification -> (структура)

Указывает настройки для ввода текста.

startTimeoutMs -> (целое число)

Время ожидания бота, прежде чем повторно запросить у пользователя ввод текста.

lastUpdatedDateTime -> (отметка времени)

Отметка времени последнего обновления слота.

nextToken -> (строка)

Маркер, указывающий, есть ли ещё результаты для возврата в ответе на операцию ListSlots. Если поле nextToken присутствует, вы отправляете его содержимое в качестве параметра nextToken запроса операции ListSlots для получения следующей страницы результатов.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API