AWS.SimSpaceWeaver — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

SimSpace Weaver (SimSpace Weaver) is a service that you can use to build and run large-scale spatial simulations in the Amazon Web Services Cloud. For example, you can create crowd simulations, large real-world environments, and immersive and interactive experiences. For more information about SimSpace Weaver, see the SimSpace Weaver User Guide .

This API reference describes the API operations and data types that you can use to communicate directly with SimSpace Weaver.

SimSpace Weaver also provides the SimSpace Weaver app SDK, which you use for app development. The SimSpace Weaver app SDK API reference is included in the SimSpace Weaver app SDK documentation. This documentation is part of the SimSpace Weaver app SDK distributable package.

Sending a Request Using SimSpaceWeaver

var simspaceweaver = new AWS.SimSpaceWeaver();
simspaceweaver.createSnapshot(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SimSpaceWeaver object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var simspaceweaver = new AWS.SimSpaceWeaver({apiVersion: '2022-10-28'});

You can also set the API version globally in AWS.config.apiVersions using the simspaceweaver service identifier:

AWS.config.apiVersions = {
  simspaceweaver: '2022-10-28',
  // other service API versions
};

var simspaceweaver = new AWS.SimSpaceWeaver();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.SimSpaceWeaver(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createSnapshot(params = {}, callback) ⇒ AWS.Request

Creates a snapshot of the specified simulation. A snapshot is a file that contains simulation state data at a specific time. The state data saved in a snapshot includes entity data from the State Fabric, the simulation configuration specified in the schema, and the clock tick number. You can use the snapshot to initialize a new simulation. For more information about snapshots, see Snapshots in the SimSpace Weaver User Guide.

You specify a Destination when you create a snapshot. The Destination is the name of an Amazon S3 bucket and an optional ObjectKeyPrefix. The ObjectKeyPrefix is usually the name of a folder in the bucket. SimSpace Weaver creates a snapshot folder inside the Destination and places the snapshot file there.

The snapshot file is an Amazon S3 object. It has an object key with the form: _object-key-prefix_/snapshot/_simulation-name_-_YYMMdd_-_HHmm_-_ss_.zip, where:

deleteApp(params = {}, callback) ⇒ AWS.Request

Deletes the instance of the given custom app.

deleteSimulation(params = {}, callback) ⇒ AWS.Request

Deletes all SimSpace Weaver resources assigned to the given simulation.

Note: Your simulation uses resources in other Amazon Web Services. This API operation doesn't delete resources in other Amazon Web Services.

describeApp(params = {}, callback) ⇒ AWS.Request

Returns the state of the given custom app.

describeSimulation(params = {}, callback) ⇒ AWS.Request

Returns the current state of the given simulation.

listApps(params = {}, callback) ⇒ AWS.Request

Lists all custom apps or service apps for the given simulation and domain.

listSimulations(params = {}, callback) ⇒ AWS.Request

Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all tags on a SimSpace Weaver resource.

startApp(params = {}, callback) ⇒ AWS.Request

Starts a custom app with the configuration specified in the simulation schema.

startClock(params = {}, callback) ⇒ AWS.Request

Starts the simulation clock.

startSimulation(params = {}, callback) ⇒ AWS.Request

Starts a simulation with the given name. You must choose to start your simulation from a schema or from a snapshot. For more information about the schema, see the schema reference in the SimSpace Weaver User Guide. For more information about snapshots, see Snapshots in the SimSpace Weaver User Guide.

stopApp(params = {}, callback) ⇒ AWS.Request

Stops the given custom app and shuts down all of its allocated compute resources.

stopClock(params = {}, callback) ⇒ AWS.Request

Stops the simulation clock.

stopSimulation(params = {}, callback) ⇒ AWS.Request

Stops the given simulation.

You can't restart a simulation after you stop it. If you want to restart a simulation, then you must stop it, delete it, and start a new instance of it.

untagResource(params = {}, callback) ⇒ AWS.Request