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

ListRobots

Essa ação está defasada.

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.

Importante

Isso não API é mais suportado. Para obter mais informações, consulte a atualização de 2 de maio de 2022 na página da política de suporte.

Retorna uma lista de robôs. Opcionalmente, você pode fornecer filtros para recuperar robôs específicos.

Sintaxe da Solicitação

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

{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "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.

filters

Filtros opcionais para limitar os resultados.

As chaves de filtro compatíveis são status e fleetName. Ao filtrar, você deve usar o valor completo do item filtrado. Você pode usar até três filtros, mas eles devem ser para o mesmo item nomeado. Por exemplo, se você estiver procurando por itens com o status Registered ou o status Available.

Tipo: matriz de objetos Filter

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

Obrigatório: Não

maxResults

Quando esse parâmetro é usado, ListRobots 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 ListRobots com o valor nextToken retornado. Esse valor pode ser entre 1 e 200. Se esse parâmetro não for usado, ListRobots retornará até 200 resultados e um valor nextToken, se aplicável.

Tipo: número 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 ListRobots 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",
   "robots": [ 
      { 
         "architecture": "string",
         "arn": "string",
         "createdAt": number,
         "fleetArn": "string",
         "greenGrassGroupId": "string",
         "lastDeploymentJob": "string",
         "lastDeploymentTime": number,
         "name": "string",
         "status": "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.

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 ListRobots 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_.\-\/+=]*

robots

Uma lista de robôs que atendem a todas as condições na solicitação.

Tipo: matriz de objetos Robot

Membros da Matriz: número mínimo de 0 itens. Número máximo de 1.000 itens.

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: