DescribeSimulationJobBatch - AWS RoboMaker

Avis de fin de support : le 10 septembre 2025, AWS le support de AWS RoboMaker. Après le 10 septembre 2025, vous ne pourrez plus accéder à la AWS RoboMaker console ni aux AWS RoboMaker ressources. Pour plus d'informations sur la transition AWS Batch afin de faciliter l'exécution de simulations conteneurisées, consultez ce billet de blog.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

DescribeSimulationJobBatch

Important

Avis de fin de support : le 10 septembre 2025, AWS le support de AWS RoboMaker. Après le 10 septembre 2025, vous ne pourrez plus accéder à la AWS RoboMaker console ni aux AWS RoboMaker ressources. Pour plus d'informations sur la transition AWS Batch afin de faciliter l'exécution de simulations conteneurisées, consultez ce billet de blog.

Décrit un lot de tâches de simulation.

Syntaxe de la requête

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

URIParamètres de demande

La demande n'utilise aucun URI paramètre.

Corps de la requête

La demande accepte les données suivantes au JSON format suivant.

batch

L'identifiant du lot à décrire.

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 1224.

Modèle : arn:.*

Obligatoire : oui

Syntaxe de la réponse

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" } }

Eléments de réponse

Si l'action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées sous JSON forme formatée par le service.

arn

Le nom de la ressource Amazon (ARN) du lot.

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 1224.

Modèle : arn:.*

batchPolicy

La politique de traitement par lots.

Type : objet BatchPolicy

clientRequestToken

Identifiant unique distinguant majuscules et minuscules que vous fournissez pour garantir l'idempuissance de la demande.

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

Modèle : [a-zA-Z0-9_\-=]*

createdAt

Heure, en millisecondes, depuis l'époque, à laquelle le lot de tâches de simulation a été créé.

Type : Timestamp

createdRequests

Liste des résumés des tâches de simulation créées.

Type : tableau d’objets SimulationJobSummary

Membres du tableau : nombre minimum de 0 élément. Nombre maximal de 100 éléments.

failedRequests

Liste des demandes de tâches de création de simulation qui ont échoué. La demande n'a pas pu être créée dans une tâche de simulation. Les demandes ayant échoué n'ont pas d'ID de tâche de simulation.

Type : tableau d’objets FailedCreateSimulationJobRequest

failureCode

Code d'échec du lot de tâches de simulation.

Type : String

Valeurs valides : InternalServiceError

failureReason

La raison pour laquelle le lot de tâches de simulation a échoué.

Type : String

Contraintes de longueur : longueur minimum de 0. Longueur maximum de 1024.

Modèle : .*

lastUpdatedAt

Heure, en millisecondes écoulée depuis l'époque, à laquelle le lot de tâches de simulation a été mis à jour pour la dernière fois.

Type : Timestamp

pendingRequests

Liste des demandes de tâches de simulation en attente. Ces demandes n'ont pas encore été intégrées dans des tâches de simulation.

Type : tableau d’objets SimulationJobRequest

Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 1 000 éléments.

status

État du lot.

En attente

La demande groupée de tâches de simulation est en attente.

InProgress

Le lot de tâches de simulation est en cours.

Échec

Le lot de tâches de simulation a échoué. Une ou plusieurs demandes de tâches de simulation n'ont pas pu être traitées en raison d'une défaillance interne (par exempleInternalServiceError). Pour plus d’informations, consultez failureCode et failureReason.

Terminé

La tâche de simulation par lots est terminée. Un lot est complet lorsque (1) il n'y a aucune demande de tâche de simulation en attente dans le lot et qu'aucune des demandes de tâches de simulation ayant échoué n'est due InternalServiceError et (2) lorsque toutes les tâches de simulation créées ont atteint un état terminal (par exemple, Completed ouFailed).

Annulé

La tâche de simulation par lots a été annulée.

Annulation

La tâche de simulation par lots est annulée.

Achèvement

La tâche de simulation par lots est terminée.

TimingOut

Le lot de tâches de simulation arrive à expiration.

Si le délai d'expiration d'un lot est dépassé et que certaines demandes en attente ont échoué en raison d'une défaillance interne (par exempleInternalServiceError), le statut du lot sera le suivantFailed. Si aucune demande de ce type n'échoue, le statut du lot seraTimedOut.

TimedOut

Le délai imparti pour le traitement par lots de simulation a expiré.

Type : String

Valeurs valides : Pending | InProgress | Failed | Completed | Canceled | Canceling | Completing | TimingOut | TimedOut

tags

Carte contenant les clés de balise et les valeurs de balise associées au lot de tâches de simulation.

Type : mappage chaîne/chaîne

Entrées cartographiques : nombre minimum de 0 éléments. Nombre maximal de 50 éléments.

Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.

Modèle de clé :[a-zA-Z0-9 _.\-\/+=:]*

Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.

Modèle de valeur : [a-zA-Z0-9 _.\-\/+=:]*

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

InternalServerException

AWS RoboMaker a rencontré un problème de service. Renouvelez votre appel.

HTTPCode de statut : 500

InvalidParameterException

Un paramètre spécifié dans une demande n'est pas valide, n'est pas pris en charge ou ne peut pas être utilisé. Le message renvoyé fournit une explication de la valeur d'erreur.

HTTPCode de statut : 400

ResourceNotFoundException

La ressource spécifiée n'existe pas.

HTTPCode de statut : 400

consultez aussi

Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :