Spec-Zone.ru › AWS CLI v2

[ aws . qconnect ]

start-import-job

Описание

Запустить асинхронную задачу импорта ресурсов Amazon Q в Connect из загруженного исходного файла. Перед вызовом этого API используйте StartContentUpload для загрузки ресурса, содержащего данные ресурсов.

  • Для импорта быстрых ответов Amazon Q в Connect вам необходимо загрузить файл csv, содержащий быстрые ответы. Сведения о формате файла csv для импорта быстрых ответов см. в разделе Импорт быстрых ответов.

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

Синтаксис

  start-import-job
--knowledge-base-id <value>
--import-job-type <value>
--upload-id <value>
[--client-token <value>]
[--metadata <value>]
[--external-source-configuration <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]

Параметры

--knowledge-base-id (строка)

Идентификатор базы знаний. Может быть либо ID, либо ARN. URL не может содержать ARN.

  • Для импорта быстрых ответов Amazon Q в Connect это должна быть база знаний типа QUICK_RESPONSES.

--import-job-type (строка)

Тип задачи импорта.

  • Для импорта ресурсов быстрого ответа установите значение QUICK_RESPONSES.

Возможные значения:

  • QUICK_RESPONSES

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

Указатель на загруженный ресурс. Это значение возвращается функцией StartContentUpload.

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

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.

--metadata (массив)

Поля метаданных импортированных ресурсов Amazon Q в Connect.

ключ -> (строка)

значение -> (строка)

Синтаксис сокращённой записи:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--external-source-configuration (структура)

Информация о конфигурации внешнего источника, из которого импортируются данные ресурсов.

source -> (строка)

Тип внешнего источника данных.

configuration -> (структура помеченного объединения)

Информация о конфигурации внешнего источника данных.

Примечание

Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня: connectConfiguration.

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

Информация о конфигурации источника данных Amazon Connect.

instanceId -> (строка)

Идентификатор экземпляра Amazon Connect. Вы можете найти instanceId в ARN экземпляра.

Синтаксис сокращённой записи:

source=string,configuration={connectConfiguration={instanceId=string}}

Синтаксис JSON:

{
  "source": "AMAZON_CONNECT",
  "configuration": {
    "connectConfiguration": {
      "instanceId": "string"
    }
  }
}

--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
  • текст
  • таблица
  • 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое сопоставляется с двоичным блоком 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.

Вывод

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

Информация о задаче импорта.

importJobId -> (строка)

Идентификатор задачи импорта.

knowledgeBaseId -> (строка)

Идентификатор базы знаний.

uploadId -> (строка)

Указатель на загруженный ресурс. Это значение возвращается функцией StartContentUpload.

knowledgeBaseArn -> (строка)

Amazon Resource Name (ARN) базы знаний.

importJobType -> (строка)

Тип задачи импорта.

status -> (строка)

Статус задачи импорта.

url -> (строка)

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

failedRecordReport -> (строка)

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

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

Время истечения срока действия URL в виде временной метки эпохи.

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

Временная метка создания задачи импорта.

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

Временная метка последнего изменения данных задачи импорта.

metadata -> (массив)

Поля метаданных импортированных ресурсов Amazon Q в Connect.

ключ -> (строка)

значение -> (строка)

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

Информация о конфигурации внешнего источника данных.

source -> (строка)

Тип внешнего источника данных.

configuration -> (структура помеченного объединения)

Информация о конфигурации внешнего источника данных.

Примечание

Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня: connectConfiguration.

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

Информация о конфигурации источника данных Amazon Connect.

instanceId -> (строка)

Идентификатор экземпляра Amazon Connect. Вы можете найти instanceId в ARN экземпляра.

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

Spec-Zone.ru

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