Spec-Zone.ru › AWS CLI v2

[ aws . robomaker ]

list-world-generation-jobs

Описание

Предупреждение

Уведомление о прекращении поддержки: 10 сентября 2025 года Amazon Web Services прекратит поддержку Amazon Web Services RoboMaker. После 10 сентября 2025 года вы больше не сможете получить доступ к консоли Amazon Web Services RoboMaker или ресурсам Amazon Web Services RoboMaker. Для получения дополнительной информации о переходе на Batch для запуска контейнерных симуляций посетите https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/ .

Выводит список заданий генерации миров.

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

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

Синтаксис

  list-world-generation-jobs
[--filters <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]

Параметры

--filters (список)

Дополнительные фильтры для ограничения результатов. Вы можете использовать status и templateId .

(структура)

Информация о фильтре.

name -> (строка)

Название фильтра.

values -> (список)

Список значений.

(строка)

Сокращенный синтаксис:

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

Синтаксис JSON:

[
  {
    "name": "string",
    "values": ["string", ...]
  }
  ...
]

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

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

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

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

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

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

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

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

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

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

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

Вывод

worldGenerationJobSummaries -> (список)

Сводная информация о заданиях генерации миров.

(структура)

Информация о задании генерации мира.

arn -> (строка)

Amazon Resource Name (ARN) задания генерации мира.

template -> (строка)

Amazon Resource Name (arn) шаблона мира.

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

Время в миллисекундах с момента эпохи, когда было создано задание генерации мира.

status -> (строка)

Статус задания генерации мира:

Pending

Запрос на задание генерации мира ожидает обработки.

Running

Задание генерации мира выполняется.

Completed

Задание генерации мира завершено.

Failed

Задание генерации мира завершилось с ошибкой. Дополнительную информацию см. в разделе failureCode.

PartialFailed

Некоторые миры не сгенерированы.

Canceled

Запрос на задание генерации мира был отменен.

Canceling

Запрос на задание генерации мира отменяется.

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

Информация о количестве миров.

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

Количество уникальных планов этажей.

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

Количество уникальных интерьеров на один план этажа.

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

Количество сгенерированных миров.

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

Количество миров, которые не удалось сгенерировать.

nextToken -> (строка)

Если предыдущий запрос с постраничной передачей данных не вернул все оставшиеся результаты, значение параметра nextToken объекта ответа устанавливается в токен. Для получения следующего набора результатов необходимо снова вызвать ListWorldGeneratorJobsRequest и назначить этот токен параметру nextToken объекта запроса. Если больше нет результатов, параметр NextToken предыдущего объекта ответа устанавливается в null.

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

Spec-Zone.ru

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