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

ListSimulations

Lists the SimSpace Weaver simulations in the AWS account used to make the API call.

Request Syntax


GET /listsimulations?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of simulations to list.

Valid Range: Minimum value of 1.

NextToken

If SimSpace Weaver returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Simulations": [ 
      { 
         "Arn": "string",
         "CreationTime": number,
         "Name": "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.

NextToken

Type: String

Simulations

The list of simulations.

Type: Array of SimulationMetadata objects

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

ValidationException

HTTP Status Code: 400