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á.
DescribeWorld
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 mundo.
Sintaxe da Solicitação
POST /describeWorld HTTP/1.1
Content-type: application/json
{
"world": "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.
- world
-
O nome do recurso da Amazon (arn) do mundo que você deseja descrever.
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",
"createdAt": number,
"generationJob": "string",
"tags": {
"string" : "string"
},
"template": "string",
"worldDescriptionBody": "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 mundo.
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 1.224.
Padrão:
arn:.* - createdAt
-
O tempo, em milissegundos, desde o período em que o mundo foi criado.
Tipo: carimbo de data/hora
- generationJob
-
O nome do recurso da Amazon (arn) do trabalho de geração de mundos que gerou o mundo.
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 1.224.
Padrão:
arn:.* -
Um mapa com as chaves e os valores de tag anexados ao mundo.
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 _.\-\/+=:]* - template
-
O modelo de mundo.
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 1.224.
Padrão:
arn:.* - worldDescriptionBody
-
Retorna a string JSON formatada que descreve o conteúdo do seu mundo.
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 262144.
Padrão:
[\S\s]+
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:
