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á.
StartSimulationJobBatch
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.
Inicia um novo lote de trabalhos de simulação. O lote é definido usando um ou mais objetos SimulationJobRequest
.
Sintaxe da Solicitação
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
"
}
}
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.
- batchPolicy
-
A política de lotes.
Tipo: objeto BatchPolicy
Obrigatório: Não
- 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
- createSimulationJobRequests
-
Uma lista de solicitações de trabalho de simulação a serem criadas no lote.
Tipo: Matriz de objetos SimulationJobRequest
Membros da matriz: número mínimo de 1 item. Número máximo de 1000 itens.
Obrigatório: Sim
-
Um mapa com as chaves e os valores de tag anexados ao lote do trabalho de implantaçã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
Sintaxe da Resposta
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"
}
}
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 nome do recurso da Amazon (ARN) do lote.
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 1.224.
Padrão:
arn:.*
- batchPolicy
-
A política de lotes.
Tipo: objeto BatchPolicy
- 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_\-=]*
- createdAt
-
O tempo, em milissegundos, desde o período em que o lote do trabalho de simulação foi criado.
Tipo: carimbo de data/hora
- createdRequests
-
Uma lista de resumos de solicitações de trabalho de simulação criadas.
Tipo: matriz de objetos SimulationJobSummary
Membros da Matriz: número mínimo de 0 itens. Número máximo de 100 itens.
- failedRequests
-
Uma lista de solicitações de trabalho de simulação que falharam. A solicitação falhou ao ser criada em um trabalho de simulação. Solicitações com falha não têm um ID de trabalho de simulação.
Tipo: matriz de objetos FailedCreateSimulationJobRequest
- failureCode
-
O código de falha se o lote de trabalhos de simulação falhar.
Tipo: string
Valores Válidos:
InternalServiceError
- failureReason
-
O motivo pelo qual o lote de trabalhos de simulação falhou.
Tipo: string
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 1.024.
Padrão:
.*
- pendingRequests
-
Uma lista de solicitações de trabalho de simulação pendentes. Essas solicitações ainda não foram criadas em trabalhos de simulação.
Tipo: Matriz de objetos SimulationJobRequest
Membros da matriz: número mínimo de 1 item. Número máximo de 1.000 itens.
- status
-
O status do lote de trabalhos de simulação.
- Pendente
-
A solicitação do lote de trabalhos de simulação está pendente.
- InProgress
-
O lote de trabalhos de simulação está em andamento.
- Failed (Falha)
-
O lote de trabalhos de simulação falhou. Uma ou mais solicitações de trabalho de simulação não puderam ser concluídas devido a uma falha interna (como
InternalServiceError
). ConsultefailureCode
efailureReason
para obter mais informações. - Concluído
-
O trabalho em lote de simulação foi concluído. Um lote é concluído quando (1) não há solicitações de trabalho de simulação pendentes no lote e nenhuma das solicitações de trabalho de simulação falhadas se deve a
InternalServiceError
e (2) quando todas as tarefas de simulação criadas atingem um estado terminal (por exemplo,Completed
ouFailed
). - Cancelado
-
O trabalho do lote de simulação foi cancelado.
- Cancelando
-
O trabalho do lote de simulação está sendo cancelado.
- Concluindo
-
O trabalho do lote de simulação está concluído.
- TimingOut
-
O lote de trabalhos de simulação está atingindo o tempo limite.
Se um lote atingir o tempo limite e houver solicitações pendentes que estavam falhando devido a uma falha interna (como
InternalServiceError
), o status do lote seráFailed
. Se não houver essa solicitação com falha, o status do lote seráTimedOut
. - TimedOut
-
O trabalho em lote de simulação atingiu o tempo limite.
Tipo: string
Valores Válidos:
Pending | InProgress | Failed | Completed | Canceled | Canceling | Completing | TimingOut | TimedOut
-
Um mapa com as chaves e os valores de tag anexados ao lote do trabalho de implantaçã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 _.\-\/+=:]*
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
- 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: