DescribeSimulationJobBatch - AWS RoboMaker

Aviso de fin del soporte: el 10 de septiembre de 2025, AWS dejaremos de ofrecer soporte a AWS RoboMaker. Después del 10 de septiembre de 2025, ya no podrás acceder a la AWS RoboMaker consola ni a AWS RoboMaker los recursos. Para obtener más información sobre la transición para ayudar AWS Batch a ejecutar simulaciones en contenedores, visite esta entrada de blog.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

DescribeSimulationJobBatch

importante

Aviso de fin de soporte: el 10 de septiembre de 2025, AWS suspenderemos el soporte para AWS RoboMaker. Después del 10 de septiembre de 2025, ya no podrás acceder a la AWS RoboMaker consola ni a AWS RoboMaker los recursos. Para obtener más información sobre la transición para ayudar AWS Batch a ejecutar simulaciones en contenedores, visite esta entrada de blog.

Describe un lote de trabajos de simulación.

Sintaxis de la solicitud

POST /describeSimulationJobBatch HTTP/1.1 Content-type: application/json { "batch": "string" }

URIParámetros de solicitud

La solicitud no utiliza ningún URI parámetro.

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en JSON formato.

batch

El ID del objeto que se va a describir.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 1224.

Patrón: arn:.*

Obligatorio: sí

Sintaxis de la respuesta

HTTP/1.1 200 Content-type: application/json { "arn": "string", "batchPolicy": { "maxConcurrency": number, "timeoutInSeconds": number }, "clientRequestToken": "string", "createdAt": number, "createdRequests": [ { "arn": "string", "computeType": "string", "dataSourceNames": [ "string" ], "lastUpdatedAt": number, "name": "string", "robotApplicationNames": [ "string" ], "simulationApplicationNames": [ "string" ], "status": "string" } ], "failedRequests": [ { "failedAt": number, "failureCode": "string", "failureReason": "string", "request": { "compute": { "computeType": "string", "gpuUnitLimit": number, "simulationUnitLimit": number }, "dataSources": [ { "destination": "string", "name": "string", "s3Bucket": "string", "s3Keys": [ "string" ], "type": "string" } ], "failureBehavior": "string", "iamRole": "string", "loggingConfig": { "recordAllRosTopics": boolean }, "maxJobDurationInSeconds": number, "outputLocation": { "s3Bucket": "string", "s3Prefix": "string" }, "robotApplications": [ { "application": "string", "applicationVersion": "string", "launchConfig": { "command": [ "string" ], "environmentVariables": { "string" : "string" }, "launchFile": "string", "packageName": "string", "portForwardingConfig": { "portMappings": [ { "applicationPort": number, "enableOnPublicIp": boolean, "jobPort": number } ] }, "streamUI": boolean }, "tools": [ { "command": "string", "exitBehavior": "string", "name": "string", "streamOutputToCloudWatch": boolean, "streamUI": boolean } ], "uploadConfigurations": [ { "name": "string", "path": "string", "uploadBehavior": "string" } ], "useDefaultTools": boolean, "useDefaultUploadConfigurations": boolean } ], "simulationApplications": [ { "application": "string", "applicationVersion": "string", "launchConfig": { "command": [ "string" ], "environmentVariables": { "string" : "string" }, "launchFile": "string", "packageName": "string", "portForwardingConfig": { "portMappings": [ { "applicationPort": number, "enableOnPublicIp": boolean, "jobPort": number } ] }, "streamUI": boolean }, "tools": [ { "command": "string", "exitBehavior": "string", "name": "string", "streamOutputToCloudWatch": boolean, "streamUI": boolean } ], "uploadConfigurations": [ { "name": "string", "path": "string", "uploadBehavior": "string" } ], "useDefaultTools": boolean, "useDefaultUploadConfigurations": boolean, "worldConfigs": [ { "world": "string" } ] } ], "tags": { "string" : "string" }, "useDefaultApplications": boolean, "vpcConfig": { "assignPublicIp": boolean, "securityGroups": [ "string" ], "subnets": [ "string" ] } } } ], "failureCode": "string", "failureReason": "string", "lastUpdatedAt": number, "pendingRequests": [ { "compute": { "computeType": "string", "gpuUnitLimit": number, "simulationUnitLimit": number }, "dataSources": [ { "destination": "string", "name": "string", "s3Bucket": "string", "s3Keys": [ "string" ], "type": "string" } ], "failureBehavior": "string", "iamRole": "string", "loggingConfig": { "recordAllRosTopics": boolean }, "maxJobDurationInSeconds": number, "outputLocation": { "s3Bucket": "string", "s3Prefix": "string" }, "robotApplications": [ { "application": "string", "applicationVersion": "string", "launchConfig": { "command": [ "string" ], "environmentVariables": { "string" : "string" }, "launchFile": "string", "packageName": "string", "portForwardingConfig": { "portMappings": [ { "applicationPort": number, "enableOnPublicIp": boolean, "jobPort": number } ] }, "streamUI": boolean }, "tools": [ { "command": "string", "exitBehavior": "string", "name": "string", "streamOutputToCloudWatch": boolean, "streamUI": boolean } ], "uploadConfigurations": [ { "name": "string", "path": "string", "uploadBehavior": "string" } ], "useDefaultTools": boolean, "useDefaultUploadConfigurations": boolean } ], "simulationApplications": [ { "application": "string", "applicationVersion": "string", "launchConfig": { "command": [ "string" ], "environmentVariables": { "string" : "string" }, "launchFile": "string", "packageName": "string", "portForwardingConfig": { "portMappings": [ { "applicationPort": number, "enableOnPublicIp": boolean, "jobPort": number } ] }, "streamUI": boolean }, "tools": [ { "command": "string", "exitBehavior": "string", "name": "string", "streamOutputToCloudWatch": boolean, "streamUI": boolean } ], "uploadConfigurations": [ { "name": "string", "path": "string", "uploadBehavior": "string" } ], "useDefaultTools": boolean, "useDefaultUploadConfigurations": boolean, "worldConfigs": [ { "world": "string" } ] } ], "tags": { "string" : "string" }, "useDefaultApplications": boolean, "vpcConfig": { "assignPublicIp": boolean, "securityGroups": [ "string" ], "subnets": [ "string" ] } } ], "status": "string", "tags": { "string" : "string" } }

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta de HTTP 200.

