CreateSimulationJob - AWS RoboMaker
Sintassi della richiestaParametri della richiesta URI:Corpo della richiestaSintassi della rispostaElementi di rispostaErroriVedi anche

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

CreateSimulationJob

Crea un lavoro di simulazione.

Nota

Dopo 90 giorni, i processi di simulazione scadono e saranno eliminati. Non saranno più accessibili.

Sintassi della richiesta

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

Parametri della richiesta URI:

La richiesta non utilizza parametri URI.

Corpo della richiesta

La richiesta accetta i seguenti dati in formato JSON.

clientRequestToken

Identificatore univoco con distinzione tra maiuscole e minuscole fornito per garantire l'idempotenza della richiesta.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

Modello: [a-zA-Z0-9_\-=]*

Campo obbligatorio: no

compute

Informazioni di calcolo per il lavoro di simulazione.

Tipo: oggetto Compute

Campo obbligatorio: no

dataSources

Specificate le fonti di dati per montare file di sola lettura da S3 nella simulazione. Questi file sono disponibili in. /opt/robomaker/datasources/data_source_name

Nota

C'è un limite di 100 file e una dimensione combinata di 25 GB per tutti DataSourceConfig gli oggetti.

Tipo: matrice di oggetti DataSourceConfig

Membri dell’array: numero minimo di 1 elemento. Numero massimo 6 elementi.

Campo obbligatorio: no

failureBehavior

Il comportamento di errore, il lavoro di simulazione.

Continua

Lascia l'istanza in esecuzione per la durata massima del timeout dopo un codice di 4XX errore.

Fail

Interrompi il processo di simulazione e termina l'istanza.

▬Tipo: stringa

Valori validi: Fail | Continue

Campo obbligatorio: no

iamRole

Il nome del ruolo IAM che consente all'istanza di simulazione di chiamare le API AWS specificate nelle policy associate per tuo conto. Ecco come vengono passate le credenziali al tuo processo di simulazione.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 1. Lunghezza massima di 255.

Modello: arn:aws:iam::\w+:role/.*

Campo obbligatorio: sì

loggingConfig

La configurazione della registrazione.

Tipo: oggetto LoggingConfig

Campo obbligatorio: no

maxJobDurationInSeconds

La durata massima del lavoro di simulazione in secondi (fino a 14 giorni o 1.209.600 secondi). Una volta maxJobDurationInSeconds raggiunto, lo stato del processo di simulazione passerà a. Completed

Tipo: long

Campo obbligatorio: sì

outputLocation

Posizione per i file di output generati dal lavoro di simulazione.

Tipo: oggetto OutputLocation

Campo obbligatorio: no

robotApplications

L'applicazione robotica da utilizzare nel lavoro di simulazione.

Tipo: matrice di oggetti RobotApplicationConfig

Membri dell'array: numero minimo di 1 elemento.

Campo obbligatorio: no

simulationApplications

L'applicazione di simulazione da utilizzare nel lavoro di simulazione.

Tipo: matrice di oggetti SimulationApplicationConfig

Membri dell'array: numero minimo di 1 elemento.

Campo obbligatorio: no

tags

Una mappa che contiene le chiavi e i valori dei tag associati al lavoro di simulazione.

Tipo: mappatura stringa a stringa

Voci sulla mappa: numero minimo di 0 elementi. Numero massimo di 50 item.

Limitazioni di lunghezza della chiave: la lunghezza minima è 1. La lunghezza massima è 128 caratteri.

Modello di chiave:[a-zA-Z0-9 _.\-\/+=:]*

Limiti di lunghezza del valore: lunghezza minima di 0. La lunghezza massima è 256 caratteri.

Modello di valore: [a-zA-Z0-9 _.\-\/+=:]*

Campo obbligatorio: no

vpcConfig

Se il processo di simulazione accede alle risorse in un VPC, fornisci questo parametro che identifica l'elenco degli ID dei gruppi di sicurezza e degli ID di sottorete. Questi devono appartenere allo stesso VPC. È necessario fornire almeno un gruppo di sicurezza e un ID di sottorete.

Tipo: oggetto VPCConfig

Campo obbligatorio: no

Sintassi della risposta

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

Elementi di risposta

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

arn

L'Amazon Resource Name (ARN) del processo di simulazione.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. Lunghezza massima di 1224.

Modello: arn:.*

clientRequestToken

Identificatore univoco con distinzione tra maiuscole e minuscole fornito per garantire l'idempotenza della richiesta.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 64 caratteri.

Modello: [a-zA-Z0-9_\-=]*

compute

Informazioni di calcolo per il lavoro di simulazione.

Tipo: oggetto ComputeResponse

dataSources

Le fonti di dati per il lavoro di simulazione.

Tipo: matrice di oggetti DataSource

failureBehavior

il comportamento in caso di errore del lavoro di simulazione.

▬Tipo: stringa

Valori validi: Fail | Continue

failureCode

Il codice di errore del processo di simulazione in caso di esito negativo:

InternalServiceError

Errore interno del servizio.

RobotApplicationCrash

L'applicazione robotica è stata chiusa in modo anomalo.

SimulationApplicationCrash

L'applicazione di simulazione è stata chiusa in modo anomalo.

BadPermissionsRobotApplication

Impossibile scaricare il pacchetto di applicazioni Robot.

BadPermissionsSimulationApplication

Impossibile scaricare il pacchetto di applicazioni di simulazione.

BadPermissionsUscita S3

Impossibile pubblicare gli output nel bucket S3 fornito dal cliente.

BadPermissionsCloudwatchLogs

Impossibile pubblicare i log sulla risorsa Logs fornita dal cliente. CloudWatch

SubnetIpLimitExceeded

Limite IP di sottorete superato.

ENI LimitExceeded

Limite ENI superato.

BadPermissionsUserCredentials

Impossibile utilizzare il ruolo fornito.

InvalidBundleRobotApplication

Il pacchetto Robot non può essere estratto (formato non valido, errore di raggruppamento o altro problema).

InvalidBundleSimulationApplication

Il pacchetto di simulazione non può essere estratto (formato non valido, errore di raggruppamento o altro problema).

RobotApplicationVersionMismatchedEtag

Etag for RobotApplication non corrisponde al valore durante la creazione della versione.

SimulationApplicationVersionMismatchedEtag

Etag for non SimulationApplication corrisponde al valore durante la creazione della versione.

▬Tipo: stringa

Valori validi: 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

Il ruolo IAM che consente al processo di simulazione di chiamare per tuo conto le API AWS specificate nelle policy associate.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 1. Lunghezza massima di 255.

Modello: arn:aws:iam::\w+:role/.*

lastStartedAt

L'ora, in millisecondi dall'epoca, in cui il processo di simulazione è stato avviato l'ultima volta.

Tipo: Timestamp

lastUpdatedAt

L'ora, in millisecondi dall'epoca, in cui il lavoro di simulazione è stato aggiornato l'ultima volta.

Tipo: Timestamp

loggingConfig

La configurazione della registrazione.

Tipo: oggetto LoggingConfig

maxJobDurationInSeconds

La durata massima del lavoro di simulazione in secondi.

Tipo: long

outputLocation

Posizione dei file di output del processo di simulazione.

Tipo: oggetto OutputLocation

robotApplications

L'applicazione robotica utilizzata dal processo di simulazione.

Tipo: matrice di oggetti RobotApplicationConfig

Membri dell'array: numero minimo di 1 elemento.

simulationApplications

L'applicazione di simulazione utilizzata dal processo di simulazione.

Tipo: matrice di oggetti SimulationApplicationConfig

Membri dell'array: numero minimo di 1 elemento.

simulationTimeMillis

La durata dell'esecuzione del processo di simulazione in millisecondi.

Tipo: long

status

Lo stato del lavoro di simulazione.

▬Tipo: stringa

Valori validi: Pending | Preparing | Running | Restarting | Completed | Failed | RunningFailed | Terminating | Terminated | Canceled

tags

L'elenco di tutti i tag aggiunti al lavoro di simulazione.

Tipo: mappatura stringa a stringa

Voci sulla mappa: numero minimo di 0 elementi. Numero massimo di 50 item.

Limitazioni di lunghezza della chiave: la lunghezza minima è 1. La lunghezza massima è 128 caratteri.

Modello di chiave:[a-zA-Z0-9 _.\-\/+=:]*

Limiti di lunghezza del valore: lunghezza minima di 0. La lunghezza massima è 256 caratteri.

Modello di valore: [a-zA-Z0-9 _.\-\/+=:]*

vpcConfig

Informazioni sulla configurazione vpc.

Tipo: oggetto VPCConfigResponse

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

IdempotentParameterMismatchException

La richiesta usa lo stesso token client di una precedente, ma non è una richiesta identica. Non riutilizzare un token client con richieste diverse a meno che le richieste non siano identiche.

Codice di stato HTTP: 400

InternalServerException

AWS RoboMaker ha riscontrato un problema di servizio. Riprova la chiamata.

Codice di stato HTTP: 500

InvalidParameterException

Un parametro specificato in una richiesta non è valido, non è supportato o non può essere utilizzato. Il messaggio restituito fornisce una spiegazione del valore di errore.

Codice di stato HTTP: 400

LimitExceededException

La risorsa richiesta supera il numero massimo consentito o il numero di richieste di streaming simultanee supera il numero massimo consentito.

Codice di stato HTTP: 400

ResourceNotFoundException

La risorsa specificata non esiste.

Codice di stato HTTP: 400

ServiceUnavailableException

La richiesta non è riuscita a causa di un errore temporaneo del server.

Codice di stato HTTP: 503

ThrottlingException

AWS non RoboMaker è temporaneamente in grado di elaborare la richiesta. Riprova la chiamata.

Codice di stato HTTP: 400

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli AWS SDK specifici della lingua, consulta quanto segue: