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

StartSimulation

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 AWS SimSpace Weaver User Guide. For more information about snapshots, see Snapshots in the AWS SimSpace Weaver User Guide.

Request Syntax


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

{
   "ClientToken": "string",
   "Description": "string",
   "MaximumDuration": "string",
   "Name": "string",
   "RoleArn": "string",
   "SchemaS3Location": { 
      "BucketName": "string",
      "ObjectKey": "string"
   },
   "SnapshotS3Location": { 
      "BucketName": "string",
      "ObjectKey": "string"
   },
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientToken

A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A ClientToken is also known as an idempotency token. A ClientToken expires after 24 hours.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 128.

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

Required: No

Description

The description of the simulation.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

MaximumDuration

The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches this limit. The maximum value is 14D, or its equivalent in the other units. The default value is 14D. A value equivalent to 0 makes the simulation immediately transition to Stopping as soon as it reaches Started.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 6.

Pattern: ^\d{1,5}[mhdMHD]$

Required: No

Name

The name of the simulation.

Type: String

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

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

Required: Yes

RoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference. For more information about IAM roles, see IAM roles in the AWS Identity and Access Management User Guide.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1600.

Pattern: ^arn:(?:aws|aws-cn|aws-us-gov):iam::(\d{12})?:role\/(.+)$

Required: Yes

SchemaS3Location

The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide.

Provide a SchemaS3Location to start your simulation from a schema.

If you provide a SchemaS3Location then you can't provide a SnapshotS3Location.

Type: S3Location object

Required: No

SnapshotS3Location

The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide.

Provide a SnapshotS3Location to start your simulation from a snapshot.

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

If you provide a SnapshotS3Location then you can't provide a SchemaS3Location.

Type: S3Location object

Required: No

Tags

A list of tags for the simulation. For more information about tags, see Tagging AWS resources in the AWS General Reference.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationTime": number,
   "ExecutionId": "string"
}

Response Elements

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

The following data is returned in JSON format by the service.

Arn

The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1600.

Pattern: ^arn:(?:aws|aws-cn|aws-us-gov):simspaceweaver:([a-z]{2}-[a-z]+-\d{1}):(\d{12})?:([a-z]+)\/(.+)$

CreationTime

The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

Type: Timestamp

ExecutionId

A universally unique identifier (UUID) for this simulation.

Type: String

Length Constraints: Minimum length of 36.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

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

ServiceQuotaExceededException

HTTP Status Code: 402

ValidationException

HTTP Status Code: 400