ListWorlds - AWS RoboMaker
Sintaxe da SolicitaçãoParâmetros da solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

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

ListWorlds

Lista mundos.

Sintaxe da Solicitação

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

{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}

Parâmetros da solicitação de URI

A solicitação não usa nenhum parâmetro de URI.

Corpo da Solicitação

A solicitação aceita os dados a seguir no formato JSON.

filters

Filtros opcionais para limitar os resultados. Você pode usar status.

Tipo: matriz de objetos Filter

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

Obrigatório: não

maxResults

Quando esse parâmetro é usado, ListWorlds retorna resultados maxResults somente em uma única página junto com um elemento de resposta nextToken. Os resultados restantes da solicitação inicial podem ser vistos enviando outra solicitação de ListWorlds com o valor nextToken retornado. Esse valor pode ser entre 1 e 100. Se esse parâmetro não for usado, ListWorlds retornará até 100 resultados e um valor nextToken, se aplicável.

Tipo: inteiro

Obrigatório: não

nextToken

Se a solicitação paginada anterior não retornou todos os resultados restantes, o valor do parâmetro nextToken do objeto de resposta será definido como um token. Para recuperar o próximo conjunto de resultados, chame ListWorlds novamente e atribua esse token ao parâmetro nextToken do objeto de solicitação. Se não houver resultados restantes, o NextToken parâmetro do objeto de resposta anterior será definido como nulo.

Tipo: string

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

Padrão: [a-zA-Z0-9_.\-\/+=]*

Obrigatório: Não

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "worldSummaries": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "generationJob": "string",
         "template": "string"
      }
   ]
}

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

nextToken

Se a solicitação paginada anterior não retornou todos os resultados restantes, o valor do parâmetro nextToken do objeto de resposta será definido como um token. Para recuperar o próximo conjunto de resultados, chame ListWorlds novamente e atribua esse token ao parâmetro nextToken do objeto de solicitação. Se não houver resultados restantes, o NextToken parâmetro do objeto de resposta anterior será definido como nulo.

Tipo: string

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

Padrão: [a-zA-Z0-9_.\-\/+=]*

worldSummaries

Informações resumidas para mundos.

Tipo: matriz de objetos WorldSummary

Erros

Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.

InternalServerException

A AWS RoboMaker teve um problema de serviço. Tente fazer a chamada novamente.

Código de Status HTTP: 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.

Código de Status HTTP: 400

ThrottlingException

RoboMaker A AWS está temporariamente impossibilitada de processar a solicitação. Tente fazer a chamada novamente.

Código de Status HTTP: 400

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: