DescribeSimulationJobBatch - AWS RoboMaker

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

DescribeSimulationJobBatch

Descrive un batch di processi di simulazione.

Sintassi della richiesta

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

Parametri della richiesta URI:

La richiesta non utilizza parametri URI.

Corpo della richiesta

La richiesta accetta i seguenti dati in formato JSON.

batch

L'id del batch da descrivere.

Tipo: stringa

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

Modello: arn:.*

Campo obbligatorio: sì

Sintassi della risposta

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

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

Tipo: stringa

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

Modello: arn:.*

batchPolicy

La politica dei batch.

Tipo: oggetto BatchPolicy

clientRequestToken

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

Tipo: stringa

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

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

createdAt

L'ora, in millisecondi dall'epoca, in cui è stato creato il batch di lavori di simulazione.

Tipo: Timestamp

createdRequests

Un elenco di riepiloghi dei lavori di simulazione creati.

Tipo: matrice di oggetti SimulationJobSummary

Membri dell'array: numero minimo di 0 elementi. Numero massimo di 100 elementi.

failedRequests

Un elenco di richieste di lavoro di creazione di simulazione non riuscite. La richiesta non è stata creata in un processo di simulazione. Le richieste non riuscite non hanno un ID del lavoro di simulazione.

Tipo: matrice di oggetti FailedCreateSimulationJobRequest

failureCode

Il codice di errore del batch di processi di simulazione.

Tipo: stringa

Valori validi: InternalServiceError

failureReason

Il motivo per cui il batch di processi di simulazione non è riuscito.

Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 0. La lunghezza massima è 1024 caratteri.

Modello: .*

lastUpdatedAt

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

Tipo: Timestamp

pendingRequests

Un elenco di richieste di lavori di simulazione in sospeso. Queste richieste non sono ancora state inserite in lavori di simulazione.

Tipo: matrice di oggetti SimulationJobRequest

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

status

Lo stato del batch.

In attesa

La richiesta del batch del processo di simulazione è in sospeso.

InProgress

Il batch di processi di simulazione è in corso.

Non riuscito

Il batch di processi di simulazione non è riuscito. Una o più richieste di lavori di simulazione non possono essere completate a causa di un errore interno (ad esempioInternalServiceError). Per ulteriori informazioni, consulta failureCode e failureReason.

Completato

Il processo in batch di simulazione è stato completato. Un batch è completo quando (1) non vi sono richieste di lavori di simulazione in sospeso nel batch e nessuna delle richieste di lavoro di simulazione non riuscite è dovuta a InternalServiceError e (2) quando tutti i lavori di simulazione creati hanno raggiunto uno stato terminale (ad esempio, o). Completed Failed

Annullato

Il processo del batch di simulazione è stato annullato.

Annullamento

Il processo in batch di simulazione viene annullato.

Completamento

Il processo di simulazione in batch è stato completato.

TimingOut

Il batch del processo di simulazione sta scadendo.

In caso di timeout di un batch e vi sono richieste in sospeso che non sono riuscite a causa di un errore interno (ad esempioInternalServiceError), lo stato del batch sarà lo stesso. Failed Se non ci sono richieste di questo tipo non riuscite, lo stato del batch sarà. TimedOut

TimedOut

Il processo del batch di simulazione è scaduto.

Tipo: stringa

Valori validi: Pending | InProgress | Failed | Completed | Canceled | Canceling | Completing | TimingOut | TimedOut

tags

Una mappa che contiene le chiavi e i valori dei tag allegati al batch di processi 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 _.\-\/+=:]*

Errori

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

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

ResourceNotFoundException

La risorsa specificata non esiste.

Codice di stato HTTP: 400

Vedi anche

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