SimSpaceWeaverClient

Suggest an Edit

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.

Installation

NPM
npm install @aws-sdk/client-simspaceweaver
Yarn
yarn add @aws-sdk/client-simspaceweaver
pnpm
pnpm add @aws-sdk/client-simspaceweaver

SimSpaceWeaverClient Operations

Command
Summary
CreateSnapshotCommand

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:

  • YY is the 2-digit year

  • MM is the 2-digit month

  • dd is the 2-digit day of the month

  • HH is the 2-digit hour (24-hour clock)

  • mm is the 2-digit minutes

  • ss is the 2-digit seconds

DeleteAppCommand

Deletes the instance of the given custom app.

DeleteSimulationCommand

Deletes all SimSpace Weaver resources assigned to the given simulation.

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

DescribeAppCommand

Returns the state of the given custom app.

DescribeSimulationCommand

Returns the current state of the given simulation.

ListAppsCommand

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

ListSimulationsCommand

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

ListTagsForResourceCommand

Lists all tags on a SimSpace Weaver resource.

StartAppCommand

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

StartClockCommand

Starts the simulation clock.

StartSimulationCommand

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.

StopAppCommand

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

StopClockCommand

Stops the simulation clock.

StopSimulationCommand

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.

TagResourceCommand

Adds tags to a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources  in the Amazon Web Services General Reference.

UntagResourceCommand

Removes tags from a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources  in the Amazon Web Services General Reference.

SimSpaceWeaverClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: SimSpaceWeaverClientConfig