SimSpaceWeaver

import { SimSpaceWeaver } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/simspaceweaver.ts?docs=full";

class SimSpaceWeaver {

constructor(apiFactory: client.ApiFactory);

async createSnapshot(params: CreateSnapshotInput, opts?: client.RequestOptions): Promise<void>;

async deleteApp(params: DeleteAppInput, opts?: client.RequestOptions): Promise<void>;

async deleteSimulation(params: DeleteSimulationInput, opts?: client.RequestOptions): Promise<void>;

async describeApp(params: DescribeAppInput, opts?: client.RequestOptions): Promise<DescribeAppOutput>;

async describeSimulation(params: DescribeSimulationInput, opts?: client.RequestOptions): Promise<DescribeSimulationOutput>;

async listApps(params: ListAppsInput, opts?: client.RequestOptions): Promise<ListAppsOutput>;

async listSimulations(params?: ListSimulationsInput, opts?: client.RequestOptions): Promise<ListSimulationsOutput>;

async listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>;

async startApp(params: StartAppInput, opts?: client.RequestOptions): Promise<StartAppOutput>;

async startClock(params: StartClockInput, opts?: client.RequestOptions): Promise<void>;

async startSimulation(params: StartSimulationInput, opts?: client.RequestOptions): Promise<StartSimulationOutput>;

async stopApp(params: StopAppInput, opts?: client.RequestOptions): Promise<void>;

async stopClock(params: StopClockInput, opts?: client.RequestOptions): Promise<void>;

async stopSimulation(params: StopSimulationInput, opts?: client.RequestOptions): Promise<void>;

async tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new SimSpaceWeaver(apiFactory: client.ApiFactory)

[src]

§Methods

createSnapshot(params: CreateSnapshotInput, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteApp(params: DeleteAppInput, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the instance of the given custom app.

deleteSimulation(params: DeleteSimulationInput, opts?: client.RequestOptions): Promise<void>

[src]

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: DescribeAppInput, opts?: client.RequestOptions): Promise<DescribeAppOutput>

[src]

Returns the state of the given custom app.

describeSimulation(params: DescribeSimulationInput, opts?: client.RequestOptions): Promise<DescribeSimulationOutput>

[src]

Returns the current state of the given simulation.

listApps(params: ListAppsInput, opts?: client.RequestOptions): Promise<ListAppsOutput>

[src]

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

listSimulations(params?: ListSimulationsInput, opts?: client.RequestOptions): Promise<ListSimulationsOutput>

[src]

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

listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>

[src]

Lists all tags on a SimSpace Weaver resource.

startApp(params: StartAppInput, opts?: client.RequestOptions): Promise<StartAppOutput>

[src]

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

startClock(params: StartClockInput, opts?: client.RequestOptions): Promise<void>

[src]

Starts the simulation clock.

startSimulation(params: StartSimulationInput, opts?: client.RequestOptions): Promise<StartSimulationOutput>

[src]

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: StopAppInput, opts?: client.RequestOptions): Promise<void>

[src]

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

stopClock(params: StopClockInput, opts?: client.RequestOptions): Promise<void>

[src]

Stops the simulation clock.

stopSimulation(params: StopSimulationInput, opts?: client.RequestOptions): Promise<void>

[src]

Stops the given simulation.

! IMPORTANT: ! 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.

tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>

[src]

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.

untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>

[src]

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.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]