Aviso de fim do suporte: em 10 de setembro de 2025, AWS
interromperá o suporte para AWS RoboMaker. Depois de 10 de setembro de 2025, você não poderá mais acessar o AWS RoboMaker console ou AWS RoboMaker os recursos. Para obter mais informações sobre como fazer a transição para ajudar AWS Batch a executar simulações em contêineres, visite esta postagem no blog.
As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
CreateSimulationJob
Importante
Aviso de fim do suporte: em 10 de setembro de 2025, AWS
interromperá o suporte para AWS RoboMaker. Depois de 10 de setembro de 2025, você não poderá mais acessar o AWS RoboMaker console ou AWS RoboMaker os recursos. Para obter mais informações sobre como fazer a transição para ajudar AWS Batch a executar simulações em contêineres, visite esta postagem no blog.
Cria uma tarefa de simulação.
nota
Após 90 dias, os trabalhos de simulação expiram e serão excluídos. Eles não serão mais acessíveis.
Sintaxe da Solicitação
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
" ]
}
}
URIParâmetros de solicitação
A solicitação não usa nenhum URI parâmetro.
Corpo da Solicitação
A solicitação aceita os seguintes dados no JSON formato.
- clientRequestToken
-
Identificador exclusivo e que diferencia maiúsculas e minúsculas que você fornece para garantir a idempotência da solicitação.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 64.
Padrão:
[a-zA-Z0-9_\-=]*
Obrigatório: Não
- compute
-
Calcule as informações do trabalho de simulação.
Tipo: objeto Compute
Obrigatório: Não
- dataSources
-
Especifique as fontes de dados para montar arquivos somente para leitura do S3 em sua simulação. Esses arquivos estão disponíveis em
/opt/robomaker/datasources/data_source_name
.nota
Há um limite de 100 arquivos e um tamanho combinado de 25 GB para todos os objetos
DataSourceConfig
.Tipo: Matriz de objetos DataSourceConfig
Membros da matriz: número mínimo de 1 item. Número máximo de 6 itens.
Obrigatório: Não
- failureBehavior
-
O comportamento da falha do trabalho de simulação.
- Continuar
-
Deixa a instância em execução durante o tempo limite máximo após um código de erro
4XX
. - Falha
-
Pare o trabalho de simulação e encerre a instância.
Tipo: string
Valores Válidos:
Fail | Continue
Obrigatório: Não
- iamRole
-
O nome da IAM função que permite que a instância de simulação chame as AWS APIs que estão especificadas nas políticas associadas em seu nome. Esta é a forma como as credenciais são passadas para o seu trabalho de simulação.
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.
Padrão:
arn:aws:iam::\w+:role/.*
Exigido: Sim
- loggingConfig
-
A configuração de log.
Tipo: objeto LoggingConfig
Obrigatório: Não
- maxJobDurationInSeconds
-
A duração máxima do trabalho de simulação em segundos (até 14 dias ou 1.209.600 segundos). Quando
maxJobDurationInSeconds
for atingido, o status da tarefa de simulação será transferido paraCompleted
.Tipo: longo
Obrigatório: Sim
- outputLocation
-
Local dos arquivos de saída gerados pelo trabalho de simulação.
Tipo: objeto OutputLocation
Obrigatório: Não
- robotApplications
-
O aplicativo de robô a ser usado no trabalho de simulação.
Tipo: matriz de objetos RobotApplicationConfig
Membros da matriz: número fixo de 1 item.
Obrigatório: Não
- simulationApplications
-
O aplicativo de simulação para uso no trabalho de simulação.
Tipo: matriz de objetos SimulationApplicationConfig
Membros da matriz: número fixo de 1 item.
Obrigatório: Não
-
Um mapa com as chaves e os valores de tag anexados ao trabalho de simulação.
Tipo: mapa de string para string
Entradas do mapa: número mínimo de 0 itens. Número máximo de 50 itens.
Restrições de Tamanho de Chave: Tamanho mínimo de 1. O tamanho máximo é 128.
Padrão da chave:
[a-zA-Z0-9 _.\-\/+=:]*
Restrições de comprimento do valor: Comprimento mínimo de 0. Tamanho máximo de 256.
Padrão de valor:
[a-zA-Z0-9 _.\-\/+=:]*
Obrigatório: Não
- vpcConfig
-
Se sua tarefa de simulação acessar recursos em umVPC, você fornecerá esse parâmetro identificando a lista de grupos de segurança IDs e IDs sub-rede. Eles devem pertencer ao mesmoVPC. Você deve fornecer pelo menos um grupo de segurança e uma ID de sub-rede.
Tipo: objeto VPCConfig
Obrigatório: Não
Sintaxe da Resposta
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 Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP de 200.
Os dados a seguir são retornados em JSON formato pelo serviço.
- arn
-
O Amazon Resource Name (ARN) do trabalho de simulação.
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 1.224.
Padrão:
arn:.*
- clientRequestToken
-
Identificador exclusivo e que diferencia maiúsculas e minúsculas que você fornece para garantir a idempotência da solicitação.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 64.
Padrão:
[a-zA-Z0-9_\-=]*
- compute
-
Calcule as informações do trabalho de simulação.
Tipo: objeto ComputeResponse
- dataSources
-
As fontes de dados do trabalho de simulação.
Tipo: matriz de objetos DataSource
- failureBehavior
-
O comportamento de falha do trabalho de simulação.
Tipo: string
Valores Válidos:
Fail | Continue
- failureCode
-
O código de falha da tarefa de simulação, se ela falhar:
- InternalServiceError
-
Erro de serviço interno.
- RobotApplicationCrash
-
O aplicativo de robô foi encerrado de forma anormal.
- SimulationApplicationCrash
-
O aplicativo de simulação foi encerrado de forma anormal.
- BadPermissionsRobotApplication
-
O pacote de aplicativos de robôs não pôde ser baixado.
- BadPermissionsSimulationApplication
-
O pacote de aplicativos de simulação não pôde ser baixado.
- BadPermissionsSaída S3
-
Não é possível publicar as saídas no bucket S3 fornecido pelo cliente.
- BadPermissionsCloudwatchLogs
-
Não é possível publicar registros no recurso de CloudWatch registros fornecido pelo cliente.
- SubnetIpLimitExceeded
-
Limite de IP da sub-rede excedido.
- ENILimitExceeded
-
ENIlimite excedido.
- BadPermissionsUserCredentials
-
Não é possível usar a função fornecida.
- InvalidBundleRobotApplication
-
O pacote de robôs não pode ser extraído (formato inválido, erro de empacotamento ou outro problema).
- InvalidBundleSimulationApplication
-
O pacote de simulação não pode ser extraído (formato inválido, erro de empacotamento ou outro problema).
- RobotApplicationVersionMismatchedEtag
-
A etiqueta Etag for RobotApplication não corresponde ao valor durante a criação da versão.
- SimulationApplicationVersionMismatchedEtag
-
A etiqueta Etag for SimulationApplication não corresponde ao valor durante a criação da versão.
Tipo: string
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
-
A IAM função que permite que o trabalho de simulação chame os AWS APIs que estão especificados nas políticas associadas em seu nome.
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.
Padrão:
arn:aws:iam::\w+:role/.*
- lastStartedAt
-
O tempo, em milissegundos, desde o período em que o trabalho de simulação foi iniciada pela última vez.
Tipo: carimbo de data/hora
- lastUpdatedAt
-
O tempo, em milissegundos, desde o período em que o trabalho de simulação foi atualizado pela última vez.
Tipo: carimbo de data/hora
- loggingConfig
-
A configuração de log.
Tipo: objeto LoggingConfig
- maxJobDurationInSeconds
-
A duração máxima do trabalho de simulação em segundos.
Tipo: longo
- outputLocation
-
Localização dos arquivos de saída do trabalho de simulação.
Tipo: objeto OutputLocation
- robotApplications
-
O aplicativo de robô usado pelo trabalho de simulação.
Tipo: matriz de objetos RobotApplicationConfig
Membros da matriz: número fixo de 1 item.
- simulationApplications
-
O aplicativo de simulação usado pelo trabalho de simulação.
Tipo: matriz de objetos SimulationApplicationConfig
Membros da matriz: número fixo de 1 item.
- simulationTimeMillis
-
A duração da execução do trabalho de simulação em milissegundos.
Tipo: longo
- status
-
O status do trabalho de simulação.
Tipo: string
Valores Válidos:
Pending | Preparing | Running | Restarting | Completed | Failed | RunningFailed | Terminating | Terminated | Canceled
-
A lista de todas as tags adicionadas ao trabalho de simulação.
Tipo:: mapa de string para string
Entradas do mapa: número mínimo de 0 itens. Número máximo de 50 itens.
Restrições de Tamanho de Chave: Tamanho mínimo de 1. O tamanho máximo é 128.
Padrão da chave:
[a-zA-Z0-9 _.\-\/+=:]*
Restrições de comprimento do valor: Comprimento mínimo de 0. Tamanho máximo de 256.
Padrão de valor:
[a-zA-Z0-9 _.\-\/+=:]*
- vpcConfig
-
Informações sobre a configuração de vpc.
Tipo: objeto VPCConfigResponse
Erros
Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.
- IdempotentParameterMismatchException
-
A solicitação usa o mesmo token do cliente de uma solicitação anterior, mas não idêntica. Não reutilize um token do cliente com diferentes solicitações, a menos que as solicitações sejam idênticas.
HTTPCódigo de status: 400
- InternalServerException
-
AWS RoboMaker teve um problema de serviço. Tente fazer a chamada novamente.
HTTPCódigo de status: 500
- InvalidParameterException
-
Um parâmetro especificado em uma solicitação é inválido, não tem suporte ou não pode ser usado. A mensagem retornada fornece uma explicação do valor do erro.
HTTPCódigo de status: 400
- LimitExceededException
-
O recurso solicitado excede o número máximo permitido ou o número de solicitações de streaming simultâneas excede o número máximo permitido.
HTTPCódigo de status: 400
- ResourceNotFoundException
-
O recurso especificado não existe.
HTTPCódigo de status: 400
- ServiceUnavailableException
-
Falha na solicitação devido a um erro temporário do servidor.
HTTPCódigo de status: 503
- ThrottlingException
-
AWS RoboMaker está temporariamente incapaz de processar a solicitação. Tente fazer a chamada novamente.
HTTPCódigo de status: 400
Consulte também
Para obter mais informações sobre como usar isso API em um idioma específico AWS SDKs, consulte o seguinte: