DescribeSimulationJob - AWS RoboMaker
Sintaxe da SolicitaçãoURIParâmetros de solicitaçãoCorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

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

DescribeSimulationJob

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.

Descreve um trabalho de simulação.

Sintaxe da Solicitação

POST /describeSimulationJob HTTP/1.1
Content-type: application/json

{
   "job": "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.

job

O Amazon Resource Name (ARN) do trabalho de simulação a ser descrito.

Tipo: string

Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 1.224.

Padrão: arn:.*

Exigido: Sim

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",
   "failureReason": "string",
   "iamRole": "string",
   "lastStartedAt": number,
   "lastUpdatedAt": number,
   "loggingConfig": { 
      "recordAllRosTopics": boolean
   },
   "maxJobDurationInSeconds": number,
   "name": "string",
   "networkInterface": { 
      "networkInterfaceId": "string",
      "privateIpAddress": "string",
      "publicIpAddress": "string"
   },
   "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

failureReason

Detalhes sobre por que o trabalho de simulação falhou. Para obter mais informações sobre a solução de problemas, consulte Solução de problemas.

Tipo: string

Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 1.024.

Padrão: .*

iamRole

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

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 em segundos. O valor deve ser de 8 dias (691.200 segundos) ou menos.

Tipo: longo

name

O nome do trabalho de simulação.

Tipo: string

Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.

Padrão: [a-zA-Z0-9_\-]*

networkInterface

As informações da interface de rede do trabalho de simulação.

Tipo: objeto NetworkInterface

outputLocation

Local dos arquivos de saída gerados pelo trabalho de simulação.

Tipo: objeto OutputLocation

robotApplications

Uma lista de aplicativos de robôs.

Tipo: matriz de objetos RobotApplicationConfig

Membros da matriz: número fixo de 1 item.

simulationApplications

Uma lista de aplicativos 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

tags

A lista de todas as tags adicionadas ao trabalho de simulação especificado.

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

A VPC configuração.

Tipo: objeto VPCConfigResponse

Erros

Para obter informações sobre os erros comuns retornados pelas ações, consulte Erros comuns.

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

ResourceNotFoundException

O recurso especificado não existe.

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: