Spec-Zone.ru › AWS CLI v2

[ aws . lexv2-models ]

describe-import

Описание

Получает информацию о конкретном импорте.

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

Синтаксис

  describe-import
--import-id <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]

Параметры

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

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

--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 (строка)

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

--no-verify-ssl (логическое значение)

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

--no-paginate (логическое значение)

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

--output (строка)

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

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

importId -> (строка)

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

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

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

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

Параметры для импорта бота.

botName -> (строка)

Имя, которое Amazon Lex должно использовать для бота.

roleArn -> (строка)

Amazon Resource Name (ARN) IAM-роли, используемой для создания и запуска бота.

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

По умолчанию данные, хранящиеся Amazon Lex, шифруются. Структура DataPrivacy предоставляет настройки, определяющие, как Amazon Lex обрабатывает особые случаи защиты данных вашего бота.

childDirected -> (логическое)

Для каждого бота Amazon Lex, созданного с помощью Amazon Lex Model Building Service, необходимо указать, относится ли ваше использование Amazon Lex к веб-сайту, программе или другому приложению, которое целиком или частично направлено или ориентировано на детей младше 13 лет и подпадает под действие Закона о защите частной жизни детей в Интернете (COPPA), указав true или false в поле childDirected. Указав true в поле childDirected, вы подтверждаете, что ваше использование Amazon Lex **относится** к веб-сайту, программе или другому приложению, которое целиком или частично направлено или ориентировано на детей младше 13 лет и подпадает под действие COPPA. Указав false в поле childDirected, вы подтверждаете, что ваше использование Amazon Lex **не относится** к веб-сайту, программе или другому приложению, которое целиком или частично направлено или ориентировано на детей младше 13 лет и подпадает под действие COPPA. Вы не можете указать значение по умолчанию для поля childDirected, которое неточно отражает, относится ли ваше использование Amazon Lex к веб-сайту, программе или другому приложению, которое целиком или частично направлено или ориентировано на детей младше 13 лет и подпадает под действие COPPA. Если ваше использование Amazon Lex относится к веб-сайту, программе или другому приложению, которое целиком или частично направлено на детей младше 13 лет, вы должны получить необходимый подтвержденный родительский контент в соответствии с COPPA. Подробнее о использовании Amazon Lex в связи с веб-сайтами, программами или другими приложениями, которые направлены или ориентированы, целиком или частично, на детей младше 13 лет, см. в разделе вопросов и ответов Amazon Lex.

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

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

enabled -> (логическое)

Параметры настроек для журналов ошибок, когда они включены.

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

Время в секундах, в течение которого Amazon Lex должен хранить информацию о разговоре пользователя с ботом.

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

Вы можете указать от 60 (1 минута) до 86 400 (24 часа) секунд.

botTags -> (массив)

Список тегов для добавления к боту. Вы можете добавлять теги только при импорте бота. Вы не можете использовать операцию UpdateBot для обновления тегов. Для обновления тегов используйте операцию TagResource.

key -> (строка)

value -> (строка)

testBotAliasTags -> (массив)

Список тегов для добавления к тестовому псевдониму бота. Вы можете добавлять теги только при импорте бота. Вы не можете использовать операцию UpdateAlias для обновления тегов. Для обновления тегов тестового псевдонима используйте операцию TagResource.

key -> (строка)

value -> (строка)

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

Параметры для импорта локали бота.

botId -> (строка)

Идентификатор бота, в который необходимо импортировать локаль.

botVersion -> (строка)

Версия бота, в которую необходимо импортировать локаль. Это может быть только версия DRAFT бота.

localeId -> (строка)

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

nluIntentConfidenceThreshold -> (двойное число)

Определяет порог, на котором Amazon Lex вставит AMAZON.FallbackIntent, AMAZON.KendraSearchIntent или оба, при возвращении альтернативных интентов. AMAZON.FallbackIntent и AMAZON.KendraSearchIntent вставляются только в том случае, если они настроены для бота.

Например, предположим, что бот настроен на порог уверенности 0,80 и AMAZON.FallbackIntent . Amazon Lex возвращает три альтернативных интента с такими оценками уверенности: IntentA (0,70), IntentB (0,60), IntentC (0,50). Ответ от операции PostText будет таким:

  • AMAZON.FallbackIntent
  • IntentA
  • IntentB
  • IntentC

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

Определяет настройки для использования голоса Amazon Polly для общения с пользователем.

Допустимые значения включают:

  • standard
  • neural
  • long-form
  • generative

voiceId -> (строка)

Идентификатор голоса Amazon Polly для использования.

engine -> (строка)

Указывает тип голоса Amazon Polly, который Amazon Lex должен использовать для голосового взаимодействия с пользователем. Дополнительную информацию см. в параметре ` engine операции SynthesizeSpeech <https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine>` в руководстве разработчика Amazon Polly.

Если вы не укажете значение, по умолчанию будет standard.

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

Предоставляет параметры, необходимые для импорта пользовательского словаря.

botId -> (строка)

Идентификатор бота, в который необходимо импортировать пользовательский словарь.

botVersion -> (строка)

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

localeId -> (строка)

Идентификатор локали для импорта пользовательского словаря. Значение должно быть en_GB.

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

Характеристики набора тестов, который импортируется.

testSetName -> (строка)

Имя набора тестов.

description -> (строка)

Описание набора тестов.

roleArn -> (строка)

Amazon Resource Name (ARN) IAM-роли, имеющей разрешения на доступ к набору тестов.

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

Содержит информацию о месте, где Amazon Lex хранит набор тестов.

s3BucketName -> (строка)

Имя Amazon S3-ведра, в котором хранится набор тестов.

s3Path -> (строка)

Путь внутри Amazon S3-ведра, где хранится набор тестов.

kmsKeyArn -> (строка)

Amazon Resource Name (ARN) ключа Amazon Web Services Key Management Service (KMS) для шифрования набора тестов.

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

Содержит информацию о месте ввода, откуда набор тестов должен быть импортирован.

s3BucketName -> (строка)

Имя Amazon S3-ведра.

s3Path -> (строка)

Путь внутри Amazon S3-ведра, указывающий на CSV-файл набора тестов.

modality -> (строка)

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

testSetTags -> (массив)

Список тегов для добавления к набору тестов. Вы можете добавлять теги только при импорте/создании нового набора тестов. Вы не можете использовать операцию UpdateTestSet для обновления тегов. Для обновления тегов используйте операцию TagResource.

key -> (строка)

value -> (строка)

importedResourceId -> (строка)

Уникальный идентификатор, присвоенный Amazon Lex созданному ресурсу.

importedResourceName -> (строка)

Имя импортированного ресурса.

mergeStrategy -> (строка)

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

importStatus -> (строка)

Статус процесса импорта. Когда статус Completed, ресурс импортирован и готов к использованию.

failureReasons -> (список)

Если поле importStatus имеет значение Failed, это предоставляет один или несколько причин неудачи.

(строка)

creationDateTime -> (временная метка)

Дата и время создания импорта.

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

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

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

Spec-Zone.ru

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