Spec-Zone.ru › AWS CLI v2

[ aws . voice-id ]

list-speaker-enrollment-jobs

Описание

Отображает все задания по зачислению голосов в домене со значением, указанным в поле JobStatus. Если поле JobStatus не указано, выводятся все задания со всеми возможными статусами заданий по зачислению голосов.

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

list-speaker-enrollment-jobs — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании аргумента --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: JobSummaries

Синтаксис

  list-speaker-enrollment-jobs
--domain-id <value>
[--job-status <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

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

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

--job-status (строка)

Указывает статус задания по зачислению голоса.

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

  • SUBMITTED
  • IN_PROGRESS
  • COMPLETED
  • COMPLETED_WITH_ERRORS
  • FAILED

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

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

Маркер для указания точки начала постраничного вывода. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

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

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для продолжения постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

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

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

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

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

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

Вывод

JobSummaries -> (список)

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

(структура)

Содержит сводку информации о задании по зачислению голосов.

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

Метка времени создания задания по зачислению голосов.

DomainId -> (строка)

Идентификатор домена, содержащего задание по зачислению голосов.

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

Метка времени завершения задания по зачислению голосов.

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

Содержит сведения, которые заполняются, когда задание целой группы задач завершается ошибкой. В случае сбоев отдельных задач регистрации задание группы в целом не завершается ошибкой; оно завершается с JobStatus значения COMPLETED_WITH_ERRORS. Вы можете использовать файл вывода задания, чтобы определить отдельные запросы регистрации, которые завершились ошибкой.

Message -> (строка)

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

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

Код HTTP-статуса, определяющий характер ошибки.

JobId -> (строка)

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

JobName -> (строка)

Имя, предоставленное клиентом, для задания по зачислению голосов.

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

Предоставляет сведения о ходе выполнения задания. Это поле показывает процент завершенных запросов по зачислению, перечисленных во входном файле.

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

Показывает процент завершенных запросов по зачислению или регистрации, перечисленных во входном файле.

JobStatus -> (строка)

Текущий статус задания по зачислению голосов.

NextToken -> (строка)

Если возвращается NextToken, доступно больше результатов. Значение NextToken — уникальный маркер постраничного вывода для каждой страницы. Выполните вызов снова с возвращенным маркером, чтобы получить следующую страницу. Остальные аргументы оставьте неизменными. Каждый маркер постраничного вывода действует 24 часа.

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

Spec-Zone.ru

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