openapi: 3.0.0 info: version: '2022-10-28' x-release: v4 title: AWS SimSpace Weaver description: '
SimSpace Weaver (SimSpace Weaver) is a managed service that you can use to build and operate large-scale spatial simulations in the Amazon Web Services Cloud. For example, you can create a digital twin of a city, crowd simulations with millions of people and objects, and massively multiplayer games with hundreds of thousands of connected players. For more information about SimSpace Weaver, see the SimSpace Weaver User Guide .
This API reference describes the API operations and data types that you can use to communicate directly with SimSpace Weaver.
SimSpace Weaver also provides the SimSpace Weaver app SDK, which you use for app development. The SimSpace Weaver app SDK API reference is included in the SimSpace Weaver app SDK documentation. This documentation is part of the SimSpace Weaver app SDK distributable package.
' x-logo: url: 'https://twitter.com/awscloud/profile_image?size=original' backgroundColor: '#FFFFFF' termsOfService: 'https://aws.amazon.com/service-terms/' contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: 'https://github.com/mermade/aws2openapi' x-twitter: PermittedSoc license: name: Apache 2.0 License url: 'http://www.apache.org/licenses/' x-providerName: amazonaws.com x-serviceName: simspaceweaver x-aws-signingName: simspaceweaver x-origin: - contentType: application/json url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/simspaceweaver-2022-10-28.normal.json' converter: url: 'https://github.com/mermade/aws2openapi' version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct' x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: 'https://docs.aws.amazon.com/simspaceweaver/' servers: - url: 'http://simspaceweaver.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS SimSpace Weaver multi-region endpoint - url: 'https://simspaceweaver.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS SimSpace Weaver multi-region endpoint - url: 'http://simspaceweaver.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS SimSpace Weaver endpoint for China (Beijing) and China (Ningxia) - url: 'https://simspaceweaver.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS SimSpace Weaver endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: /createsnapshot: post: operationId: CreateSnapshot description: '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: 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
Deletes all SimSpace Weaver resources assigned to the given simulation.
Your simulation uses resources in other Amazon Web Services. This API operation doesn't delete resources in other Amazon Web Services.
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.'
schema:
type: string
- name: simulation
in: query
required: true
description: The name of the simulation that you want to list apps for.
schema:
type: string
pattern: '^[a-zA-Z0-9_.-]+$'
minLength: 1
maxLength: 64
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon List Apps
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/listsimulations:
get:
operationId: ListSimulations
description: Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListSimulationsOutput'
examples:
ListSimulations200Example:
summary: Default ListSimulations 200
x-microcks-default: true
value:
NextToken: example-value
Simulations: example-value
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
ListSimulations480Example:
summary: Default ListSimulations 480
x-microcks-default: true
value: example-value
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListSimulations481Example:
summary: Default ListSimulations 481
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListSimulations482Example:
summary: Default ListSimulations 482
x-microcks-default: true
value: example-value
parameters:
- name: maxResults
in: query
required: false
description: The maximum number of simulations to list.
schema:
type: integer
minimum: 1
- name: nextToken
in: query
required: false
description: '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.'
schema:
type: string
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon List Simulations
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/tags/{ResourceArn}':
get:
operationId: ListTagsForResource
description: Lists all tags on a SimSpace Weaver resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTagsForResourceOutput'
examples:
ListTagsForResource200Example:
summary: Default ListTagsForResource 200
x-microcks-default: true
value:
Tags: example-value
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
ListTagsForResource480Example:
summary: Default ListTagsForResource 480
x-microcks-default: true
value: example-value
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListTagsForResource481Example:
summary: Default ListTagsForResource 481
x-microcks-default: true
value: example-value
parameters:
- name: ResourceArn
in: path
required: true
description: 'The Amazon Resource Name (ARN) of the resource. For more information about ARNs, see Amazon Resource
Names (ARNs) in the Amazon Web Services General Reference.'
schema:
type: string
pattern: '^arn:(?:aws|aws-cn|aws-us-gov):simspaceweaver:([a-z]{2}-[a-z]+-\d{1}):(\d{12})?:([a-z]+)\/(.+)$'
minLength: 0
maxLength: 1600
summary: Amazon List Tags For Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: TagResource
description: 'Adds tags to a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources
in the Amazon Web Services General Reference.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TagResourceOutput'
examples:
TagResource200Example:
summary: Default TagResource 200
x-microcks-default: true
value: {}
'480':
description: TooManyTagsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyTagsException'
examples:
TagResource480Example:
summary: Default TagResource 480
x-microcks-default: true
value: example-value
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
TagResource481Example:
summary: Default TagResource 481
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
TagResource482Example:
summary: Default TagResource 482
x-microcks-default: true
value: example-value
parameters:
- name: ResourceArn
in: path
required: true
description: 'The Amazon Resource Name (ARN) of the resource that you want to add tags to. For more information about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference.'
schema:
type: string
pattern: '^arn:(?:aws|aws-cn|aws-us-gov):simspaceweaver:([a-z]{2}-[a-z]+-\d{1}):(\d{12})?:([a-z]+)\/(.+)$'
minLength: 0
maxLength: 1600
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Tags
properties:
Tags:
description: A list of tags to apply to the resource.
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
examples:
TagResourceRequestExample:
summary: Default TagResource request
x-microcks-default: true
value:
Tags: {}
summary: Amazon Tag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/startapp:
post:
operationId: StartApp
description: Starts a custom app with the configuration specified in the simulation schema.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartAppOutput'
examples:
StartApp200Example:
summary: Default StartApp 200
x-microcks-default: true
value:
Domain: example-value
Name: MyResource
Simulation: example-value
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
StartApp480Example:
summary: Default StartApp 480
x-microcks-default: true
value: example-value
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
StartApp481Example:
summary: Default StartApp 481
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
StartApp482Example:
summary: Default StartApp 482
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
StartApp483Example:
summary: Default StartApp 483
x-microcks-default: true
value: example-value
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
StartApp484Example:
summary: Default StartApp 484
x-microcks-default: true
value: example-value
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Domain
- Name
- Simulation
properties:
ClientToken:
description: 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
pattern: '^[a-zA-Z0-9-]+$'
minLength: 32
maxLength: 128
format: password
Description:
description: The description of the app.
type: string
minLength: 0
maxLength: 500
Domain:
description: The name of the domain of the app.
type: string
pattern: '^[a-zA-Z0-9_.-]+$'
minLength: 1
maxLength: 64
LaunchOverrides:
description: Options that apply when the app starts. These options override default behavior.
type: object
properties:
LaunchCommands:
allOf:
- $ref: '#/components/schemas/LaunchCommandList'
- description: App launch commands and command line parameters that override the launch command configured in the simulation schema.
Name:
description: The name of the app.
type: string
pattern: '^[a-zA-Z0-9_.-]+$'
minLength: 1
maxLength: 64
Simulation:
description: The name of the simulation of the app.
type: string
pattern: '^[a-zA-Z0-9_.-]+$'
minLength: 1
maxLength: 64
examples:
StartAppRequestExample:
summary: Default StartApp request
x-microcks-default: true
value:
ClientToken: example-value
Description: example-value
Domain: example-value
LaunchOverrides:
LaunchCommands: example-value
Name: MyResource
Simulation: example-value
summary: Amazon Start App
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/startclock:
post:
operationId: StartClock
description: Starts the simulation clock.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartClockOutput'
examples:
StartClock200Example:
summary: Default StartClock 200
x-microcks-default: true
value: {}
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
StartClock480Example:
summary: Default StartClock 480
x-microcks-default: true
value: example-value
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
StartClock481Example:
summary: Default StartClock 481
x-microcks-default: true
value: example-value
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
StartClock482Example:
summary: Default StartClock 482
x-microcks-default: true
value: example-value
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
StartClock483Example:
summary: Default StartClock 483
x-microcks-default: true
value: example-value
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
StartClock484Example:
summary: Default StartClock 484
x-microcks-default: true
value: example-value
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Simulation
properties:
Simulation:
description: The name of the simulation.
type: string
pattern: '^[a-zA-Z0-9_.-]+$'
minLength: 1
maxLength: 64
examples:
StartClockRequestExample:
summary: Default StartClock request
x-microcks-default: true
value:
Simulation: example-value
summary: Amazon Start Clock
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/startsimulation:
post:
operationId: StartSimulation
description: '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 SimSpace Weaver User Guide. For more information about snapshots, see Snapshots
in the SimSpace Weaver User Guide.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartSimulationOutput'
examples:
StartSimulation200Example:
summary: Default StartSimulation 200
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreationTime: example-value
ExecutionId: example-value
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
StartSimulation480Example:
summary: Default StartSimulation 480
x-microcks-default: true
value: example-value
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
StartSimulation481Example:
summary: Default StartSimulation 481
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
StartSimulation482Example:
summary: Default StartSimulation 482
x-microcks-default: true
value: example-value
'483':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
StartSimulation483Example:
summary: Default StartSimulation 483
x-microcks-default: true
value: example-value
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
StartSimulation484Example:
summary: Default StartSimulation 484
x-microcks-default: true
value: example-value
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Name
- RoleArn
properties:
ClientToken:
description: 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
pattern: '^[a-zA-Z0-9-]+$'
minLength: 32
maxLength: 128
format: password
Description:
description: The description of the simulation.
type: string
minLength: 0
maxLength: 500
MaximumDuration:
description: '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
pattern: '^\d{1,5}[mhdMHD]$'
minLength: 2
maxLength: 6
Name:
description: The name of the simulation.
type: string
pattern: '^[a-zA-Z0-9_.-]+$'
minLength: 1
maxLength: 64
RoleArn:
description: 'The Amazon Resource Name (ARN) of the 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 Amazon Web Services General Reference. For more information about IAM roles, see IAM
roles in the Identity and Access Management User Guide.'
type: string
pattern: '^arn:(?:aws|aws-cn|aws-us-gov):iam::(\d{12})?:role\/(.+)$'
minLength: 0
maxLength: 1600
SchemaS3Location:
description: '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: object
properties:
BucketName:
allOf:
- $ref: '#/components/schemas/BucketName'
- description: 'The name of an Amazon S3 bucket. For more information about buckets, see Creating,
configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide.'
ObjectKey:
allOf:
- $ref: '#/components/schemas/ObjectKey'
- description: 'The key name of an object in Amazon S3. For more information about Amazon S3 objects and object keys, see Uploading,
downloading, and working with objects in Amazon S3 in the Amazon Simple Storage Service User Guide.'
SnapshotS3Location:
description: '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: object
properties:
BucketName:
allOf:
- $ref: '#/components/schemas/BucketName'
- description: 'The name of an Amazon S3 bucket. For more information about buckets, see Creating,
configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide.'
ObjectKey:
allOf:
- $ref: '#/components/schemas/ObjectKey'
- description: 'The key name of an object in Amazon S3. For more information about Amazon S3 objects and object keys, see Uploading,
downloading, and working with objects in Amazon S3 in the Amazon Simple Storage Service User Guide.'
Tags:
description: 'A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services
resources in the Amazon Web Services General Reference.'
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
examples:
StartSimulationRequestExample:
summary: Default StartSimulation request
x-microcks-default: true
value:
ClientToken: example-value
Description: example-value
MaximumDuration: example-value
Name: MyResource
RoleArn: arn:aws:service:us-east-1:123456789012:resource/example
SchemaS3Location:
BucketName: MyResource
ObjectKey: example-value
SnapshotS3Location:
BucketName: MyResource
ObjectKey: example-value
Tags: {}
summary: Amazon Start Simulation
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/stopapp:
post:
operationId: StopApp
description: Stops the given custom app and shuts down all of its allocated compute resources.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StopAppOutput'
examples:
StopApp200Example:
summary: Default StopApp 200
x-microcks-default: true
value: {}
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
StopApp480Example:
summary: Default StopApp 480
x-microcks-default: true
value: example-value
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
StopApp481Example:
summary: Default StopApp 481
x-microcks-default: true
value: example-value
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
StopApp482Example:
summary: Default StopApp 482
x-microcks-default: true
value: example-value
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
StopApp483Example:
summary: Default StopApp 483
x-microcks-default: true
value: example-value
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
StopApp484Example:
summary: Default StopApp 484
x-microcks-default: true
value: example-value
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- App
- Domain
- Simulation
properties:
App:
description: The name of the app.
type: string
pattern: '^[a-zA-Z0-9_.-]+$'
minLength: 1
maxLength: 64
Domain:
description: The name of the domain of the app.
type: string
pattern: '^[a-zA-Z0-9_.-]+$'
minLength: 1
maxLength: 64
Simulation:
description: The name of the simulation of the app.
type: string
pattern: '^[a-zA-Z0-9_.-]+$'
minLength: 1
maxLength: 64
examples:
StopAppRequestExample:
summary: Default StopApp request
x-microcks-default: true
value:
App: example-value
Domain: example-value
Simulation: example-value
summary: Amazon Stop App
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/stopclock:
post:
operationId: StopClock
description: Stops the simulation clock.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StopClockOutput'
examples:
StopClock200Example:
summary: Default StopClock 200
x-microcks-default: true
value: {}
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
StopClock480Example:
summary: Default StopClock 480
x-microcks-default: true
value: example-value
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
StopClock481Example:
summary: Default StopClock 481
x-microcks-default: true
value: example-value
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
StopClock482Example:
summary: Default StopClock 482
x-microcks-default: true
value: example-value
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
StopClock483Example:
summary: Default StopClock 483
x-microcks-default: true
value: example-value
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
StopClock484Example:
summary: Default StopClock 484
x-microcks-default: true
value: example-value
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Simulation
properties:
Simulation:
description: The name of the simulation.
type: string
pattern: '^[a-zA-Z0-9_.-]+$'
minLength: 1
maxLength: 64
examples:
StopClockRequestExample:
summary: Default StopClock request
x-microcks-default: true
value:
Simulation: example-value
summary: Amazon Stop Clock
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/stopsimulation:
post:
operationId: StopSimulation
description: 'Stops the given simulation.
You can''t restart a simulation after you stop it. If you want to restart a simulation, then you must stop it, delete it, and start a new instance of it.
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.'
Name:
allOf:
- $ref: '#/components/schemas/SimSpaceWeaverResourceName'
- description: The name of the simulation.
RoleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: 'The Amazon Resource Name (ARN) of the 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 Amazon Web Services General Reference. For more information about IAM roles, see IAM
roles in the Identity and Access Management User Guide.'
SchemaError:
allOf:
- $ref: '#/components/schemas/OptionalString'
- deprecated: true
description: 'An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.SchemaError is no longer used, check StartError instead.'
SchemaS3Location:
allOf:
- $ref: '#/components/schemas/S3Location'
- description: '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 .'
SnapshotS3Location:
$ref: '#/components/schemas/S3Location'
StartError:
allOf:
- $ref: '#/components/schemas/OptionalString'
- description: An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the STARTING state.
Status:
allOf:
- $ref: '#/components/schemas/SimulationStatus'
- description: The current lifecycle state of the simulation.
TargetStatus:
allOf:
- $ref: '#/components/schemas/SimulationTargetStatus'
- description: The desired lifecycle state of the simulation.
ListAppsOutput:
type: object
properties:
Apps:
allOf:
- $ref: '#/components/schemas/SimulationAppList'
- description: The list of apps for the given simulation and domain.
NextToken:
allOf:
- $ref: '#/components/schemas/OptionalString'
- description: '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.'
ListSimulationsOutput:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/OptionalString'
- description: '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.'
Simulations:
allOf:
- $ref: '#/components/schemas/SimulationList'
- description: The list of simulations.
ListTagsForResourceOutput:
type: object
properties:
Tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The list of tags for the resource.
StartAppOutput:
type: object
properties:
Domain:
allOf:
- $ref: '#/components/schemas/SimSpaceWeaverResourceName'
- description: The name of the domain of the app.
Name:
allOf:
- $ref: '#/components/schemas/SimSpaceWeaverResourceName'
- description: The name of the app.
Simulation:
allOf:
- $ref: '#/components/schemas/SimSpaceWeaverResourceName'
- description: The name of the simulation of the app.
LaunchCommandList:
type: array
items:
$ref: '#/components/schemas/NonEmptyString'
ServiceQuotaExceededException: {}
StartClockOutput:
type: object
properties: {}
StartSimulationOutput:
type: object
properties:
Arn:
allOf:
- $ref: '#/components/schemas/SimSpaceWeaverArn'
- description: 'The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference.'
CreationTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: '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).'
ExecutionId:
allOf:
- $ref: '#/components/schemas/UUID'
- description: A universally unique identifier (UUID) for this simulation.
ObjectKey:
type: string
minLength: 1
maxLength: 1024
TagValue:
type: string
minLength: 0
maxLength: 256
StopAppOutput:
type: object
properties: {}
StopClockOutput:
type: object
properties: {}
StopSimulationOutput:
type: object
properties: {}
TagResourceOutput:
type: object
properties: {}
TooManyTagsException: {}
UntagResourceOutput:
type: object
properties: {}
TagKey:
type: string
minLength: 1
maxLength: 128
SimulationAppPortMapping:
type: object
properties:
Actual:
allOf:
- $ref: '#/components/schemas/PortNumber'
- description: The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port number when the app starts. SimSpace Weaver maps the Declared port to
the Actual port. Clients connect to the app using the app's IP address and the Actual port number.
Declared:
allOf:
- $ref: '#/components/schemas/PortNumber'
- description: 'The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps the Declared port to the Actual port. The source code for
the app should bind to the Declared port.'
description: A collection of TCP/UDP ports for a custom or service app.
AppPortMappings:
type: array
items:
$ref: '#/components/schemas/SimulationAppPortMapping'
ClientToken:
type: string
pattern: '^[a-zA-Z0-9-]+$'
minLength: 32
maxLength: 128
format: password
ClockStatus:
type: string
enum:
- UNKNOWN
- STARTING
- STARTED
- STOPPING
- STOPPED
ClockTargetStatus:
type: string
enum:
- UNKNOWN
- STARTED
- STOPPED
LogGroupArn:
type: string
pattern: '^arn:(?:aws|aws-cn|aws-us-gov):log-group:([a-z]{2}-[a-z]+-\d{1}):(\d{12})?:role\/(.+)$'
minLength: 0
maxLength: 1600
CloudWatchLogsLogGroup:
type: object
properties:
LogGroupArn:
allOf:
- $ref: '#/components/schemas/LogGroupArn'
- description: 'The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group for the simulation. For more information about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference. For more information about log groups, see Working
with log groups and log streams in the Amazon CloudWatch Logs User Guide.'
description: 'The Amazon CloudWatch Logs log group for the simulation. For more information about log groups, see Working
with log groups and log streams in the Amazon CloudWatch Logs User Guide.'
S3Destination:
type: object
properties:
BucketName:
allOf:
- $ref: '#/components/schemas/BucketName'
- description: 'The name of an Amazon S3 bucket. For more information about buckets, see Creating, configuring,
and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide.'
ObjectKeyPrefix:
allOf:
- $ref: '#/components/schemas/ObjectKeyPrefix'
- description: 'A string prefix for an Amazon S3 object key. It''s usually a folder name. For more information about folders in Amazon S3, see Organizing
objects in the Amazon S3 console using folders in the Amazon Simple Storage Service User Guide.'
description: An Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates a file.
SimSpaceWeaverResourceName:
type: string
pattern: '^[a-zA-Z0-9_.-]+$'
minLength: 1
maxLength: 64
CreateSnapshotInput:
type: object
required:
- Destination
- Simulation
title: CreateSnapshotInput
properties:
Destination:
allOf:
- $ref: '#/components/schemas/S3Destination'
- description: 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 Amazon Web Services Region as the simulation.
Simulation: allOf: - $ref: '#/components/schemas/SimSpaceWeaverResourceName' - description: The name of the simulation. DeleteAppInput: type: object title: DeleteAppInput properties: {} DeleteSimulationInput: type: object title: DeleteSimulationInput properties: {} SimSpaceWeaverLongResourceName: type: string pattern: '^[a-zA-Z0-9_.-]+$' minLength: 1 maxLength: 256 DescribeAppInput: type: object title: DescribeAppInput properties: {} Description: type: string minLength: 0 maxLength: 500 SimulationAppEndpointInfo: type: object properties: Address: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The IP address of the app. SimSpace Weaver dynamically assigns this IP address when the app starts. IngressPortMappings: allOf: - $ref: '#/components/schemas/AppPortMappings' - description: The inbound TCP/UDP port numbers of the app. The combination of an IP address and a port number form a network endpoint. description: 'Information about the network endpoint that you can use to connect to your custom or service app. For more information about SimSpace Weaver apps, see Key concepts: Apps in the SimSpace Weaver User Guide..' LaunchOverrides: type: object properties: LaunchCommands: allOf: - $ref: '#/components/schemas/LaunchCommandList' - description: App launch commands and command line parameters that override the launch command configured in the simulation schema. description: Options that apply when the app starts. These options override default behavior. SimulationAppStatus: type: string enum: - STARTING - STARTED - STOPPING - STOPPED - ERROR - UNKNOWN SimulationAppTargetStatus: type: string enum: - UNKNOWN - STARTED - STOPPED DescribeSimulationInput: type: object title: DescribeSimulationInput properties: {} SimSpaceWeaverArn: type: string pattern: '^arn:(?:aws|aws-cn|aws-us-gov):simspaceweaver:([a-z]{2}-[a-z]+-\d{1}):(\d{12})?:([a-z]+)\/(.+)$' minLength: 0 maxLength: 1600 Timestamp: type: string format: date-time UUID: type: string pattern: '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$' minLength: 36 LiveSimulationState: type: object properties: Clocks: allOf: - $ref: '#/components/schemas/SimulationClockList' - description: 'A list of simulation clocks.
At this time, a simulation has only one clock.
The type of lifecycle management for apps in the domain. Indicates whether apps in this domain are managed (SimSpace Weaver starts and stops the apps) or unmanaged (you must start and stop the apps).
Lifecycle types
PerWorker – Managed: SimSpace Weaver starts one app on each worker.
BySpatialSubdivision – Managed: SimSpace Weaver starts one app for each spatial partition.
ByRequest – Unmanaged: You use the StartApp
API to start the apps and use the StopApp API to stop the apps.
A collection of app instances that run the same executable app code and have the same launch options and commands.
For more information about domains, see Key concepts: Domains in the SimSpace Weaver User Guide.
' DomainList: type: array items: $ref: '#/components/schemas/Domain' NonEmptyString: type: string minLength: 1 maxLength: 1600 PositiveInteger: type: integer minimum: 1 ListAppsInput: type: object title: ListAppsInput properties: {} SimulationAppList: type: array items: $ref: '#/components/schemas/SimulationAppMetadata' ListSimulationsInput: type: object title: ListSimulationsInput properties: {} SimulationList: type: array items: $ref: '#/components/schemas/SimulationMetadata' ListTagsForResourceInput: type: object title: ListTagsForResourceInput properties: {} TagMap: type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' SimulationClockList: type: array items: $ref: '#/components/schemas/SimulationClock' LogDestination: type: object properties: CloudWatchLogsLogGroup: allOf: - $ref: '#/components/schemas/CloudWatchLogsLogGroup' - description: 'An Amazon CloudWatch Logs log group that stores simulation log data. For more information about log groups, see Working with log groups and log streams in the Amazon CloudWatch Logs User Guide.' description: The location where SimSpace Weaver sends simulation log data. LogDestinations: type: array items: $ref: '#/components/schemas/LogDestination' PortNumber: type: integer minimum: 0 maximum: 65535 SimulationAppMetadata: type: object properties: Domain: allOf: - $ref: '#/components/schemas/SimSpaceWeaverResourceName' - description: 'The domain of the app. For more information about domains, see Key concepts: Domains in the SimSpace Weaver User Guide.' Name: allOf: - $ref: '#/components/schemas/SimSpaceWeaverLongResourceName' - description: The name of the app. Simulation: allOf: - $ref: '#/components/schemas/SimSpaceWeaverResourceName' - description: The name of the simulation of the app. Status: allOf: - $ref: '#/components/schemas/SimulationAppStatus' - description: The current status of the app. TargetStatus: allOf: - $ref: '#/components/schemas/SimulationAppTargetStatus' - description: The desired status of the app. description: A collection of metadata about the app. SimulationClock: type: object properties: Status: allOf: - $ref: '#/components/schemas/ClockStatus' - description: The current status of the simulation clock. TargetStatus: allOf: - $ref: '#/components/schemas/ClockTargetStatus' - description: The desired status of the simulation clock. description: Status information about the simulation clock. SimulationMetadata: type: object properties: Arn: allOf: - $ref: '#/components/schemas/SimSpaceWeaverArn' - description: 'The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.' CreationTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: '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).' Name: allOf: - $ref: '#/components/schemas/SimSpaceWeaverResourceName' - description: The name of the simulation. Status: allOf: - $ref: '#/components/schemas/SimulationStatus' - description: The current status of the simulation. TargetStatus: allOf: - $ref: '#/components/schemas/SimulationTargetStatus' - description: The desired status of the simulation. description: A collection of data about the simulation. StartAppInput: type: object required: - Domain - Name - Simulation title: StartAppInput properties: ClientToken: allOf: - $ref: '#/components/schemas/ClientToken' - description: A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. AClientToken is also known as an
idempotency token. A ClientToken expires after 24 hours.
Description:
allOf:
- $ref: '#/components/schemas/Description'
- description: The description of the app.
Domain:
allOf:
- $ref: '#/components/schemas/SimSpaceWeaverResourceName'
- description: The name of the domain of the app.
LaunchOverrides:
$ref: '#/components/schemas/LaunchOverrides'
Name:
allOf:
- $ref: '#/components/schemas/SimSpaceWeaverResourceName'
- description: The name of the app.
Simulation:
allOf:
- $ref: '#/components/schemas/SimSpaceWeaverResourceName'
- description: The name of the simulation of the app.
StartClockInput:
type: object
required:
- Simulation
title: StartClockInput
properties:
Simulation:
allOf:
- $ref: '#/components/schemas/SimSpaceWeaverResourceName'
- description: The name of the simulation.
StartSimulationInput:
type: object
required:
- Name
- RoleArn
title: StartSimulationInput
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: 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.
Description:
allOf:
- $ref: '#/components/schemas/Description'
- description: The description of the simulation.
MaximumDuration:
allOf:
- $ref: '#/components/schemas/TimeToLiveString'
- description: '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.'
Name:
allOf:
- $ref: '#/components/schemas/SimSpaceWeaverResourceName'
- description: The name of the simulation.
RoleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: 'The Amazon Resource Name (ARN) of the 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 Amazon Web Services General Reference. For more information about IAM roles, see IAM
roles in the Identity and Access Management User Guide.'
SchemaS3Location:
allOf:
- $ref: '#/components/schemas/S3Location'
- description: '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.
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 Amazon Web Services Region as the simulation.
If you provide a SnapshotS3Location then you can''t provide a SchemaS3Location.