Class ListWorldGenerationJobsCommandProtected

Lists world generator jobs.

Example

Use a bare-bones client and the command you need to make an API call.

import { RoboMakerClient, ListWorldGenerationJobsCommand } from "@aws-sdk/client-robomaker"; // ES Modules import
// const { RoboMakerClient, ListWorldGenerationJobsCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import
const client = new RoboMakerClient(config);
const input = { // ListWorldGenerationJobsRequest
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
  filters: [ // Filters
    { // Filter
      name: "STRING_VALUE",
      values: [ // FilterValues
        "STRING_VALUE",
      ],
    },
  ],
};
const command = new ListWorldGenerationJobsCommand(input);
const response = await client.send(command);
// { // ListWorldGenerationJobsResponse
//   worldGenerationJobSummaries: [ // WorldGenerationJobSummaries // required
//     { // WorldGenerationJobSummary
//       arn: "STRING_VALUE",
//       template: "STRING_VALUE",
//       createdAt: new Date("TIMESTAMP"),
//       status: "STRING_VALUE",
//       worldCount: { // WorldCount
//         floorplanCount: Number("int"),
//         interiorCountPerFloorplan: Number("int"),
//       },
//       succeededWorldCount: Number("int"),
//       failedWorldCount: Number("int"),
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

Param

ListWorldGenerationJobsCommandInput

Returns

ListWorldGenerationJobsCommandOutput

See

• ListWorldGenerationJobsCommandInput for command's input shape.
• ListWorldGenerationJobsCommandOutput for command's response shape.
• config for RoboMakerClient's config shape.

Throws

InternalServerException (server fault)

AWS RoboMaker experienced a service issue. Try your call again.

Throws

InvalidParameterException (client fault)

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.

Throws

ThrottlingException (client fault)

AWS RoboMaker is temporarily unable to process the request. Try your call again.

Throws

RoboMakerServiceException

Base exception class for all service exceptions from RoboMaker service.