El servicio devuelve los siguientes datos en JSON formato.

arn

El nombre del recurso de Amazon (ARN) del lote.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 1224.

Patrón: arn:.*

batchPolicy

La política de lotes.

Tipo: objeto BatchPolicy

clientRequestToken

Identificador único con distinción entre mayúsculas y minúsculas que se proporciona para garantizar la idempotencia de la solicitud.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 64.

Patrón: [a-zA-Z0-9_\-=]*

createdAt

El tiempo, en milisegundos, desde la fecha de inicio, cuando se creó el lote de trabajos de simulación.

Tipo: marca temporal

createdRequests

Una lista con los resúmenes de los trabajos de simulación creados.

Tipo: matriz de objetos SimulationJobSummary

Miembros de la matriz: número mínimo de 0 artículos. Número máximo de 100 artículos.

failedRequests

Una lista con las solicitudes de trabajos de simulación fallidas. No se ha podido crear la solicitud en un trabajo de simulación. Las solicitudes fallidas no tienen un ID de trabajo de simulación.

Tipo: matriz de objetos FailedCreateSimulationJobRequest

failureCode

El código de error del lote de trabajos de simulación.

Tipo: cadena

Valores válidos: InternalServiceError

failureReason

El motivo por el que se produjo un error en el lote de trabajos de simulación.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 1024 caracteres.

Patrón: .*

lastUpdatedAt

El tiempo, en milisegundos, desde la fecha de inicio, cuando se actualizó el lote de trabajos de simulación por última vez.

Tipo: marca temporal

pendingRequests

Lista de solicitudes de trabajos de simulación pendientes. Estas solicitudes no se han convertido todavía en trabajos de simulación.

Tipo: matriz de objetos SimulationJobRequest

Miembros de la matriz: número mínimo de 1 artículo. La cantidad máxima es de 1000 elementos.

status

El estado del lote.

Pendiente

Solicitud del lote de trabajos de simulación pendiente.

InProgress

El lote de trabajos de simulación está en curso.

Con error

Lote de trabajos de simulación fallido. No se pudieron completar una o más solicitudes de trabajo de simulación debido a un fallo interno (por ejemplo, InternalServiceError). Para obtener más información, consulte failureCode y failureReason.

Finalizado

Se ha completado el trabajo del lote de simulación. Un lote está completo cuando (1) no hay solicitudes de trabajos de simulación pendientes en el lote y ninguna de las solicitudes de trabajos de simulación fallidas se debe a InternalServiceError y (2) cuando todos los trabajos de simulación creados han alcanzado un estado terminal (por ejemplo, Completed o Failed).

Cancelado

Se ha cancelado el trabajo del lote de simulación.

Cancelando

Se está cancelando el lote de trabajos de simulación.

En finalización

Se está completando el lote de trabajos de simulación.

TimingOut

Se está agotando el tiempo de espera del lote de trabajos de simulación.

Si se está agotando el tiempo de espera de un lote y hay solicitudes pendientes que no se han podido procesar debido a un fallo interno (por ejemplo, InternalServiceError), el estado del lote será Failed. Si no se ha producido ningún fallo relacionado con una solicitud, el estado del lote será TimedOut.

TimedOut

Se agotó el tiempo de espera del lote de trabajos de simulación.

Tipo: cadena

Valores válidos: Pending | InProgress | Failed | Completed | Canceled | Canceling | Completing | TimingOut | TimedOut

tags

Un mapa que contiene las claves y los valores de las etiquetas que se asocian al lote de trabajos de simulación.

Tipo: mapa de cadena a cadena

Entradas de mapa: número mínimo de 0 elementos. Número máximo de 50 artículos.

Limitaciones de longitud de la clave: longitud mínima de 1. Longitud máxima de 128.

Patrón de clave: [a-zA-Z0-9 _.\-\/+=:]*

Limitaciones de longitud de los valores: longitud mínima de 0. La longitud máxima es de 256 caracteres.

Patrón de valores: [a-zA-Z0-9 _.\-\/+=:]*

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

InternalServerException

AWS RoboMaker ha sufrido un problema de servicio. Pruebe la llamada de nuevo.

HTTPCódigo de estado: 500

InvalidParameterException

Un parámetro especificado en una solicitud no es válido, no se admite o no se puede utilizar. El mensaje devuelto proporciona una explicación del valor del error.

HTTPCódigo de estado: 400

ResourceNotFoundException

El recurso especificado no existe.

HTTPCódigo de estado: 400

Véase también

Para obtener más información sobre cómo usarlo API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente: