createSnapshot

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: <i>object-key-prefix</i>/snapshot/<i>simulation-name</i>-<i>YYMMdd</i>-<i>HHmm</i>-<i>ss</i>.zip, where:

  • <i>YY</i> is the 2-digit year

  • <i>MM</i> is the 2-digit month

  • <i>dd</i> is the 2-digit day of the month

  • <i>HH</i> is the 2-digit hour (24-hour clock)

  • <i>mm</i> is the 2-digit minutes

  • <i>ss</i> is the 2-digit seconds