Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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 AWS 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

Request Syntax


POST /createsnapshot HTTP/1.1
Content-type: application/json

{
   "Destination": { 
      "BucketName": "string",
      "ObjectKeyPrefix": "string"
   },
   "Simulation": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Destination

The Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates the snapshot file.

The Amazon S3 bucket must be in the same AWS Region as the simulation.

Type: S3Destination object

Required: Yes

Simulation

The name of the simulation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_.-]+$

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

HTTP Status Code: 403

ConflictException

HTTP Status Code: 409

InternalServerException

HTTP Status Code: 500

ResourceNotFoundException

HTTP Status Code: 404

ValidationException

HTTP Status Code: 400