Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
StartSimulationJobBatch
Startet einen neuen Simulationsauftragsstapel. Der Stapel wird mithilfe eines oder mehrerer SimulationJobRequest Objekte definiert.
Anforderungssyntax
POST /startSimulationJobBatch HTTP/1.1
Content-type: application/json
{
"batchPolicy": {
"maxConcurrency": number,
"timeoutInSeconds": number
},
"clientRequestToken": "string",
"createSimulationJobRequests": [
{
"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" ]
}
}
],
"tags": {
"string" : "string"
}
}URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
- batchPolicy
-
Die Batch-Richtlinie.
Typ: BatchPolicy Objekt
Erforderlich: Nein
- clientRequestToken
-
Eindeutiger Bezeichner, bei dem Groß- und Kleinschreibung berücksichtigt wird, den Sie angeben, um die Idempotenz der Anfrage sicherzustellen.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.
Pattern:
[a-zA-Z0-9_\-=]*Erforderlich: Nein
- createSimulationJobRequests
-
Eine Liste von Simulationsauftragsanforderungen, die im Batch erstellt werden sollen.
Typ: Array von SimulationJobRequest-Objekten
Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 1000 Elemente.
Erforderlich: Ja
-
Eine Map, die Tag-Schlüssel und Tag-Werte enthält, die an den Stapel der Bereitstellungsaufträge angehängt sind.
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge
Karteneinträge: Mindestanzahl von 0 Elementen. Die maximale Anzahl beträgt 50 Elemente.
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.
Schlüssel-Muster:
[a-zA-Z0-9 _.\-\/+=:]*Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.
Wertemuster:
[a-zA-Z0-9 _.\-\/+=:]*Erforderlich: Nein
Antwortsyntax
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",
"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"
}
}Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.
- arn
-
Der Amazon-Ressourcenname (arn) des Batches.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Die maximale Länge beträgt 1224.
Pattern:
arn:.* - batchPolicy
-
Die Batch-Richtlinie.
Typ: BatchPolicy Objekt
- clientRequestToken
-
Eindeutiger Bezeichner, bei dem Groß- und Kleinschreibung berücksichtigt wird, den Sie angeben, um die Idempotenz der Anfrage sicherzustellen.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.
Pattern:
[a-zA-Z0-9_\-=]* - createdAt
-
Die Zeit in Millisekunden seit der Epoche, zu der der Simulationsauftragsstapel erstellt wurde.
Typ: Zeitstempel
- createdRequests
-
Eine Liste der Zusammenfassungen der erstellten Simulationsauftragsanfragen.
Typ: Array von SimulationJobSummary-Objekten
Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 100 Elemente.
- failedRequests
-
Eine Liste der fehlgeschlagenen Simulationsjobanfragen. Die Anforderung konnte nicht in einen Simulationsjob umgewandelt werden. Fehlgeschlagene Anfragen haben keine Simulationsauftrags-ID.
Typ: Array von FailedCreateSimulationJobRequest-Objekten
- failureCode
-
Der Fehlercode, wenn der Simulationsauftragsstapel fehlgeschlagen ist.
Typ: Zeichenfolge
Zulässige Werte:
InternalServiceError - failureReason
-
Der Grund, warum der Simulationsauftragsstapel fehlgeschlagen ist.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.
Pattern:
.* - pendingRequests
-
Eine Liste ausstehender Simulationsauftragsanforderungen. Diese Anfragen wurden noch nicht zu Simulationsaufträgen hinzugefügt.
Typ: Array von SimulationJobRequest-Objekten
Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 1000 Elemente.
- status
-
Der Status des Simulationsauftragsstapels.
- Ausstehend
-
Die Batchanforderung für den Simulationsjob steht noch aus.
- InProgress
-
Der Simulationsauftragsstapel ist in Bearbeitung.
- Fehlgeschlagen
-
Der Simulationsauftragsstapel ist fehlgeschlagen. Eine oder mehrere Simulationsauftragsanforderungen konnten aufgrund eines internen Fehlers (like
InternalServiceError) nicht abgeschlossen werden. Weitere Informationen finden Sie unterfailureCodeundfailureReason. - Completed
-
Der Simulations-Batchauftrag wurde abgeschlossen. Ein Stapel ist abgeschlossen, wenn (1) keine ausstehenden Simulationsauftragsanforderungen im Stapel vorhanden sind und keine der fehlgeschlagenen Simulationsauftragsanforderungen darauf zurückzuführen ist
InternalServiceErrorund (2) wenn alle erstellten Simulationsaufträge einen Endstatus erreicht haben (z. B.CompletedoderFailed). - Canceled
-
Der Simulations-Batchauftrag wurde abgebrochen.
- Der Vorgang wird storniert
-
Der Simulations-Batch-Job wird abgebrochen.
- Wird abgeschlossen
-
Der Simulations-Batch-Job ist abgeschlossen.
- TimingOut
-
Das Timeout für den Batch des Simulationsauftrags ist abgelaufen.
Wenn bei einem Batch das Timeout überschritten wird und es ausstehende Anfragen gibt, die aufgrund eines internen Fehlers (wie
InternalServiceError) fehlgeschlagen sind, wird der Batch-Status wie folgt angezeigtFailed. Liegt keine solche fehlgeschlagene Anfrage vor, wird der Batch-Status wie folgt angezeigtTimedOut. - TimedOut
-
Das Timeout für den Simulations-Batchjob ist abgelaufen.
Typ: Zeichenfolge
Zulässige Werte:
Pending | InProgress | Failed | Completed | Canceled | Canceling | Completing | TimingOut | TimedOut -
Eine Map, die Tag-Schlüssel und Tag-Werte enthält, die dem Stapel des Bereitstellungsauftrags zugeordnet sind.
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge
Karteneinträge: Mindestanzahl von 0 Elementen. Die maximale Anzahl beträgt 50 Elemente.
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.
Schlüssel-Muster:
[a-zA-Z0-9 _.\-\/+=:]*Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.
Wertemuster:
[a-zA-Z0-9 _.\-\/+=:]*
Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.
- IdempotentParameterMismatchException
-
Für die Anforderung wird das gleiche Client-Token wie für eine vorherige, aber nicht identische Anforderung verwendet. Verwenden Sie keine Client-Token für mehrere Anforderungen, es sei denn, die Anforderungen sind identisch.
HTTP Status Code: 400
- InternalServerException
-
Bei AWS ist ein Serviceproblem RoboMaker aufgetreten. Wiederholen Sie den Aufruf.
HTTP Status Code: 500
- InvalidParameterException
-
Ein Parameter in einer Anforderung ist nicht gültig, wird nicht unterstützt oder kann nicht verwendet werden. Die zurückgegebene Nachricht enthält eine Erläuterung des Fehlers.
HTTP Status Code: 400
- LimitExceededException
-
Die angeforderte Ressource überschreitet die maximal zulässige Anzahl, oder die Anzahl gleichzeitiger Stream-Anfragen überschreitet die zulässige Höchstzahl.
HTTP Status Code: 400
- ThrottlingException
-
AWS RoboMaker kann die Anfrage vorübergehend nicht bearbeiten. Wiederholen Sie den Aufruf.
HTTP Status Code: 400
Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden:
