batch-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
Синтаксис
batch-describe-simulation-job
--jobs <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]
Параметры
--jobs (список)
Список Amazon Resource Names (ARN) работ симуляции для описания.
(строка)
Синтаксис:
"string" "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 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 в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для пакетного описания работ симуляции
Следующий batch-describe-simulation-job пример извлекает подробности о трех указанных работах симуляции.
Команда:
aws robomaker batch-describe-simulation-job \
--job arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-66bbb3gpxm8x arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-p0cpdrrwng2n arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-g8h6tglmblgw
Вывод:
{
"jobs": [
{
"arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-66bbb3gpxm8x",
"status": "Completed",
"lastUpdatedAt": 1548959178.0,
"failureBehavior": "Continue",
"clientRequestToken": "6020408e-b05c-4310-9f13-4ed71c5221ed",
"outputLocation": {
"s3Bucket": "awsrobomakerobjecttracker-111111111-bundlesbucket-2lk584kiq1oa",
"s3Prefix": "output"
},
"maxJobDurationInSeconds": 3600,
"simulationTimeMillis": 0,
"iamRole": "arn:aws:iam::111111111111:role/AWSRoboMakerObjectTracker-154895-SimulationJobRole-14D5ASA7PQE3A",
"simulationApplications": [
{
"application": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/AWSRoboMakerObjectTracker-1548959046124_NPvyfcatq/1548959170096",
"applicationVersion": "$LATEST",
"launchConfig": {
"packageName": "object_tracker_simulation",
"launchFile": "local_training.launch",
"environmentVariables": {
"MARKOV_PRESET_FILE": "object_tracker.py",
"MODEL_S3_BUCKET": "awsrobomakerobjecttracker-111111111-bundlesbucket-2lk584kiq1oa",
"MODEL_S3_PREFIX": "model-store",
"ROS_AWS_REGION": "us-west-2"
}
}
}
],
"tags": {},
"vpcConfig": {
"subnets": [
"subnet-716dd52a",
"subnet-43c22325",
"subnet-3f526976"
],
"securityGroups": [
"sg-3fb40545"
],
"vpcId": "vpc-99895eff",
"assignPublicIp": true
}
},
{
"arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-p0cpdrrwng2n",
"status": "Completed",
"lastUpdatedAt": 1548168817.0,
"failureBehavior": "Continue",
"clientRequestToken": "e4a23e75-f9a7-411d-835f-21881c82c58b",
"outputLocation": {
"s3Bucket": "awsrobomakercloudwatch-111111111111-bundlesbucket-14e5s9jvwtmv7",
"s3Prefix": "output"
},
"maxJobDurationInSeconds": 3600,
"simulationTimeMillis": 0,
"iamRole": "arn:aws:iam::111111111111:role/AWSRoboMakerCloudWatch-154766341-SimulationJobRole-G0OBWTQ8YBG6",
"robotApplications": [
{
"application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/AWSRoboMakerCloudWatch-1547663411642_NZbpqEJ3T/1547663517377",
"applicationVersion": "$LATEST",
"launchConfig": {
"packageName": "cloudwatch_robot",
"launchFile": "await_commands.launch",
"environmentVariables": {
"LAUNCH_ID": "1548168752173",
"ROS_AWS_REGION": "us-west-2"
}
}
}
],
"simulationApplications": [
{
"application": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/AWSRoboMakerCloudWatch-1547663411642_0LIt6D1h6/1547663521470",
"applicationVersion": "$LATEST",
"launchConfig": {
"packageName": "cloudwatch_simulation",
"launchFile": "bookstore_turtlebot_navigation.launch",
"environmentVariables": {
"LAUNCH_ID": "1548168752173",
"ROS_AWS_REGION": "us-west-2",
"TURTLEBOT3_MODEL": "waffle_pi"
}
}
}
],
"tags": {},
"vpcConfig": {
"subnets": [
"subnet-716dd52a",
"subnet-43c22325",
"subnet-3f526976"
],
"securityGroups": [
"sg-3fb40545"
],
"vpcId": "vpc-99895eff",
"assignPublicIp": true
}
},
{
"arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-g8h6tglmblgw",
"status": "Canceled",
"lastUpdatedAt": 1546543442.0,
"failureBehavior": "Fail",
"clientRequestToken": "d796bbb4-2a2c-1abc-f2a9-0d9e547d853f",
"outputLocation": {
"s3Bucket": "sample-bucket",
"s3Prefix": "SimulationLog_115490482698"
},
"maxJobDurationInSeconds": 28800,
"simulationTimeMillis": 0,
"iamRole": "arn:aws:iam::111111111111:role/RoboMakerSampleTheFirst",
"robotApplications": [
{
"application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/RoboMakerHelloWorldRobot/1546541208251",
"applicationVersion": "$LATEST",
"launchConfig": {
"packageName": "hello_world_robot",
"launchFile": "rotate.launch"
}
}
],
"simulationApplications": [
{
"application": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/RoboMakerHelloWorldSimulation/1546541198985",
"applicationVersion": "$LATEST",
"launchConfig": {
"packageName": "hello_world_simulation",
"launchFile": "empty_world.launch"
}
}
],
"tags": {}
}
],
"unprocessedJobs": []
}
Вывод
jobs -> (список)
Список заданий моделирования.
(структура)
Информация о задании моделирования.
arn -> (строка)
name -> (строка)
status -> (строка)
lastStartedAt -> (метка времени)
lastUpdatedAt -> (метка времени)
failureBehavior -> (строка)
Поведение при ошибке задания моделирования.
Оставляет хост работающим в течение максимального времени ожидания после ошибки 4XX.
Остановить задание моделирования и завершить экземпляр.
failureCode -> (строка)
failureReason -> (строка)
clientRequestToken -> (строка)
SimulationJob запроса.outputLocation -> (структура)
Расположение выходных файлов, сгенерированных заданием моделирования.
s3Bucket -> (строка)
s3Prefix -> (строка)
s3Bucket, куда будут помещены выходные файлы.loggingConfig -> (структура)
Настройка ведения журнала.
recordAllRosTopics -> (булево)
Булево значение, указывающее, нужно ли записывать все темы ROS.
Предупреждение
Этот API больше не поддерживается и вызовет ошибку при использовании.maxJobDurationInSeconds -> (целое)
simulationTimeMillis -> (целое)
iamRole -> (строка)
robotApplications -> (список)
Список приложений роботов.
(структура)
Информация о конфигурации приложения для робота.
application -> (строка)
applicationVersion -> (строка)
launchConfig -> (структура)
Настройка запуска приложения робота.
packageName -> (строка)
launchFile -> (строка)
environmentVariables -> (карта)
Переменные среды для запуска приложения.
key -> (строка)
value -> (строка)
portForwardingConfig -> (структура)
Настройка переадресации портов.
portMappings -> (список)
Сопоставления портов для конфигурации.
(структура)
Объект, представляющий сопоставление портов.
jobPort -> (целое)
applicationPort -> (целое)
enableOnPublicIp -> (булево)
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 -> (строка)
** в качестве «суперзвездочки». Например, указание /var/log/**.log приведет к сбору всех файлов .log в дереве каталогов /var/log. Дополнительные примеры см. в библиотеке Glob.uploadBehavior -> (строка)
Указывает, когда загружать файлы:
Соответствующие файлы загружаются, когда моделирование переходит в состояние TERMINATING. Соответствующие файлы не загружаются, пока весь ваш код (включая инструменты) не остановится.
Если возникнет проблема с загрузкой файла, загрузка будет повторена. Если проблемы сохраняются, дальнейшие попытки загрузки не будут производиться.
Соответствующие файлы загружаются по мере их создания. Они удаляются после загрузки. Указанный путь проверяется каждые 5 секунд. Окончательная проверка выполняется, когда весь ваш код (включая инструменты) остановится.
useDefaultUploadConfigurations -> (булево)
Булево значение, указывающее, использовать ли настройки загрузки по умолчанию. По умолчанию файлы .ros и .gazebo загружаются при завершении работы приложения, и все темы ROS будут записаны.
Если вы установите это значение, вы должны указать outputLocation.
Предупреждение
Этот API больше не поддерживается и вызовет ошибку при использовании.tools -> (список)
Информация о инструментах, настроенных для приложения робота.
(структура)
Информация об инструменте. Инструменты используются в задании моделирования.
streamUI -> (булево)
True, AWS RoboMaker настроит подключение, чтобы вы могли взаимодействовать с инструментом во время его работы в моделировании. Он должен иметь графический интерфейс пользователя. По умолчанию False.name -> (строка)
command -> (строка)
streamOutputToCloudWatch -> (булево)
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 -> (булево)
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 -> (строка)
** в качестве «супер-звездочки». Например, указание /var/log/**.log приведет к сбору всех файлов .log в дереве каталогов /var/log. Для получения дополнительных примеров см. Библиотеку Glob.uploadBehavior -> (строка)
Указывает, когда загружать файлы:
Соответствующие файлы загружаются, когда моделирование переходит в состояние TERMINATING. Соответствующие файлы не загружаются до тех пор, пока весь ваш код (включая инструменты) не остановится.
Если возникнет проблема с загрузкой файла, загрузка будет повторёна. Если проблемы сохраняются, дальнейшие попытки загрузки не будут предприниматься.
Соответствующие файлы загружаются по мере их создания. Они удаляются после загрузки. Указанный путь проверяется каждые 5 секунд. Окончательная проверка выполняется, когда весь ваш код (включая инструменты) остановится.
worldConfigs -> (список)
Список конфигураций мира.
Предупреждение
Этот API больше не поддерживается и вызовет ошибку при использовании.(структура)
Информация о конфигурации мира.
world -> (строка)
useDefaultUploadConfigurations -> (булево)
Булево значение, указывающее, следует ли использовать значения по умолчанию для конфигурации загрузки. По умолчанию файлы .ros и .gazebo загружаются при завершении приложения, а все темы ROS записываются.
Если вы установите это значение, вы должны указать outputLocation.
Предупреждение
Этот API больше не поддерживается и вызовет ошибку при использовании.tools -> (список)
Информация об инструментах, настроенных для приложения моделирования.
(структура)
Информация об инструменте. Инструменты используются в задании моделирования.
streamUI -> (булево)
True, AWS RoboMaker настроит подключение, чтобы вы могли взаимодействовать с инструментом во время его выполнения в моделировании. Он должен иметь графический пользовательский интерфейс. По умолчанию False.name -> (строка)
command -> (строка)
streamOutputToCloudWatch -> (булево)
False.exitBehavior -> (строка)
RESTART приведет к перезапуску инструмента. FAIL приведет к завершению задания. По умолчанию RESTART.useDefaultTools -> (булево)
Булево значение, указывающее, следует ли использовать инструменты моделирования по умолчанию. Инструменты по умолчанию — rviz, rqt, терминал и rosbag record. По умолчанию False.
Предупреждение
Этот API больше не поддерживается и вызовет ошибку при использовании.dataSources -> (список)
Источники данных для задания моделирования.
(структура)
Информация об источнике данных.
name -> (строка)
s3Bucket -> (строка)
s3Keys -> (список)
Список ключей S3, определяющих файлы источника данных.
(структура)
Информация о ключах S3.
s3Key -> (строка)
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 -> (строка)
assignPublicIp -> (булево)
networkInterface -> (структура)
Информация о сетевом интерфейсе.
networkInterfaceId -> (строка)
privateIpAddress -> (строка)
publicIpAddress -> (строка)
compute -> (структура)
Информация о вычислениях для задания моделирования.
simulationUnitLimit -> (целое число)
computeType -> (строка)
gpuUnitLimit -> (целое число)
unprocessedJobs -> (список)
Список необработанных Amazon Resource Names (ARN) заданий моделирования.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.