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

CreateSimulationJob

Crée une tâche de simulation.

Note

Après 90 jours, les tâches de simulation expirent et sont supprimées. Elles ne seront plus accessibles.

Syntaxe de la demande

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

{
   "clientRequestToken": "string",
   "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" 
   },
   "vpcConfig": { 
      "assignPublicIp": boolean,
      "securityGroups": [ "string" ],
      "subnets": [ "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.

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_\-=]*

Obligatoire : non

compute

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

Type : objet Compute

Obligatoire : non

dataSources

Spécifiez les sources de données pour monter des fichiers en lecture seule depuis S3 dans votre simulation. Ces fichiers sont disponibles sous/opt/robomaker/datasources/data_source_name.

Note

Il existe une limite de 100 fichiers et une taille combinée de 25 Go pour tous les DataSourceConfig objets.

Type : tableau d’objets DataSourceConfig

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

Obligatoire : non

failureBehavior

Le comportement d'échec de la tâche de simulation.

Continuer

Laisse l'instance en cours d'exécution pendant son délai d'expiration maximal après un code 4XX d'erreur.

Fail

Arrêtez le travail de simulation et mettez fin à l'instance.

Type : chaîne

Valeurs valides : Fail | Continue

Obligatoire : non

iamRole

Le nom du 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. C'est ainsi que les informations d'identification sont transmises à votre tâche de simulation.

Type : chaîne

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

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

Obligatoire : oui

loggingConfig

La configuration de journalisation.

Type : objet LoggingConfig

Obligatoire : non

maxJobDurationInSeconds

Durée maximale de la tâche de simulation en secondes (jusqu'à 14 jours ou 1 209 600 secondes). Une fois maxJobDurationInSeconds atteint, le statut de la tâche de simulation passera àCompleted.

Type : long

Obligatoire : oui

outputLocation

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

Type : objet OutputLocation

Obligatoire : non

robotApplications

L'application robotique à utiliser dans le cadre de la tâche de simulation.

Type : tableau d’objets RobotApplicationConfig

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

Obligatoire : non

simulationApplications

L'application de simulation à utiliser dans le cadre de la tâche de simulation.

Type : tableau d’objets SimulationApplicationConfig

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

Obligatoire : non

tags

Carte contenant les clés de balise et les valeurs de balise associées à la tâche 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 _.\-\/+=:]*

Obligatoire : non

vpcConfig

Si votre tâche de simulation accède aux ressources d'un VPC, vous fournissez ce paramètre identifiant la liste des ID de groupe de sécurité et des ID de sous-réseau. Ils doivent appartenir au même VPC. Vous devez fournir au moins un groupe de sécurité et un ID de sous-réseau.

Type : objet VPCConfig

Obligatoire : non

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",
   "iamRole": "string",
   "lastStartedAt": number,
   "lastUpdatedAt": number,
   "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"
            }
         ]
      }
   ],
   "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

le 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 de manière anormale.

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

iamRole

Rôle IAM qui permet à la tâche 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 de simulation en secondes.

Type : long

outputLocation

Emplacement des fichiers de sortie des tâches de simulation.

Type : objet OutputLocation

robotApplications

L'application robotique utilisée par la tâche de simulation.

Type : tableau d’objets RobotApplicationConfig

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

simulationApplications

Application de simulation utilisée par la tâche 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.

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

Informations sur la configuration du VPC.

Type : objet VPCConfigResponse

Erreurs

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

IdempotentParameterMismatchException

La demande utilise le même jeton client qu'une demande précédente non identique. Vous ne devez pas réutiliser de jeton client avec des demandes différentes, sauf si les demandes sont identiques.

Code d’état HTTP : 400

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

LimitExceededException

La ressource demandée dépasse le nombre maximum autorisé, ou le nombre de demandes de flux simultanées dépasse le nombre maximum autorisé.

Code d’état HTTP : 400

ResourceNotFoundException

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

Code d’état HTTP : 400

ServiceUnavailableException

La requête a échoué en raison d’une défaillance temporaire du serveur.

HTTP Status Code: 503

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 :