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

DescribeSimulation

Returns the current state of the given simulation.

Request Syntax


GET /describesimulation?simulation=Simulation HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Simulation

The name of the simulation.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationTime": number,
   "Description": "string",
   "ExecutionId": "string",
   "LiveSimulationState": { 
      "Clocks": [ 
         { 
            "Status": "string",
            "TargetStatus": "string"
         }
      ],
      "Domains": [ 
         { 
            "Lifecycle": "string",
            "Name": "string"
         }
      ]
   },
   "LoggingConfiguration": { 
      "Destinations": [ 
         { 
            "CloudWatchLogsLogGroup": { 
               "LogGroupArn": "string"
            }
         }
      ]
   },
   "MaximumDuration": "string",
   "Name": "string",
   "RoleArn": "string",
   "SchemaError": "string",
   "SchemaS3Location": { 
      "BucketName": "string",
      "ObjectKey": "string"
   },
   "SnapshotS3Location": { 
      "BucketName": "string",
      "ObjectKey": "string"
   },
   "StartError": "string",
   "Status": "string",
   "TargetStatus": "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

Description

The description of the simulation.

Type: String

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

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}$

LiveSimulationState

A collection of additional state information, such as domain and clock configuration.

Type: LiveSimulationState object

LoggingConfiguration

Settings that control how SimSpace Weaver handles your simulation log data.

Type: LoggingConfiguration object

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]$

Name

The name of the simulation.

Type: String

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

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

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\/(.+)$

SchemaError

This parameter has been deprecated.

An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.

Type: String

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.

Type: S3Location object

SnapshotS3Location

A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app .zip files and schema file. For more information about Amazon S3, see the Amazon Simple Storage Service User Guide.

Type: S3Location object

StartError

An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the STARTING state.

Type: String

Status

The current lifecycle state of the simulation.

Type: String

TargetStatus

The desired lifecycle state of the simulation.

Type: String

Valid Values: UNKNOWN | STARTED | STOPPED | DELETED

Errors

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

AccessDeniedException

HTTP Status Code: 403

InternalServerException

HTTP Status Code: 500

ResourceNotFoundException

HTTP Status Code: 404

ValidationException

HTTP Status Code: 400