ListWorlds - AWS RoboMaker
Sintaxis de la solicitudURIParámetros de solicitudCuerpo de la solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

Aviso de fin del soporte: el 10 de septiembre de 2025, AWS dejaremos de ofrecer soporte a AWS RoboMaker. Después del 10 de septiembre de 2025, ya no podrás acceder a la AWS RoboMaker consola ni a AWS RoboMaker los recursos. Para obtener más información sobre la transición para ayudar AWS Batch a ejecutar simulaciones en contenedores, visite esta entrada de blog.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

ListWorlds

importante

Aviso de fin de soporte: el 10 de septiembre de 2025, AWS suspenderemos el soporte para AWS RoboMaker. Después del 10 de septiembre de 2025, ya no podrás acceder a la AWS RoboMaker consola ni a AWS RoboMaker los recursos. Para obtener más información sobre la transición para ayudar AWS Batch a ejecutar simulaciones en contenedores, visite esta entrada de blog.

Enumera mundos.

Sintaxis de la solicitud

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

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

URIParámetros de solicitud

La solicitud no utiliza ningún URI parámetro.

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en JSON formato.

filters

Filtros opcionales para limitar los resultados. Puede usar status.

Tipo: matriz de objetos Filter

Miembros de la matriz: número fijo de 1 artículo.

Obligatorio: no

maxResults

Cuando se usa este parámetro, ListWorlds solo devuelve maxResults resultados en una sola página junto con un elemento de respuesta nextToken. Los resultados restantes de la solicitud inicial se pueden ver enviando otra solicitud de ListWorlds con el valor nextToken devuelto. Este valor debe estar entre 1 y 100. Si no se usa este parámetro, ListWorlds devuelve hasta 100 resultados y un valor nextToken, si corresponde.

Tipo: entero

Obligatorio: no

nextToken

Si la solicitud paginada anterior no devolvió todos los resultados restantes, el valor del parámetro nextToken del objeto de respuesta se establece en un token. Para recuperar el siguiente conjunto de resultados, vuelva a llamar a ListWorlds y asigne ese token al parámetro nextToken del objeto de solicitud. Si no quedan resultados, el NextToken parámetro del objeto de respuesta anterior se establece en nulo.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 2048 caracteres.

Patrón: [a-zA-Z0-9_.\-\/+=]*

Obligatorio: no

Sintaxis de la respuesta

HTTP/1.1 200
Content-type: application/json

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

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta de HTTP 200.

El servicio devuelve los siguientes datos en JSON formato.

nextToken

Si la solicitud paginada anterior no devolvió todos los resultados restantes, el valor del parámetro nextToken del objeto de respuesta se establece en un token. Para recuperar el siguiente conjunto de resultados, vuelva a llamar a ListWorlds y asigne ese token al parámetro nextToken del objeto de solicitud. Si no quedan resultados, el NextToken parámetro del objeto de respuesta anterior se establece en nulo.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 2048 caracteres.

Patrón: [a-zA-Z0-9_.\-\/+=]*

worldSummaries

Información resumida sobre los mundos.

Tipo: matriz de objetos WorldSummary

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

InternalServerException

AWS RoboMaker ha sufrido un problema con el servicio. Pruebe la llamada de nuevo.

HTTPCódigo de estado: 500

InvalidParameterException

Un parámetro especificado en una solicitud no es válido, no se admite o no se puede utilizar. El mensaje devuelto proporciona una explicación del valor del error.

HTTPCódigo de estado: 400

ThrottlingException

AWS RoboMaker no puede procesar la solicitud temporalmente. Pruebe la llamada de nuevo.

HTTPCódigo de estado: 400

Véase también

Para obtener más información sobre cómo usarlo API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente: