End of support notice: On May 20, 2026, AWS will end support for AWS SimSpace Weaver. After May 20, 2026, you will no longer be able to access the SimSpace Weaver console or SimSpace Weaver resources. For more information, see AWS SimSpace Weaver end of support.
Use the SimSpace Weaver app SDK to work with snapshots
You can use scripts provided in the SimSpace Weaver app SDK (minimum version 1.13) to create and use snapshots.
The SimSpace Weaver app SDK organizes your simulations by project.
You can start multiple simulations from a single project. Each of those simulations
uses the same schema and app .zip files. The SimSpace Weaver app SDK
scripts place the assets for a simulation in a specific Amazon S3 bucket based on the project
name, AWS account number, and AWS Region. The scripts work with snapshot files located
in a snapshot
folder at the root of that bucket. The Amazon S3 URI to the snapshot
folder has following form:
s3://weaver-
project-name-lowercase
-account-number
-artifacts-region
/snapshot
Example
Project name:
MyProject
AWS account number: 111122223333
AWS Region:
us-west-2
Snapshot folder Amazon S3 URI:
s3://weaver-myproject-111122223333-artifacts-us-west-2/snapshot
If you want to use a different Amazon S3 bucket, see the following alternative ways to work with snapshots.
Other ways to work with snapshots
Topics
Use the SimSpace Weaver app SDK to create a snapshot
To create a snapshot, your simulation
must be in the STARTED
state. The snapshot creation starts after the current tick completes.
SimSpace Weaver stops sending ticks to the apps but the clock status still indicates STARTED
.
The simulation status changes to SNAPSHOT_IN_PROGRESS
.
After the snapshot is finished, the simulation state changes back to STARTED
and the apps receive ticks again.
To create a snapshot
-
At a Windows command prompt, go to the tools folder for your project.
cd
project-folder
\tools\windows -
If you don't know the name of your simulation, call the
list-simulations
API to see a list of your simulation resources. Make sure that the simulation status isSTARTED
..\weaver-
project-name
-cli.bat list-simulations -
Run the
create-snapshot
script for your project..\create-snapshot-
project-name
.bat --simulationsimulation-name
Example
.\create-snapshot-MyProject.bat --simulation MyProjectSimulation_23-04-29_12_00_00
SimSpace Weaver creates the snapshot file in the artifacts bucket for your project.
Example
Project name:
MyProject
AWS account number: 111122223333
AWS Region:
us-west-2
Snapshot folder Amazon S3 URI:
s3://weaver-myproject-111122223333-artifacts-us-west-2/snapshot
Simulation name:
MyProjectSimulation_23-04-29_12_00_00
Snapshot time: April 29, 2023, 15:30:27 UTC
Snapshot file name:
MyProjectSimulation_23-04-29_12_00_00-230429-1530-27.zip
Snapshot file Amazon S3 URI:
s3://weaver-myproject-111122223333-artifacts-us-west-2/snapshot/MyProjectSimulation_23-04-29_12_00_00-230429-1530-27.zip
Use the SimSpace Weaver app SDK to start a simulation from a snapshot
When you use an app SDK script to start a simulation from a snapshot, the scripts create a new simulation name the same way they do for starting a simulation without a snapshot.
Your snapshot file must exist in the snapshot location in Amazon S3 with the following Amazon S3 URI:
s3://weaver-
project-name-lowercase
-account-number
-artifacts-region
/snapshot
The app .zip files must be in the same location they were when the snapshot was created.
SimSpace Weaver creates a new simulation resource, initializes the State Fabric with entity data stored in the snapshot, starts new instances of the same spatial and service apps that were running when the snapshot was created, and sets the clock to the appropriate tick. You must start custom apps separately through the normal process.
The start-from-snapshot
script is the snapshot version of the start-simulation
script. Just like the start-simulation
script, the start-from-snapshot
script doesn't start the clock for you. You must start the clock separately.
To start a simulation from a snapshot
-
At a Windows command prompt, go to the tools folder for your project.
cd
project-folder
\tools\windows -
Run the
start-from-snapshot
script..\start-from-snapshot-
project-name
.bat --snapshot-s3-filesnapshot-file-name
Example
.\start-from-snapshot-MyProject.bat --snapshot-s3-file MyProjectSimulation_23-04-29_12_00_00-230429-1530-27.zip
Use the SimSpace Weaver app SDK to quick start a simulation from a snapshot
You can quick start a simulation from a snapshot. This is similar to a quick start without a snapshot.
Your snapshot file must exist in the snapshot location in Amazon S3 with the following Amazon S3 URI:
s3://weaver-
project-name-lowercase
-account-number
-artifacts-region
/snapshot
The app .zip files must be in the same location they were when the snapshot was created.
SimSpace Weaver creates a new simulation resource, initializes the State Fabric with entity data stored in the snapshot, starts new instances of the same spatial and service apps that were running when the snapshot was created, and sets the clock to the appropriate tick. You must start custom apps separately through the normal process.
The quick-start-from-snapshot
script is the snapshot version of the quick-start
script. Just like the quick-start
script, the quick-start-from-snapshot
script starts the clock for you. It also starts the view app for the pathfinding sample project.
To quick start a simulation from a snapshot
-
At a Windows command prompt, go to the tools folder for your project.
cd
project-folder
\tools\windows -
Run the
quick-start-from-snapshot
script..\quick-start-from-snapshot-
project-name
-cli.bat --snapshot-s3-filesnapshot-file-name
Example
.\quick-start-from-snapshot-MyProject-cli.bat --snapshot-s3-file MyProjectSimulation_23-04-29_12_00_00-230429-1530-27.zip
Use the SimSpace Weaver app SDK to list snapshots for a project
You can use the list-snapshots
script to list the snapshots for a project.
This script lists the files in the snapshot
folder for the project. Projects
are unique to the SimSpace Weaver app SDK, so you can only do this with the app SDK
scripts and only for projects. The script assumes that all files in the snapshot
folder on Amazon S3 are snapshot files. If you move or delete files from the folder then those
files won't appear in the list.
To list the snapshots for a project
-
At a Windows command prompt, go to the tools folder for your project.
cd
project-folder
\tools\windows -
Run the
list-snapshots
script..\list-snapshots-
project-name
.batExample
.\list-snapshots-MyProject.bat