CreateSimulationJob - AWS RoboMaker
Sintaxis de la solicitudParámetros de solicitud del URICuerpo de la solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

CreateSimulationJob

Creación de un trabajo de simulación.

nota

Después de 90 días, los trabajos de simulación caducan y se eliminarán. Dejarán de estar disponibles.

Sintaxis de la solicitud

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

Parámetros de solicitud del URI

La solicitud no utiliza ningún parámetro de URI.

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

clientRequestToken

Identificador único con distinción entre mayúsculas y minúsculas que se proporciona para garantizar la idempotencia de la solicitud.

Tipo: string

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 64.

Patrón: [a-zA-Z0-9_\-=]*

Obligatorio: no

compute

Información de computación para el trabajo de simulación

Tipo: objeto Compute

Obligatorio: no

dataSources

Especificar los orígenes de datos para montar archivos de solo lectura de S3 en la simulación. Estos archivos están disponibles en /opt/robomaker/datasources/data_source_name.

nota

Hay un límite de 100 archivos y un tamaño combinado de 25 GB para todos los objetos DataSourceConfig.

Tipo: Matriz de DataSourceConfig objetos

Miembros de la matriz: número mínimo de 1 artículo. La cantidad máxima es de 6 elementos.

Obligatorio: no

failureBehavior

Comportamiento en caso de error en el trabajo de simulación.

Continuar

Deja la instancia en ejecución durante el tiempo máximo de espera después de un código de error 4XX.

Fail

Detiene el trabajo de simulación y finaliza la instancia.

Tipo: cadena

Valores válidos: Fail | Continue

Obligatorio: no

iamRole

El nombre del rol de IAM que permite a la instancia de simulación llamar en su nombre a las API de AWS especificadas en sus políticas asociadas. Así es cómo se pasan las credenciales al trabajo de simulación.

Tipo: string

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.

Patrón: arn:aws:iam::\w+:role/.*

Obligatorio: sí

loggingConfig

Configuración de registro.

Tipo: objeto LoggingConfig

Obligatorio: no

maxJobDurationInSeconds

La duración máxima del trabajo de simulación en segundos (hasta 14 días o 1 209 600 segundos). Cuando se llega a maxJobDurationInSeconds, el estado del trabajo de simulación pasa a ser Completed.

Tipo: largo

Obligatorio: sí

outputLocation

Ubicación de los archivos de salida generados por el trabajo de simulación.

Tipo: objeto OutputLocation

Obligatorio: no

robotApplications

La aplicación de robot que se usa en el trabajo de simulación.

Tipo: matriz de objetos RobotApplicationConfig

Miembros de la matriz: número fijo de 1 artículo.

Obligatorio: no

simulationApplications

La aplicación de simulación que se usa en el trabajo de simulación.

Tipo: matriz de objetos SimulationApplicationConfig

Miembros de la matriz: número fijo de 1 artículo.

Obligatorio: no

tags

Un mapa que contiene las claves y los valores de las etiquetas que se asocian al trabajo de simulación.

Tipo: mapa de cadena a cadena

Entradas de mapa: número mínimo de 0 elementos. Número máximo de 50 artículos.

Limitaciones de longitud de la clave: longitud mínima de 1. Longitud máxima de 128.

Patrón de clave: [a-zA-Z0-9 _.\-\/+=:]*

Limitaciones de longitud de los valores: longitud mínima de 0. La longitud máxima es de 256 caracteres.

Patrón de valores: [a-zA-Z0-9 _.\-\/+=:]*

Obligatorio: no

vpcConfig

Si su trabajo de simulación accede a los recursos de una VPC, debe proporcionar este parámetro que identifica la lista de ID de grupos de seguridad y de ID de subred. Estos deben pertenecer a la misma VPC. Proporcione al menos un ID de grupo de seguridad y de subred.

Tipo: objeto VPCConfig

Obligatorio: no

Sintaxis de la respuesta

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

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

arn

El nombre de recurso de Amazon (ARN) del trabajo de simulación.

Tipo: string

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 1224.

Patrón: arn:.*

clientRequestToken

Identificador único con distinción entre mayúsculas y minúsculas que se proporciona para garantizar la idempotencia de la solicitud.

Tipo: string

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 64.

Patrón: [a-zA-Z0-9_\-=]*

compute

Información de computación para el trabajo de simulación

Tipo: objeto ComputeResponse

dataSources

Los orígenes de datos para el trabajo de simulación.

Tipo: matriz de objetos DataSource

failureBehavior

El comportamiento del trabajo de simulación en caso de error.

Tipo: cadena

Valores válidos: Fail | Continue

failureCode

El código de error del trabajo de simulación en caso de error:

InternalServiceError

Error de servicio interno.

RobotApplicationCrash

La aplicación de robot se cerró de forma anómala.

SimulationApplicationCrash

La aplicación de simulación se cerró de forma anómala.

BadPermissionsRobotApplication

No se ha podido descargar la agrupación de aplicaciones de robot.

BadPermissionsSimulationApplication

No se ha podido descargar la agrupación de aplicaciones de simulación.

BadPermissionsSalida S3

No se pueden publicar los resultados en el bucket S3 proporcionado por el cliente.

BadPermissionsCloudwatchLogs

No se pueden publicar los registros en el recurso de registros proporcionado por el cliente CloudWatch .

SubnetIpLimitExceeded

Se ha superado el límite de IP de subred.

ENI LimitExceeded

Se ha superado el límite de ENI.

BadPermissionsUserCredentials

No se puede utilizar el rol proporcionado.

InvalidBundleRobotApplication

No se puede extraer la agrupación del robot (formato no válido, error de agrupación u otro problema).

InvalidBundleSimulationApplication

No se puede extraer la agrupación de simulación (formato no válido, error de agrupación u otro problema).

RobotApplicationVersionMismatchedEtag

La etiqueta etag for no RobotApplication coincide con el valor durante la creación de la versión.

SimulationApplicationVersionMismatchedEtag

La etiqueta etag for no SimulationApplication coincide con el valor durante la creación de la versión.

Tipo: cadena

Valores válidos: 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

El rol de IAM que permite al trabajo de simulación llamar en su nombre a las API de AWS que se especifican en sus políticas asociadas.

Tipo: string

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.

Patrón: arn:aws:iam::\w+:role/.*

lastStartedAt

El tiempo, en milisegundos, desde la fecha de inicio, cuando se inició el trabajo de simulación por última vez.

Tipo: marca temporal

lastUpdatedAt

El tiempo, en milisegundos, desde la fecha de inicio, cuando se actualizó el trabajo de simulación por última vez.

Tipo: marca temporal

loggingConfig

Configuración de registro.

Tipo: objeto LoggingConfig

maxJobDurationInSeconds

La duración máxima del trabajo de simulación en segundos.

Tipo: largo

outputLocation

Ubicación de los archivos de salida del trabajo de simulación.

Tipo: objeto OutputLocation

robotApplications

La aplicación de robot que utiliza el trabajo de simulación.

Tipo: matriz de objetos RobotApplicationConfig

Miembros de la matriz: número fijo de 1 artículo.

simulationApplications

La aplicación de simulación que utiliza el trabajo de simulación.

Tipo: matriz de objetos SimulationApplicationConfig

Miembros de la matriz: número fijo de 1 artículo.

simulationTimeMillis

La duración de la ejecución del trabajo de simulación en milisegundos.

Tipo: largo

status

Estado del trabajo de simulación.

Tipo: cadena

Valores válidos: Pending | Preparing | Running | Restarting | Completed | Failed | RunningFailed | Terminating | Terminated | Canceled

tags

La lista con todas las etiquetas añadidas al trabajo de simulación.

Tipo: mapa de cadena a cadena

Entradas de mapa: número mínimo de 0 elementos. Número máximo de 50 artículos.

Limitaciones de longitud de la clave: longitud mínima de 1. Longitud máxima de 128.

Patrón de clave: [a-zA-Z0-9 _.\-\/+=:]*

Limitaciones de longitud de los valores: longitud mínima de 0. La longitud máxima es de 256 caracteres.

Patrón de valores: [a-zA-Z0-9 _.\-\/+=:]*

vpcConfig

Información sobre la configuración de VPC.

Tipo: objeto VPCConfigResponse

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

IdempotentParameterMismatchException

La solicitud utiliza el mismo token de cliente que uno anterior, pero no la misma solicitud. No reutilice un token de cliente con diferentes solicitudes, a menos que las solicitudes sean idénticas.

Código de estado HTTP: 400

InternalServerException

AWS RoboMaker ha tenido un problema con el servicio. Pruebe la llamada de nuevo.

Código de estado HTTP: 500

InvalidParameterException

Un parámetro especificado en una solicitud no es válido, no se admite o no se puede utilizar. El mensaje devuelto proporciona una explicación del valor del error.

Código de estado HTTP: 400

LimitExceededException

El recurso solicitado supera el número máximo permitido o el número de solicitudes de transmisión simultáneas supera el número máximo permitido.

Código de estado HTTP: 400

ResourceNotFoundException

El recurso especificado no existe.

Código de estado HTTP: 400

ServiceUnavailableException

La solicitud no se ha ejecutado correctamente debido a un error temporal del servidor.

Código de estado HTTP: 503

ThrottlingException

AWS RoboMaker no puede procesar la solicitud temporalmente. Pruebe la llamada de nuevo.

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulte lo siguiente: