Spec-Zone.ru › AWS CLI v2

[ aws . robomaker ]

describe-simulation-job-batch

Описание

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

Уведомление о прекращении поддержки: 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

Синтаксис

  describe-simulation-job-batch
--batch <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]

Параметры

--batch (строка)

Идентификатор пакета для описания.

--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-auto-prompt (булево)

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

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

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

Выходные данные

arn -> (строка)

Идентификатор ресурса Amazon (ARN) пакета.

status -> (строка)

Статус пакета.

Pending

Запрос пакета задания моделирования ожидает обработки.

InProgress

Пакет задания моделирования выполняется.

Failed

Пакет задания моделирования завершился с ошибкой. Один или несколько запросов заданий моделирования не удалось выполнить из-за внутренней ошибки (например, InternalServiceError ). Для получения дополнительной информации см. failureCode и failureReason.

Completed

Заданию пакета моделирования завершено. Пакет считается завершенным, когда (1) в пакете нет ожидающих запросов заданий моделирования и ни один из запросов заданий моделирования с ошибкой не связан с InternalServiceError, и (2) когда все созданные задания моделирования достигли конечного состояния (например, Completed или Failed).

Canceled

Задание пакета моделирования было отменено.

Canceling

Пакет задания моделирования отменяется.

Completing

Завершается пакет задания моделирования.

TimingOut

Пакет задания моделирования истекает.

Если пакет истекает, а есть ожидающие запросы, которые не удаётся выполнить из-за внутренней ошибки (например, InternalServiceError), статус пакета будет Failed. Если таких запросов нет, статус пакета будет TimedOut.

TimedOut

Пакет задания моделирования истек.

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

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

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

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

clientRequestToken -> (строка)

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

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

Политика пакета.

timeoutInSeconds -> (длинное целое число)

Время ожидания завершения пакета в секундах.

Если пакет истекает, а есть ожидающие запросы, которые не удалось выполнить из-за внутренней ошибки (например, InternalServiceError), они будут перемещены в список ошибок, и статус пакета будет Failed. Если ожидающие запросы не выполняются по другим причинам, невыполненные ожидающие запросы будут перемещены в список ошибок, и статус пакета будет TimedOut.

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

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

Активные состояния включают: Pending, ``Preparing``, Running, Restarting, RunningFailed и Terminating. Все остальные состояния являются конечными.

failureCode -> (строка)

Код ошибки пакета задания моделирования.

failureReason -> (строка)

Причина ошибки пакета задания моделирования.

failedRequests -> (список)

Список невыполненных запросов на создание задания моделирования. Запрос не был создан как задание моделирования. Невыполненные запросы не имеют идентификатора задания моделирования.

(структура)

Информация о невыполненном запросе на создание задания моделирования.

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

Запрос задания моделирования.

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

Расположение выходных данных.

s3Bucket -> (строка)

Ведро S3 для выходных данных.

s3Prefix -> (строка)

Папка S3 в s3Bucket, где будут размещены выходные файлы.

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

Настройка ведения журнала.

recordAllRosTopics -> (логическое значение)

Логическое значение, указывающее, нужно ли записывать все темы ROS.

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

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

maxJobDurationInSeconds -> (длинное целое число)

Максимальная продолжительность задания моделирования в секундах. Значение должно быть 8 днями (691 200 секунд) или меньше.

iamRole -> (строка)

Имя роли IAM, разрешающей экземпляру моделирования вызывать API AWS, указанные в связанных политиках от вашего имени. Это способ передачи учетных данных в ваше задание моделирования.

failureBehavior -> (строка)

Поведение при ошибке задания моделирования.

Continue

Оставляет хост работающим в течение максимального времени ожидания после ошибки 4XX.

Fail

Останавливает задание моделирования и завершает работу экземпляра.

useDefaultApplications -> (логическое значение)

Логическое значение, указывающее, следует ли использовать приложения по умолчанию в задании моделирования. Приложения по умолчанию включают Gazebo, rqt, rviz и доступ к терминалу.

robotApplications -> (список)

Приложения робота для использования в задании моделирования.

(структура)

Информация о конфигурации приложения для робота.

application -> (строка)

Информация об приложении для приложения робота.

applicationVersion -> (строка)

Версия приложения робота.

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

Конфигурация запуска для приложения робота.

packageName -> (строка)

Имя пакета.

launchFile -> (строка)

Имя файла запуска.

environmentVariables -> (карта)

Переменные среды для запуска приложения.

key -> (строка)

value -> (строка)

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

Настройка переадресации портов.

portMappings -> (список)

Сопоставления портов для конфигурации.

(структура)

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

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

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

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

Номер порта в приложении.

enableOnPublicIp -> (логическое значение)

Логическое значение, указывающее, следует ли включить это сопоставление портов на общедоступном IP-адресе.

streamUI -> (логическое значение)

Логическое значение, указывающее, будет ли настроен сеанс потоковой передачи для приложения. Если True, AWS RoboMaker настроит подключение, чтобы вы могли взаимодействовать с вашим приложением во время его выполнения в моделировании. Вы должны настроить и запустить компонент. Он должен иметь графический интерфейс пользователя.

command -> (список)

Если вы указали General в качестве значения для вашего RobotSoftwareSuite, вы можете использовать это поле для указания списка команд для вашей контейнерной образа.

Если вы указали SimulationRuntime в качестве значения для вашего SimulationSoftwareSuite, вы можете использовать это поле для указания списка команд для вашей контейнерной образа.

(строка)

uploadConfigurations -> (список)

Настройки загрузки для приложения робота.

(структура)

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

name -> (строка)

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

Например, если расположение выходных данных моделирования — s3://amzn-s3-demo-bucket, а имя вашей конфигурации загрузки — robot-test, ваши файлы будут загружены в s3://amzn-s3-demo-bucket/<simid>/<runid>/robot-test.

path -> (строка)

Указывает путь к файлу(ам) для загрузки. Принимаются стандартные правила сопоставления Unix glob, с добавлением ** в качестве суперзвездочки. Например, указание /var/log/**.log вызывает сборку всех файлов .log в дереве каталогов /var/log. Более подробные примеры см. в разделе Библиотека glob.

uploadBehavior -> (строка)

Указывает, когда загрузить файлы:

UPLOAD_ON_TERMINATE

Соответствующие файлы загружаются, когда моделирование переходит в состояние TERMINATING. Соответствующие файлы не загружаются до тех пор, пока не завершится вся ваша программа (включая инструменты).

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

UPLOAD_ROLLING_AUTO_REMOVE

Соответствующие файлы загружаются по мере их создания. Они удаляются после загрузки. Указанный путь проверяется каждые 5 секунд. Окончательная проверка выполняется, когда завершится вся ваша программа (включая инструменты).

useDefaultUploadConfigurations -> (логическое значение)

Логическое значение, указывающее, следует ли использовать конфигурации загрузки по умолчанию. По умолчанию файлы .ros и .gazebo загружаются при завершении приложения, и все темы ROS будут записаны.

Если вы установите это значение, вы должны указать outputLocation.

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

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

tools -> (список)

Информация об инструментах, настроенных для приложения робота.

(структура)

Информация об инструменте. Инструменты используются в задании моделирования.

streamUI -> (логическое значение)

Логическое значение, указывающее, будет ли настроен сеанс потоковой передачи для инструмента. Если True, AWS RoboMaker настроит подключение, чтобы вы могли взаимодействовать с инструментом во время его выполнения в моделировании. Он должен иметь графический интерфейс пользователя. По умолчанию False.

name -> (строка)

Имя инструмента.

command -> (строка)

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

streamOutputToCloudWatch -> (логическое значение)

Логическое значение, указывающее, будут ли журналы записываться в CloudWatch для инструмента. По умолчанию False.

exitBehavior -> (строка)

Поведение при выходе определяет, что произойдет, когда ваш инструмент перестанет работать. RESTART приведет к перезапуску вашего инструмента. FAIL приведет к завершению работы задания. По умолчанию RESTART.

useDefaultTools -> (логическое значение)

Логическое значение, указывающее, следует ли использовать инструменты приложения робота по умолчанию. Инструменты по умолчанию — rviz, rqt, терминал и rosbag record. По умолчанию False.

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

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

simulationApplications -> (список)

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

(структура)

Информация о конфигурации приложения моделирования.

application -> (строка)

Информация об приложении моделирования.

applicationVersion -> (строка)

Версия приложения моделирования.

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

Конфигурация запуска приложения моделирования.

packageName -> (строка)

Имя пакета.

launchFile -> (строка)

Имя файла запуска.

environmentVariables -> (словарь)

Переменные среды для запуска приложения.

key -> (строка)

value -> (строка)

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

Конфигурация перенаправления портов.

portMappings -> (список)

Сопоставления портов для конфигурации.

(структура)

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

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

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

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

Номер порта на приложении.

enableOnPublicIp -> (булево)

Булево значение, указывающее, нужно ли включить это сопоставление портов на общедоступном IP-адресе.

streamUI -> (булево)

Булево значение, указывающее, будет ли настроена сессия потоковой передачи для приложения. Если True , AWS RoboMaker настроит подключение, чтобы вы могли взаимодействовать с приложением во время его работы в моделировании. Вы должны настроить и запустить компонент. Он должен иметь графический интерфейс пользователя.

command -> (список)

Если вы указали General в качестве значения для RobotSoftwareSuite, вы можете использовать это поле для указания списка команд для вашего образа контейнера.

Если вы указали SimulationRuntime в качестве значения для SimulationSoftwareSuite, вы можете использовать это поле для указания списка команд для вашего образа контейнера.

(строка)

uploadConfigurations -> (список)

Информация о конфигурациях загрузки для приложения моделирования.

(структура)

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

name -> (строка)

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

Например, если ваше расположение вывода моделирования — s3://amzn-s3-demo-bucket, а имя вашей конфигурации загрузки — robot-test, ваши файлы будут загружены в s3://amzn-s3-demo-bucket/<simid>/<runid>/robot-test.

path -> (строка)

Указывает путь к файлам, которые нужно загрузить. Принимаются стандартные правила сопоставления Unix glob, с добавлением ** в качестве супер-звездочки. Например, указание /var/log/**.log приводит к сбору всех файлов .log в дереве каталогов /var/log. Дополнительные примеры см. в документации по Glob Library.

uploadBehavior -> (строка)

Указывает, когда загрузить файлы:

UPLOAD_ON_TERMINATE

Соответствующие файлы загружаются, когда моделирование переходит в состояние TERMINATING. Соответствующие файлы не загружаются, пока весь ваш код (включая инструменты) не остановится.

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

UPLOAD_ROLLING_AUTO_REMOVE

Соответствующие файлы загружаются по мере их создания. Они удаляются после загрузки. Указанный путь проверяется каждые 5 секунд. Окончательная проверка выполняется, когда весь ваш код (включая инструменты) остановится.

worldConfigs -> (список)

Список конфигураций мира.

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

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

(структура)

Информация о конфигурации мира.

world -> (строка)

Мир, созданный Simulation WorldForge.

useDefaultUploadConfigurations -> (булево)

Булево значение, указывающее, использовать ли стандартные конфигурации загрузки. По умолчанию файлы .ros и .gazebo загружаются при завершении работы приложения, а все темы ROS будут записаны.

Если вы установите это значение, вы должны указать outputLocation.

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

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

tools -> (список)

Информация о настройках инструментов для приложения моделирования.

(структура)

Информация об инструменте. Инструменты используются в задаче моделирования.

streamUI -> (булево)

Булево значение, указывающее, будет ли настроена сессия потоковой передачи для инструмента. Если True, AWS RoboMaker настроит подключение, чтобы вы могли взаимодействовать с инструментом во время его работы в моделировании. Он должен иметь графический интерфейс пользователя. Значение по умолчанию — False.

name -> (строка)

Имя инструмента.

command -> (строка)

Аргументы командной строки для инструмента. Он должен включать имя исполняемого файла инструмента.

streamOutputToCloudWatch -> (булево)

Булево значение, указывающее, будут ли журналы записываться в CloudWatch для инструмента. Значение по умолчанию — False.

exitBehavior -> (строка)

Поведение при выходе определяет, что произойдет при завершении работы инструмента. RESTART приведет к перезапуску инструмента. FAIL приведет к завершению задачи. Значение по умолчанию — RESTART.

useDefaultTools -> (булево)

Булево значение, указывающее, использовать ли стандартные инструменты приложения моделирования. Стандартные инструменты — rviz, rqt, терминал и запись rosbag. Значение по умолчанию — False.

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

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

dataSources -> (список)

Укажите источники данных для подключения файлов для чтения из S3 к вашему моделированию. Эти файлы доступны в /opt/robomaker/datasources/data_source_name.

Примечание

Есть ограничение в 100 файлов и общий размер 25 ГБ для всех объектов DataSourceConfig.

(структура)

Информация об источнике данных.

name -> (строка)

Имя источника данных.

s3Bucket -> (строка)

Ведро S3, где находятся файлы данных.

s3Keys -> (список)

Список ключей S3, идентифицирующих файлы источника данных.

(строка)

type -> (строка)

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

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

destination -> (строка)

Расположение, где ваши файлы подключены в образе контейнера.

Если вы указали type источника данных как Archive, вы должны предоставить ключ объекта Amazon S3 для вашего архива. Ключ объекта должен указывать на файл .zip или .tar.gz.

Если вы указали type источника данных как префикс Prefix, вы предоставляете префикс Amazon S3, который указывает на файлы, используемые для вашего источника данных.

Если вы указали type источника данных как File, вы предоставляете путь Amazon S3 к файлу, используемому в качестве источника данных.

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

Если ваша задача моделирования обращается к ресурсам в VPC, вы предоставляете этот параметр, определяющий список идентификаторов сетевых групп и идентификаторов подсетей. Они должны принадлежать одной VPC. Вы должны предоставить как минимум одну сетевую группу и два идентификатора подсетей.

subnets -> (список)

Список одного или нескольких идентификаторов подсетей в вашей VPC.

(строка)

securityGroups -> (список)

Список одного или нескольких идентификаторов сетевых групп в вашей VPC.

(строка)

assignPublicIp -> (булево)

Булево значение, указывающее, нужно ли назначить общедоступный IP-адрес.

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

Информация о вычислительных ресурсах для задачи моделирования

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

Предел единиц моделирования. Вашему моделированию выделяется процессор и память пропорционально предоставленному пределу единиц моделирования. Одна единица моделирования — 1 vCPU и 2 ГБ памяти. Вы платите только за использование единиц моделирования до максимального предоставленного значения. Значение по умолчанию — 15.

computeType -> (строка)

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

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

Предел единиц GPU для задачи моделирования. Он соответствует количеству GPU, выделенных для SimulationJob.

tags -> (словарь)

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

key -> (строка)

value -> (строка)

failureReason -> (строка)

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

failureCode -> (строка)

Код ошибки.

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

Время (в миллисекундах с начала эпохи), когда пакет заданий моделирования завершился с ошибкой.

pendingRequests -> (список)

Список ожидающих запросов на задание моделирования. Эти запросы пока не были созданы в задания моделирования.

(структура)

Информация о запросе задания моделирования.

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

Место расположения вывода.

s3Bucket -> (строка)

Ведро S3 для вывода.

s3Prefix -> (строка)

Папка S3 в s3Bucket, где будут размещены выходные файлы.

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

Настройка ведения журнала.

recordAllRosTopics -> (булево)

Булево значение, указывающее, следует ли записывать все темы ROS.

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

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

maxJobDurationInSeconds -> (целое)

Максимальная продолжительность задания моделирования в секундах. Значение должно быть 8 дней (691 200 секунд) или меньше.

iamRole -> (строка)

Имя роли IAM, разрешающей экземпляру моделирования вызывать API AWS, указанные в связанных политиках от вашего имени. Это способ передачи учетных данных в задание моделирования.

failureBehavior -> (строка)

Поведение при ошибке задания моделирования.

Continue

Оставляет хост работающим до максимального времени ожидания после появления ошибки с кодом 4XX.

Fail

Останавливает задание моделирования и завершает работу экземпляра.

useDefaultApplications -> (булево)

Булево значение, указывающее, следует ли использовать по умолчанию приложения в задании моделирования. Приложения по умолчанию включают Gazebo, rqt, rviz и доступ к терминалу.

robotApplications -> (список)

Приложения робота для использования в задании моделирования.

(структура)

Информация о настройке приложения для робота.

application -> (строка)

Информация об приложении для приложения робота.

applicationVersion -> (строка)

Версия приложения робота.

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

Настройка запуска для приложения робота.

packageName -> (строка)

Имя пакета.

launchFile -> (строка)

Имя файла запуска.

environmentVariables -> (карта)

Переменные среды для запуска приложения.

key -> (строка)

value -> (строка)

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

Настройка переадресации портов.

portMappings -> (список)

Настройки сопоставления портов для конфигурации.

(структура)

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

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

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

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

Номер порта в приложении.

enableOnPublicIp -> (булево)

Булево значение, указывающее, следует ли включить это сопоставление портов на общедоступном IP-адресе.

streamUI -> (булево)

Булево значение, указывающее, будет ли настроена сессия потоковой передачи для приложения. Если True, AWS RoboMaker настроит подключение, чтобы вы могли взаимодействовать с приложением во время его выполнения в моделировании. Вы должны настроить и запустить компонент. Он должен иметь графический интерфейс пользователя.

command -> (список)

Если вы указали General в качестве значения для RobotSoftwareSuite, вы можете использовать это поле для указания списка команд для вашей контейнерной образы.

Если вы указали SimulationRuntime в качестве значения для SimulationSoftwareSuite, вы можете использовать это поле для указания списка команд для вашей контейнерной образы.

(строка)

uploadConfigurations -> (список)

Настройки загрузки для приложения робота.

(структура)

Предоставляет информацию о настройках загрузки. Файлы загружаются из задания моделирования в указанное вами расположение.

name -> (строка)

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

Например, если расположение вывода моделирования s3://amzn-s3-demo-bucket, а имя вашей конфигурации загрузки robot-test, ваши файлы будут загружены в s3://amzn-s3-demo-bucket/<simid>/<runid>/robot-test.

path -> (строка)

Указывает путь к файлу(ам) для загрузки. Принимаются стандартные правила сопоставления Unix glob, с добавлением ** как суперзвездочка. Например, указание /var/log/**.log приводит к сбору всех файлов .log в дереве каталогов /var/log. Для получения дополнительных примеров см. Библиотеку Glob.

uploadBehavior -> (строка)

Указывает, когда загрузить файлы:

UPLOAD_ON_TERMINATE

Соответствующие файлы загружаются, когда моделирование переходит в состояние TERMINATING. Соответствующие файлы не загружаются до тех пор, пока весь ваш код (включая инструменты) не остановится.

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

UPLOAD_ROLLING_AUTO_REMOVE

Соответствующие файлы загружаются по мере их создания. Они удаляются после загрузки. Указанный путь проверяется каждые 5 секунд. Окончательная проверка выполняется, когда весь ваш код (включая инструменты) остановится.

useDefaultUploadConfigurations -> (булево)

Булево значение, указывающее, следует ли использовать настройки загрузки по умолчанию. По умолчанию файлы .ros и .gazebo загружаются при завершении работы приложения, а все темы ROS записываются.

Если вы установили это значение, вы должны указать outputLocation.

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

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

tools -> (список)

Информация о инструментах, настроенных для приложения робота.

(структура)

Информация об инструменте. Инструменты используются в задании моделирования.

streamUI -> (булево)

Булево значение, указывающее, будет ли настроена сессия потоковой передачи для инструмента. Если True, AWS RoboMaker настроит подключение, чтобы вы могли взаимодействовать с инструментом во время его выполнения в моделировании. Он должен иметь графический интерфейс пользователя. По умолчанию False.

name -> (строка)

Название инструмента.

command -> (строка)

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

streamOutputToCloudWatch -> (булево)

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

exitBehavior -> (строка)

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

useDefaultTools -> (булево)

Булево значение, указывающее, следует ли использовать инструменты приложения робота по умолчанию. Инструменты по умолчанию — rviz, rqt, терминал и rosbag record. По умолчанию False.

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

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

simulationApplications -> (список)

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

(структура)

Информация о конфигурации приложения моделирования.

application -> (строка)

Информация об приложении моделирования.

applicationVersion -> (строка)

Версия приложения моделирования.

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

Конфигурация запуска приложения моделирования.

packageName -> (строка)

Имя пакета.

launchFile -> (строка)

Имя файла запуска.

environmentVariables -> (карта)

Переменные среды для запуска приложения.

key -> (строка)

value -> (строка)

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

Конфигурация перенаправления портов.

portMappings -> (список)

Сопоставления портов для конфигурации.

(структура)

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

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

Номер порта на экземпляре задачи моделирования, используемый в качестве точки удалённого подключения.

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

Номер порта в приложении.

enableOnPublicIp -> (булево)

Логическое значение, указывающее, нужно ли включить это сопоставление портов для публичного IP-адреса.

streamUI -> (булево)

Логическое значение, указывающее, будет ли настроено сеанс потоковой передачи для приложения. Если значение True, AWS RoboMaker настроит подключение, позволяющее взаимодействовать с вашим приложением во время моделирования. Вам необходимо настроить и запустить компонент. Он должен иметь графический пользовательский интерфейс.

command -> (список)

Если вы указали General в качестве значения для RobotSoftwareSuite, вы можете использовать это поле для указания списка команд для вашего контейнера.

Если вы указали SimulationRuntime в качестве значения для SimulationSoftwareSuite, вы можете использовать это поле для указания списка команд для вашего контейнера.

(строка)

uploadConfigurations -> (список)

Информация о конфигурациях загрузки для приложения моделирования.

(структура)

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

name -> (строка)

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

Например, если расположение вывода моделирования — s3://amzn-s3-demo-bucket, а имя вашей конфигурации загрузки — robot-test, ваши файлы будут загружены в s3://amzn-s3-demo-bucket/<simid>/<runid>/robot-test.

path -> (строка)

Указывает путь к файлам для загрузки. Принимаются стандартные правила сопоставления Unix glob, с добавлением ** в качестве суперзвездочки. Например, указание /var/log/**.log собирает все файлы .log в дереве каталогов /var/log. Более подробные примеры см. в библиотеке Glob.

uploadBehavior -> (строка)

Указывает, когда загружать файлы:

UPLOAD_ON_TERMINATE

Соответствующие файлы загружаются, когда моделирование переходит в состояние TERMINATING. Соответствующие файлы не загружаются, пока не остановятся все ваши программы (включая инструменты).

Если возникнет проблема с загрузкой файла, загрузка будет повторёна. Если проблемы повторяются, дальнейшие попытки загрузки не будут предприниматься.

UPLOAD_ROLLING_AUTO_REMOVE

Соответствующие файлы загружаются по мере создания. Они удаляются после загрузки. Указанный путь проверяется каждые 5 секунд. Окончательная проверка выполняется после остановки всех ваших программ (включая инструменты).

worldConfigs -> (список)

Список конфигураций мира.

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

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

(структура)

Информация о конфигурации мира.

world -> (строка)

Мир, сгенерированный Simulation WorldForge.

useDefaultUploadConfigurations -> (булево)

Логическое значение, указывающее, нужно ли использовать значения по умолчанию для конфигураций загрузки. По умолчанию загружаются файлы .ros и .gazebo при завершении приложения, а все темы ROS записываются.

Если вы задаёте это значение, вы должны указать outputLocation.

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

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

tools -> (список)

Информация об инструментах, настроенных для приложения моделирования.

(структура)

Информация об инструменте. Инструменты используются в задаче моделирования.

streamUI -> (булево)

Логическое значение, указывающее, будет ли настроено сеанс потоковой передачи для инструмента. Если значение True, AWS RoboMaker настроит подключение, позволяющее взаимодействовать с инструментом во время моделирования. Он должен иметь графический пользовательский интерфейс. Значение по умолчанию — False.

name -> (строка)

Имя инструмента.

command -> (строка)

Аргументы командной строки для инструмента. Должно включать имя исполняемого файла инструмента.

streamOutputToCloudWatch -> (булево)

Логическое значение, указывающее, будут ли записываться журналы в CloudWatch для инструмента. Значение по умолчанию — False.

exitBehavior -> (строка)

Поведение при выходе определяет, что происходит, когда ваш инструмент завершает работу. RESTART приведет к перезапуску инструмента. FAIL приведет к завершению задачи. Значение по умолчанию — RESTART.

useDefaultTools -> (булево)

Логическое значение, указывающее, нужно ли использовать инструменты моделирования по умолчанию. К инструментам по умолчанию относятся rviz, rqt, терминал и rosbag record. Значение по умолчанию — False.

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

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

dataSources -> (список)

Укажите источники данных для подключения файлов для чтения из S3 в вашу модель. Эти файлы доступны в /opt/robomaker/datasources/data_source_name.

Примечание

Существует ограничение в 100 файлов и общий объём 25 ГБ для всех объектов DataSourceConfig.

(структура)

Информация об источнике данных.

name -> (строка)

Название источника данных.

s3Bucket -> (строка)

Ведро S3, где находятся данные.

s3Keys -> (список)

Список ключей S3, идентифицирующих файлы источника данных.

(строка)

type -> (строка)

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

Если поле не указано, значение по умолчанию — File.

destination -> (строка)

Расположение, куда ваши файлы монтируются в контейнер.

Если вы указали type источника данных как Archive, вы должны указать ключ объекта Amazon S3 для архива. Ключ объекта должен указывать на .zip или .tar.gz файл.

Если вы указали type источника данных как Prefix, вы должны указать префикс Amazon S3, указывающий на файлы, используемые для источника данных.

Если вы указали type источника данных как File, вы должны указать путь к файлу Amazon S3, используемому в качестве источника данных.

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

Если ваша задача моделирования обращается к ресурсам в VPC, вы предоставляете этот параметр, определяющий список идентификаторов групп безопасности и идентификаторов подсетей. Они должны принадлежать одной VPC. Вы должны указать хотя бы одну группу безопасности и два идентификатора подсетей.

subnets -> (список)

Список одного или нескольких идентификаторов подсетей в вашей VPC.

(строка)

securityGroups -> (список)

Список одного или нескольких идентификаторов групп безопасности в вашей VPC.

(строка)

assignPublicIp -> (булево)

Булево значение, указывающее, нужно ли назначить публичный IP-адрес.

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

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

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

Предел единиц моделирования. Вашему моделированию выделяется процессор и память пропорционально предоставленному пределу единиц моделирования. Единица моделирования — 1 виртуальный процессор и 2 ГБ памяти. Вы оплачиваете только использованные единицы моделирования до максимального значения, указанного вами. Значение по умолчанию — 15.

computeType -> (строка)

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

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

Предел единиц вычислительных ресурсов GPU для задачи моделирования. Равно количеству GPU, выделенных для SimulationJob.

tags -> (карта)

Карта, содержащая ключи и значения тегов, прикреплённых к запросу задачи моделирования.

key -> (строка)

value -> (строка)

createdRequests -> (список)

Список созданных сводных данных задач моделирования.

(структура)

Сводная информация о задаче моделирования.

arn -> (строка)

Amazon Resource Name (ARN) задачи моделирования.

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

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

name -> (строка)

Название задачи моделирования.

status -> (строка)

Статус задачи моделирования.

simulationApplicationNames -> (список)

Список имён приложений моделирования для задачи моделирования.

(строка)

robotApplicationNames -> (список)

Список имён приложений робота для задачи моделирования.

(строка)

dataSourceNames -> (список)

Имена источников данных.

(строка)

computeType -> (строка)

Тип вычислений для сводной информации о задаче моделирования.

tags -> (карта)

Карта, содержащая ключи и значения тегов, прикреплённых к пакету задач моделирования.

key -> (строка)

value -> (строка)

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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