Spec-Zone.ru › AWS CLI v2

[ aws . robomaker ]

describe-simulation-job

Описание

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

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

Параметры

--job (строка)

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

--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
  • 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.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве «Начало работы» в «Руководстве пользователя AWS CLI».

Если не указано иное, все примеры используют правила цитирования, похожие на Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в «Руководстве пользователя AWS CLI».

Чтобы описать задание симуляции

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

Команда:

aws robomaker describe-simulation-job --job arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-pql32v7pfjy6

Вывод:

{
  "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-pql32v7pfjy6",
  "status": "Running",
  "lastUpdatedAt": 1551219349.0,
  "failureBehavior": "Continue",
  "clientRequestToken": "a19ec4b5-e50d-3591-33da-c2e593c60615",
  "outputLocation": {
      "s3Bucket": "my-output-bucket",
      "s3Prefix": "output"
  },
  "maxJobDurationInSeconds": 3600,
  "simulationTimeMillis": 0,
  "iamRole": "arn:aws:iam::111111111111:role/MySimulationRole",
  "robotApplications": [
      {
          "application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551206341136",
          "applicationVersion": "$LATEST",
          "launchConfig": {
              "packageName": "hello_world_robot",
              "launchFile": "rotate.launch"
          }
      }
  ],
  "simulationApplications": [
      {
          "application": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/MySimulationApplication/1551206347967",
          "applicationVersion": "$LATEST",
          "launchConfig": {
              "packageName": "hello_world_simulation",
              "launchFile": "empty_world.launch"
          }
      }
  ],
  "tags": {}
}

Вывод

arn -> (строка)

Идентификатор ресурса Amazon (ARN) задания симуляции.

name -> (строка)

Имя задания симуляции.

status -> (строка)

Статус задания симуляции.

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

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

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

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

failureBehavior -> (строка)

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

failureCode -> (строка)

Код ошибки задания симуляции, если оно завершилось ошибкой:

InternalServiceError

Ошибка внутренней службы.

RobotApplicationCrash

Приложение робота аварийно завершило работу.

SimulationApplicationCrash

Приложение симуляции аварийно завершило работу.

BadPermissionsRobotApplication

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

BadPermissionsSimulationApplication

Пакет приложения симуляции не удалось загрузить.

BadPermissionsS3Output

Не удалось опубликовать выходные данные в пользовательский S3-ведро.

BadPermissionsCloudwatchLogs

Не удалось опубликовать журналы в пользовательский ресурс CloudWatch Logs.

SubnetIpLimitExceeded

Превышен лимит IP-адресов подсети.

ENILimitExceeded

Превышен лимит ENI.

BadPermissionsUserCredentials

Невозможно использовать предоставленную роль.

InvalidBundleRobotApplication

Пакет робота невозможно распаковать (неверный формат, ошибка упаковки или другая проблема).

InvalidBundleSimulationApplication

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

RobotApplicationVersionMismatchedEtag

Элемент Etag для RobotApplication не совпадает со значением при создании версии.

SimulationApplicationVersionMismatchedEtag

Элемент Etag для SimulationApplication не совпадает со значением при создании версии.

failureReason -> (строка)

Подробности о причинах сбоя задания симуляции. Дополнительную информацию о поиске неисправностей см. в разделе Устранение неполадок.

clientRequestToken -> (строка)

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

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

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

s3Bucket -> (строка)

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

s3Prefix -> (строка)

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

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

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

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

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

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

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

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

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

simulationTimeMillis -> (длинное целое)

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

iamRole -> (строка)

Роль IAM, которая позволяет экземпляру симуляции вызывать API AWS, указанные в связанных политиках от вашего имени.

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 -> (список)

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

(структура)

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

name -> (строка)

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

s3Bucket -> (строка)

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

s3Keys -> (список)

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

(структура)

Информация о ключах S3.

s3Key -> (строка)

Ключ S3.

etag -> (строка)

ЭТЭГ объекта.

type -> (строка)

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

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

destination -> (строка)

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

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

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

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

tags -> (отображение)

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

key -> (строка)

value -> (строка)

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

Конфигурация VPC.

subnets -> (список)

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

(строка)

securityGroups -> (список)

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

(строка)

vpcId -> (строка)

Идентификатор VPC, связанный с заданием моделирования.

assignPublicIp -> (булево)

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

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

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

networkInterfaceId -> (строка)

Идентификатор сетевого интерфейса.

privateIpAddress -> (строка)

IP-адрес IPv4 сетевого интерфейса в подсети.

publicIpAddress -> (строка)

Общедоступный IP-адрес IPv4 сетевого интерфейса.

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

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

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

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

computeType -> (строка)

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

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

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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