DescribeSimulationJob - AWS RoboMaker
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursconsultez aussi

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.

DescribeSimulationJob

Décrit une tâche de simulation.

Syntaxe de la demande

POST /describeSimulationJob HTTP/1.1
Content-type: application/json

{
   "job": "string"
}

Paramètres de demande URI

La demande n’utilise pas de paramètres URI.

Corps de la demande

Cette demande accepte les données suivantes au format JSON.

job

Le nom de ressource Amazon (ARN) de la tâche de simulation à décrire.

Type : chaîne

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",
   "clientRequestToken": "string",
   "compute": { 
      "computeType": "string",
      "gpuUnitLimit": number,
      "simulationUnitLimit": number
   },
   "dataSources": [ 
      { 
         "destination": "string",
         "name": "string",
         "s3Bucket": "string",
         "s3Keys": [ 
            { 
               "etag": "string",
               "s3Key": "string"
            }
         ],
         "type": "string"
      }
   ],
   "failureBehavior": "string",
   "failureCode": "string",
   "failureReason": "string",
   "iamRole": "string",
   "lastStartedAt": number,
   "lastUpdatedAt": number,
   "loggingConfig": { 
      "recordAllRosTopics": boolean
   },
   "maxJobDurationInSeconds": number,
   "name": "string",
   "networkInterface": { 
      "networkInterfaceId": "string",
      "privateIpAddress": "string",
      "publicIpAddress": "string"
   },
   "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"
            }
         ]
      }
   ],
   "simulationTimeMillis": number,
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "vpcConfig": { 
      "assignPublicIp": boolean,
      "securityGroups": [ "string" ],
      "subnets": [ "string" ],
      "vpcId": "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 au format JSON par le service.

arn

Nom de ressource Amazon (ARN) de la tâche de simulation.

Type : chaîne

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

Modèle : arn:.*

clientRequestToken

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

Type : chaîne

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

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

compute

Calculez les informations nécessaires à la tâche de simulation.

Type : objet ComputeResponse

dataSources

Les sources de données pour la tâche de simulation.

Type : tableau d’objets DataSource

failureBehavior

Comportement d'échec de la tâche de simulation.

Type : chaîne

Valeurs valides : Fail | Continue

failureCode

Le code d'échec de la tâche de simulation en cas d'échec :

InternalServiceError

Erreur de service interne.

RobotApplicationCrash

L'application du robot s'est terminée anormalement.

SimulationApplicationCrash

L'application de simulation s'est terminée de manière anormale.

BadPermissionsRobotApplication

Le bundle d'applications du robot n'a pas pu être téléchargé.

BadPermissionsSimulationApplication

Le bundle d'applications de simulation n'a pas pu être téléchargé.

BadPermissionsSortie S3

Impossible de publier les sorties dans le compartiment S3 fourni par le client.

BadPermissionsCloudwatchLogs

Impossible de publier les journaux sur la ressource CloudWatch Logs fournie par le client.

SubnetIpLimitExceeded

Limite d'adresses IP de sous-réseau dépassée.

ENI LimitExceeded

Limite ENI dépassée.

BadPermissionsUserCredentials

Impossible d'utiliser le rôle fourni.

InvalidBundleRobotApplication

Le bundle de robots ne peut pas être extrait (format non valide, erreur de regroupement ou autre problème).

InvalidBundleSimulationApplication

Le bundle de simulation ne peut pas être extrait (format non valide, erreur de regroupement ou autre problème).

RobotApplicationVersionMismatchedEtag

Etag for RobotApplication ne correspond pas à la valeur lors de la création de la version.

SimulationApplicationVersionMismatchedEtag

Etag for SimulationApplication ne correspond pas à la valeur lors de la création de la version.

Type : chaîne

Valeurs valides : InternalServiceError | RobotApplicationCrash | SimulationApplicationCrash | RobotApplicationHealthCheckFailure | SimulationApplicationHealthCheckFailure | BadPermissionsRobotApplication | BadPermissionsSimulationApplication | BadPermissionsS3Object | BadPermissionsS3Output | BadPermissionsCloudwatchLogs | SubnetIpLimitExceeded | ENILimitExceeded | BadPermissionsUserCredentials | InvalidBundleRobotApplication | InvalidBundleSimulationApplication | InvalidS3Resource | ThrottlingError | LimitExceeded | MismatchedEtag | RobotApplicationVersionMismatchedEtag | SimulationApplicationVersionMismatchedEtag | ResourceNotFound | RequestThrottled | BatchTimedOut | BatchCanceled | InvalidInput | WrongRegionS3Bucket | WrongRegionS3Output | WrongRegionRobotApplication | WrongRegionSimulationApplication | UploadContentMismatchError

failureReason

Informations sur les raisons de l'échec de la tâche de simulation. Pour plus d'informations sur le dépannage, consultez la section Résolution des problèmes.

Type : chaîne

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

Modèle : .*

iamRole

Rôle IAM qui permet à l'instance de simulation d'appeler en votre nom les API AWS spécifiées dans ses politiques associées.

Type : chaîne

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

Modèle : arn:aws:iam::\w+:role/.*

lastStartedAt

Heure, en millisecondes écoulée depuis l'époque, à laquelle la tâche de simulation a été lancée pour la dernière fois.

Type : Timestamp

lastUpdatedAt

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

Type : Timestamp

loggingConfig

La configuration de journalisation.

Type : objet LoggingConfig

maxJobDurationInSeconds

Durée maximale de la tâche en secondes. La valeur doit être inférieure ou égale à 8 jours (691 200 secondes).

Type : long

name

Nom de la tâche de simulation.

Type : chaîne

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

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

networkInterface

Informations d'interface réseau pour la tâche de simulation.

Type : objet NetworkInterface

outputLocation

Emplacement des fichiers de sortie générés par la tâche de simulation.

Type : objet OutputLocation

robotApplications

Liste des applications du robot.

Type : tableau d’objets RobotApplicationConfig

Membres du tableau : nombre fixe de 1 élément.

simulationApplications

Liste des applications de simulation.

Type : tableau d’objets SimulationApplicationConfig

Membres du tableau : nombre fixe de 1 élément.

simulationTimeMillis

Durée d'exécution de la tâche de simulation en millisecondes.

Type : long

status

État de la tâche de simulation.

Type : chaîne

Valeurs valides : Pending | Preparing | Running | Restarting | Completed | Failed | RunningFailed | Terminating | Terminated | Canceled

tags

Liste de toutes les balises ajoutées à la tâche de simulation spécifiée.

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 _.\-\/+=:]*

vpcConfig

La configuration du VPC.

Type : objet VPCConfigResponse

Erreurs

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

InternalServerException

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

Code d’état HTTP : 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.

Code d’état HTTP : 400

ResourceNotFoundException

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

Code d’état HTTP : 400

ThrottlingException

AWS RoboMaker est temporairement incapable de traiter la demande. Renouvelez votre appel.

Code d’état HTTP : 400

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :