DescribeWorld - AWS RoboMaker

AWS RoboMaker ya no está disponible para nuevos clientes. Clientes actuales de AWS RoboMaker pueden seguir utilizando el servicio con normalidad. AWS Batch es ahora el servicio preferido para ejecutar simulaciones en contenedores. Más información.

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.

DescribeWorld

Describe un mundo.

Sintaxis de la solicitud

POST /describeWorld HTTP/1.1 Content-type: application/json { "world": "string" }

Parámetros de solicitud del URI

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

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

world

El nombre de recurso de Amazon (ARN) del mundo que desea describir.

Tipo: string

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

Patrón: arn:.*

Obligatorio: sí

Sintaxis de la respuesta

HTTP/1.1 200 Content-type: application/json { "arn": "string", "createdAt": number, "generationJob": "string", "tags": { "string" : "string" }, "template": "string", "worldDescriptionBody": "string" }

Elementos de respuesta

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

El servicio devuelve los datos siguientes en formato JSON.

arn

El Nombre de recurso de Amazon (ARN) del mundo.

Tipo: string

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

Patrón: arn:.*

createdAt

El tiempo, en milisegundos, desde la fecha de inicio, cuando se creó el mundo.

Tipo: marca temporal

generationJob

El nombre de recurso de Amazon (ARN) del trabajo de generación de mundos que generó el mundo.

Tipo: string

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

Patrón: arn:.*

tags

Un mapa que contiene las claves y los valores de las etiquetas que se asocian al mundo.

Tipo: mapa de cadena a cadena

Entradas de mapa: número mínimo de 0 elementos. Número máximo de 50 artículos.

Limitaciones de longitud de la clave: longitud mínima de 1. Longitud máxima de 128.

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

Limitaciones de longitud de los valores: longitud mínima de 0. La longitud máxima es de 256 caracteres.

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

template

La plantilla de mundo.

Tipo: string

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

Patrón: arn:.*

worldDescriptionBody

Devuelve la cadena con formato JSON que describe el contenido del mundo.

Tipo: string

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

Patrón: [\S\s]+

Errores

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

InternalServerException

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

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

Código de estado HTTP: 400

ResourceNotFoundException

El recurso especificado no existe.

Código de estado HTTP: 400

ThrottlingException

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

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulte lo siguiente: