- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeWorldCommand
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/ .
Describes a world.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { RoboMakerClient, DescribeWorldCommand } from "@aws-sdk/client-robomaker"; // ES Modules import
// const { RoboMakerClient, DescribeWorldCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import
const client = new RoboMakerClient(config);
const input = { // DescribeWorldRequest
world: "STRING_VALUE", // required
};
const command = new DescribeWorldCommand(input);
const response = await client.send(command);
// { // DescribeWorldResponse
// arn: "STRING_VALUE",
// generationJob: "STRING_VALUE",
// template: "STRING_VALUE",
// createdAt: new Date("TIMESTAMP"),
// tags: { // TagMap
// "<keys>": "STRING_VALUE",
// },
// worldDescriptionBody: "STRING_VALUE",
// };
DescribeWorldCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
worldRequired | string | undefined | The Amazon Resource Name (arn) of the world you want to describe. |
DescribeWorldCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
arn | string | undefined | The Amazon Resource Name (arn) of the world. |
createdAt | Date | undefined | The time, in milliseconds since the epoch, when the world was created. |
generationJob | string | undefined | The Amazon Resource Name (arn) of the world generation job that generated the world. |
tags | Record<string, string> | undefined | A map that contains tag keys and tag values that are attached to the world. |
template | string | undefined | The world template. |
worldDescriptionBody | string | undefined | Returns the JSON formatted string that describes the contents of your world. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalServerException | server | AWS RoboMaker experienced a service issue. Try your call again. |
| InvalidParameterException | client | A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value. |
| ResourceNotFoundException | client | The specified resource does not exist. |
| ThrottlingException | client | AWS RoboMaker is temporarily unable to process the request. Try your call again. |
| RoboMakerServiceException | Base exception class for all service exceptions from RoboMaker service. |