1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2022-10-28", 5 "endpointPrefix":"simspaceweaver", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceFullName":"AWS SimSpace Weaver", 9 "serviceId":"SimSpaceWeaver", 10 "signatureVersion":"v4", 11 "signingName":"simspaceweaver", 12 "uid":"simspaceweaver-2022-10-28" 13 }, 14 "operations":{ 15 "CreateSnapshot":{ 16 "name":"CreateSnapshot", 17 "http":{ 18 "method":"POST", 19 "requestUri":"/createsnapshot", 20 "responseCode":200 21 }, 22 "input":{"shape":"CreateSnapshotInput"}, 23 "output":{"shape":"CreateSnapshotOutput"}, 24 "errors":[ 25 {"shape":"ResourceNotFoundException"}, 26 {"shape":"InternalServerException"}, 27 {"shape":"AccessDeniedException"}, 28 {"shape":"ValidationException"}, 29 {"shape":"ConflictException"} 30 ], 31 "documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html\">Snapshots</a> in the <i>SimSpace Weaver User Guide</i>. </p> <p>You specify a <code>Destination</code> when you create a snapshot. The <code>Destination</code> is the name of an Amazon S3 bucket and an optional <code>ObjectKeyPrefix</code>. The <code>ObjectKeyPrefix</code> is usually the name of a folder in the bucket. SimSpace Weaver creates a <code>snapshot</code> folder inside the <code>Destination</code> and places the snapshot file there.</p> <p>The snapshot file is an Amazon S3 object. It has an object key with the form: <code> <i>object-key-prefix</i>/snapshot/<i>simulation-name</i>-<i>YYMMdd</i>-<i>HHmm</i>-<i>ss</i>.zip</code>, where: </p> <ul> <li> <p> <code> <i>YY</i> </code> is the 2-digit year</p> </li> <li> <p> <code> <i>MM</i> </code> is the 2-digit month</p> </li> <li> <p> <code> <i>dd</i> </code> is the 2-digit day of the month</p> </li> <li> <p> <code> <i>HH</i> </code> is the 2-digit hour (24-hour clock)</p> </li> <li> <p> <code> <i>mm</i> </code> is the 2-digit minutes</p> </li> <li> <p> <code> <i>ss</i> </code> is the 2-digit seconds</p> </li> </ul>" 32 }, 33 "DeleteApp":{ 34 "name":"DeleteApp", 35 "http":{ 36 "method":"DELETE", 37 "requestUri":"/deleteapp", 38 "responseCode":200 39 }, 40 "input":{"shape":"DeleteAppInput"}, 41 "output":{"shape":"DeleteAppOutput"}, 42 "errors":[ 43 {"shape":"ResourceNotFoundException"}, 44 {"shape":"InternalServerException"}, 45 {"shape":"AccessDeniedException"}, 46 {"shape":"ValidationException"}, 47 {"shape":"ConflictException"} 48 ], 49 "documentation":"<p>Deletes the instance of the given custom app.</p>", 50 "idempotent":true 51 }, 52 "DeleteSimulation":{ 53 "name":"DeleteSimulation", 54 "http":{ 55 "method":"DELETE", 56 "requestUri":"/deletesimulation", 57 "responseCode":200 58 }, 59 "input":{"shape":"DeleteSimulationInput"}, 60 "output":{"shape":"DeleteSimulationOutput"}, 61 "errors":[ 62 {"shape":"ResourceNotFoundException"}, 63 {"shape":"InternalServerException"}, 64 {"shape":"AccessDeniedException"}, 65 {"shape":"ValidationException"}, 66 {"shape":"ConflictException"} 67 ], 68 "documentation":"<p>Deletes all SimSpace Weaver resources assigned to the given simulation.</p> <note> <p>Your simulation uses resources in other Amazon Web Services. This API operation doesn't delete resources in other Amazon Web Services.</p> </note>", 69 "idempotent":true 70 }, 71 "DescribeApp":{ 72 "name":"DescribeApp", 73 "http":{ 74 "method":"GET", 75 "requestUri":"/describeapp", 76 "responseCode":200 77 }, 78 "input":{"shape":"DescribeAppInput"}, 79 "output":{"shape":"DescribeAppOutput"}, 80 "errors":[ 81 {"shape":"ResourceNotFoundException"}, 82 {"shape":"InternalServerException"}, 83 {"shape":"AccessDeniedException"}, 84 {"shape":"ValidationException"} 85 ], 86 "documentation":"<p>Returns the state of the given custom app.</p>" 87 }, 88 "DescribeSimulation":{ 89 "name":"DescribeSimulation", 90 "http":{ 91 "method":"GET", 92 "requestUri":"/describesimulation", 93 "responseCode":200 94 }, 95 "input":{"shape":"DescribeSimulationInput"}, 96 "output":{"shape":"DescribeSimulationOutput"}, 97 "errors":[ 98 {"shape":"ResourceNotFoundException"}, 99 {"shape":"InternalServerException"}, 100 {"shape":"AccessDeniedException"}, 101 {"shape":"ValidationException"} 102 ], 103 "documentation":"<p>Returns the current state of the given simulation.</p>" 104 }, 105 "ListApps":{ 106 "name":"ListApps", 107 "http":{ 108 "method":"GET", 109 "requestUri":"/listapps", 110 "responseCode":200 111 }, 112 "input":{"shape":"ListAppsInput"}, 113 "output":{"shape":"ListAppsOutput"}, 114 "errors":[ 115 {"shape":"ResourceNotFoundException"}, 116 {"shape":"InternalServerException"}, 117 {"shape":"AccessDeniedException"}, 118 {"shape":"ValidationException"} 119 ], 120 "documentation":"<p>Lists all custom apps or service apps for the given simulation and domain.</p>" 121 }, 122 "ListSimulations":{ 123 "name":"ListSimulations", 124 "http":{ 125 "method":"GET", 126 "requestUri":"/listsimulations", 127 "responseCode":200 128 }, 129 "input":{"shape":"ListSimulationsInput"}, 130 "output":{"shape":"ListSimulationsOutput"}, 131 "errors":[ 132 {"shape":"InternalServerException"}, 133 {"shape":"AccessDeniedException"}, 134 {"shape":"ValidationException"} 135 ], 136 "documentation":"<p>Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.</p>" 137 }, 138 "ListTagsForResource":{ 139 "name":"ListTagsForResource", 140 "http":{ 141 "method":"GET", 142 "requestUri":"/tags/{ResourceArn}", 143 "responseCode":200 144 }, 145 "input":{"shape":"ListTagsForResourceInput"}, 146 "output":{"shape":"ListTagsForResourceOutput"}, 147 "errors":[ 148 {"shape":"ResourceNotFoundException"}, 149 {"shape":"ValidationException"} 150 ], 151 "documentation":"<p>Lists all tags on a SimSpace Weaver resource.</p>" 152 }, 153 "StartApp":{ 154 "name":"StartApp", 155 "http":{ 156 "method":"POST", 157 "requestUri":"/startapp", 158 "responseCode":200 159 }, 160 "input":{"shape":"StartAppInput"}, 161 "output":{"shape":"StartAppOutput"}, 162 "errors":[ 163 {"shape":"InternalServerException"}, 164 {"shape":"AccessDeniedException"}, 165 {"shape":"ValidationException"}, 166 {"shape":"ServiceQuotaExceededException"}, 167 {"shape":"ConflictException"} 168 ], 169 "documentation":"<p>Starts a custom app with the configuration specified in the simulation schema.</p>" 170 }, 171 "StartClock":{ 172 "name":"StartClock", 173 "http":{ 174 "method":"POST", 175 "requestUri":"/startclock", 176 "responseCode":200 177 }, 178 "input":{"shape":"StartClockInput"}, 179 "output":{"shape":"StartClockOutput"}, 180 "errors":[ 181 {"shape":"ResourceNotFoundException"}, 182 {"shape":"InternalServerException"}, 183 {"shape":"AccessDeniedException"}, 184 {"shape":"ValidationException"}, 185 {"shape":"ConflictException"} 186 ], 187 "documentation":"<p>Starts the simulation clock.</p>" 188 }, 189 "StartSimulation":{ 190 "name":"StartSimulation", 191 "http":{ 192 "method":"POST", 193 "requestUri":"/startsimulation", 194 "responseCode":200 195 }, 196 "input":{"shape":"StartSimulationInput"}, 197 "output":{"shape":"StartSimulationOutput"}, 198 "errors":[ 199 {"shape":"InternalServerException"}, 200 {"shape":"AccessDeniedException"}, 201 {"shape":"ValidationException"}, 202 {"shape":"ServiceQuotaExceededException"}, 203 {"shape":"ConflictException"} 204 ], 205 "documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/simspaceweaver/latest/userguide/schema-reference.html\">schema reference</a> in the <i>SimSpace Weaver User Guide</i>. For more information about snapshots, see <a href=\"https://docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html\">Snapshots</a> in the <i>SimSpace Weaver User Guide</i>.</p>" 206 }, 207 "StopApp":{ 208 "name":"StopApp", 209 "http":{ 210 "method":"POST", 211 "requestUri":"/stopapp", 212 "responseCode":200 213 }, 214 "input":{"shape":"StopAppInput"}, 215 "output":{"shape":"StopAppOutput"}, 216 "errors":[ 217 {"shape":"ResourceNotFoundException"}, 218 {"shape":"InternalServerException"}, 219 {"shape":"AccessDeniedException"}, 220 {"shape":"ValidationException"}, 221 {"shape":"ConflictException"} 222 ], 223 "documentation":"<p>Stops the given custom app and shuts down all of its allocated compute resources.</p>" 224 }, 225 "StopClock":{ 226 "name":"StopClock", 227 "http":{ 228 "method":"POST", 229 "requestUri":"/stopclock", 230 "responseCode":200 231 }, 232 "input":{"shape":"StopClockInput"}, 233 "output":{"shape":"StopClockOutput"}, 234 "errors":[ 235 {"shape":"ResourceNotFoundException"}, 236 {"shape":"InternalServerException"}, 237 {"shape":"AccessDeniedException"}, 238 {"shape":"ValidationException"}, 239 {"shape":"ConflictException"} 240 ], 241 "documentation":"<p>Stops the simulation clock.</p>" 242 }, 243 "StopSimulation":{ 244 "name":"StopSimulation", 245 "http":{ 246 "method":"POST", 247 "requestUri":"/stopsimulation", 248 "responseCode":200 249 }, 250 "input":{"shape":"StopSimulationInput"}, 251 "output":{"shape":"StopSimulationOutput"}, 252 "errors":[ 253 {"shape":"ResourceNotFoundException"}, 254 {"shape":"InternalServerException"}, 255 {"shape":"AccessDeniedException"}, 256 {"shape":"ValidationException"}, 257 {"shape":"ConflictException"} 258 ], 259 "documentation":"<p>Stops the given simulation.</p> <important> <p>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.</p> </important>" 260 }, 261 "TagResource":{ 262 "name":"TagResource", 263 "http":{ 264 "method":"POST", 265 "requestUri":"/tags/{ResourceArn}", 266 "responseCode":200 267 }, 268 "input":{"shape":"TagResourceInput"}, 269 "output":{"shape":"TagResourceOutput"}, 270 "errors":[ 271 {"shape":"TooManyTagsException"}, 272 {"shape":"ResourceNotFoundException"}, 273 {"shape":"ValidationException"} 274 ], 275 "documentation":"<p>Adds tags to a SimSpace Weaver resource. For more information about tags, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</p>" 276 }, 277 "UntagResource":{ 278 "name":"UntagResource", 279 "http":{ 280 "method":"DELETE", 281 "requestUri":"/tags/{ResourceArn}", 282 "responseCode":200 283 }, 284 "input":{"shape":"UntagResourceInput"}, 285 "output":{"shape":"UntagResourceOutput"}, 286 "errors":[ 287 {"shape":"ResourceNotFoundException"}, 288 {"shape":"ValidationException"} 289 ], 290 "documentation":"<p>Removes tags from a SimSpace Weaver resource. For more information about tags, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</p>" 291 } 292 }, 293 "shapes":{ 294 "AccessDeniedException":{ 295 "type":"structure", 296 "members":{ 297 "Message":{"shape":"NonEmptyString"} 298 }, 299 "documentation":"<p/>", 300 "error":{ 301 "httpStatusCode":403, 302 "senderFault":true 303 }, 304 "exception":true 305 }, 306 "AppPortMappings":{ 307 "type":"list", 308 "member":{"shape":"SimulationAppPortMapping"} 309 }, 310 "BucketName":{ 311 "type":"string", 312 "max":63, 313 "min":3 314 }, 315 "ClientToken":{ 316 "type":"string", 317 "max":128, 318 "min":32, 319 "pattern":"^[a-zA-Z0-9-]+$", 320 "sensitive":true 321 }, 322 "ClockStatus":{ 323 "type":"string", 324 "enum":[ 325 "UNKNOWN", 326 "STARTING", 327 "STARTED", 328 "STOPPING", 329 "STOPPED" 330 ] 331 }, 332 "ClockTargetStatus":{ 333 "type":"string", 334 "enum":[ 335 "UNKNOWN", 336 "STARTED", 337 "STOPPED" 338 ] 339 }, 340 "CloudWatchLogsLogGroup":{ 341 "type":"structure", 342 "members":{ 343 "LogGroupArn":{ 344 "shape":"LogGroupArn", 345 "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group for the simulation. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. For more information about log groups, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html\">Working with log groups and log streams</a> in the <i>Amazon CloudWatch Logs User Guide</i>.</p>" 346 } 347 }, 348 "documentation":"<p>The Amazon CloudWatch Logs log group for the simulation. For more information about log groups, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html\">Working with log groups and log streams</a> in the <i>Amazon CloudWatch Logs User Guide</i>.</p>" 349 }, 350 "ConflictException":{ 351 "type":"structure", 352 "members":{ 353 "Message":{"shape":"NonEmptyString"} 354 }, 355 "documentation":"<p/>", 356 "error":{ 357 "httpStatusCode":409, 358 "senderFault":true 359 }, 360 "exception":true 361 }, 362 "CreateSnapshotInput":{ 363 "type":"structure", 364 "required":[ 365 "Destination", 366 "Simulation" 367 ], 368 "members":{ 369 "Destination":{ 370 "shape":"S3Destination", 371 "documentation":"<p>The Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates the snapshot file.</p> <p>The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.</p>" 372 }, 373 "Simulation":{ 374 "shape":"SimSpaceWeaverResourceName", 375 "documentation":"<p>The name of the simulation.</p>" 376 } 377 } 378 }, 379 "CreateSnapshotOutput":{ 380 "type":"structure", 381 "members":{ 382 } 383 }, 384 "DeleteAppInput":{ 385 "type":"structure", 386 "required":[ 387 "App", 388 "Domain", 389 "Simulation" 390 ], 391 "members":{ 392 "App":{ 393 "shape":"SimSpaceWeaverResourceName", 394 "documentation":"<p>The name of the app.</p>", 395 "location":"querystring", 396 "locationName":"app" 397 }, 398 "Domain":{ 399 "shape":"SimSpaceWeaverResourceName", 400 "documentation":"<p>The name of the domain of the app.</p>", 401 "location":"querystring", 402 "locationName":"domain" 403 }, 404 "Simulation":{ 405 "shape":"SimSpaceWeaverResourceName", 406 "documentation":"<p>The name of the simulation of the app.</p>", 407 "location":"querystring", 408 "locationName":"simulation" 409 } 410 } 411 }, 412 "DeleteAppOutput":{ 413 "type":"structure", 414 "members":{ 415 } 416 }, 417 "DeleteSimulationInput":{ 418 "type":"structure", 419 "required":["Simulation"], 420 "members":{ 421 "Simulation":{ 422 "shape":"SimSpaceWeaverResourceName", 423 "documentation":"<p>The name of the simulation.</p>", 424 "location":"querystring", 425 "locationName":"simulation" 426 } 427 } 428 }, 429 "DeleteSimulationOutput":{ 430 "type":"structure", 431 "members":{ 432 } 433 }, 434 "DescribeAppInput":{ 435 "type":"structure", 436 "required":[ 437 "App", 438 "Domain", 439 "Simulation" 440 ], 441 "members":{ 442 "App":{ 443 "shape":"SimSpaceWeaverLongResourceName", 444 "documentation":"<p>The name of the app.</p>", 445 "location":"querystring", 446 "locationName":"app" 447 }, 448 "Domain":{ 449 "shape":"SimSpaceWeaverResourceName", 450 "documentation":"<p>The name of the domain of the app.</p>", 451 "location":"querystring", 452 "locationName":"domain" 453 }, 454 "Simulation":{ 455 "shape":"SimSpaceWeaverResourceName", 456 "documentation":"<p>The name of the simulation of the app.</p>", 457 "location":"querystring", 458 "locationName":"simulation" 459 } 460 } 461 }, 462 "DescribeAppOutput":{ 463 "type":"structure", 464 "members":{ 465 "Description":{ 466 "shape":"Description", 467 "documentation":"<p>The description of the app.</p>" 468 }, 469 "Domain":{ 470 "shape":"SimSpaceWeaverResourceName", 471 "documentation":"<p>The name of the domain of the app.</p>" 472 }, 473 "EndpointInfo":{ 474 "shape":"SimulationAppEndpointInfo", 475 "documentation":"<p>Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.</p>" 476 }, 477 "LaunchOverrides":{"shape":"LaunchOverrides"}, 478 "Name":{ 479 "shape":"SimSpaceWeaverLongResourceName", 480 "documentation":"<p>The name of the app.</p>" 481 }, 482 "Simulation":{ 483 "shape":"SimSpaceWeaverResourceName", 484 "documentation":"<p>The name of the simulation of the app.</p>" 485 }, 486 "Status":{ 487 "shape":"SimulationAppStatus", 488 "documentation":"<p>The current lifecycle state of the custom app.</p>" 489 }, 490 "TargetStatus":{ 491 "shape":"SimulationAppTargetStatus", 492 "documentation":"<p>The desired lifecycle state of the custom app.</p>" 493 } 494 } 495 }, 496 "DescribeSimulationInput":{ 497 "type":"structure", 498 "required":["Simulation"], 499 "members":{ 500 "Simulation":{ 501 "shape":"SimSpaceWeaverResourceName", 502 "documentation":"<p>The name of the simulation.</p>", 503 "location":"querystring", 504 "locationName":"simulation" 505 } 506 } 507 }, 508 "DescribeSimulationOutput":{ 509 "type":"structure", 510 "members":{ 511 "Arn":{ 512 "shape":"SimSpaceWeaverArn", 513 "documentation":"<p>The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>" 514 }, 515 "CreationTime":{ 516 "shape":"Timestamp", 517 "documentation":"<p>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).</p>" 518 }, 519 "Description":{ 520 "shape":"Description", 521 "documentation":"<p>The description of the simulation.</p>" 522 }, 523 "ExecutionId":{ 524 "shape":"UUID", 525 "documentation":"<p>A universally unique identifier (UUID) for this simulation.</p>" 526 }, 527 "LiveSimulationState":{ 528 "shape":"LiveSimulationState", 529 "documentation":"<p>A collection of additional state information, such as domain and clock configuration.</p>" 530 }, 531 "LoggingConfiguration":{ 532 "shape":"LoggingConfiguration", 533 "documentation":"<p>Settings that control how SimSpace Weaver handles your simulation log data.</p>" 534 }, 535 "MaximumDuration":{ 536 "shape":"TimeToLiveString", 537 "documentation":"<p>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 <code>14D</code>, or its equivalent in the other units. The default value is <code>14D</code>. A value equivalent to <code>0</code> makes the simulation immediately transition to <code>Stopping</code> as soon as it reaches <code>Started</code>.</p>" 538 }, 539 "Name":{ 540 "shape":"SimSpaceWeaverResourceName", 541 "documentation":"<p>The name of the simulation.</p>" 542 }, 543 "RoleArn":{ 544 "shape":"RoleArn", 545 "documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. For more information about IAM roles, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html\">IAM roles</a> in the <i>Identity and Access Management User Guide</i>.</p>" 546 }, 547 "SchemaError":{ 548 "shape":"OptionalString", 549 "documentation":"<p>An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.</p>", 550 "deprecated":true, 551 "deprecatedMessage":"SchemaError is no longer used, check StartError instead." 552 }, 553 "SchemaS3Location":{ 554 "shape":"S3Location", 555 "documentation":"<p>The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html\"> <i>Amazon Simple Storage Service User Guide</i> </a>.</p>" 556 }, 557 "SnapshotS3Location":{"shape":"S3Location"}, 558 "StartError":{ 559 "shape":"OptionalString", 560 "documentation":"<p>An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the <code>STARTING</code> state.</p>" 561 }, 562 "Status":{ 563 "shape":"SimulationStatus", 564 "documentation":"<p>The current lifecycle state of the simulation.</p>" 565 }, 566 "TargetStatus":{ 567 "shape":"SimulationTargetStatus", 568 "documentation":"<p>The desired lifecycle state of the simulation.</p>" 569 } 570 } 571 }, 572 "Description":{ 573 "type":"string", 574 "max":500, 575 "min":0 576 }, 577 "Domain":{ 578 "type":"structure", 579 "members":{ 580 "Lifecycle":{ 581 "shape":"LifecycleManagementStrategy", 582 "documentation":"<p>The type of lifecycle management for apps in the domain. Indicates whether apps in this domain are <i>managed</i> (SimSpace Weaver starts and stops the apps) or <i>unmanaged</i> (you must start and stop the apps).</p> <p class=\"title\"> <b>Lifecycle types</b> </p> <ul> <li> <p> <code>PerWorker</code> – Managed: SimSpace Weaver starts one app on each worker.</p> </li> <li> <p> <code>BySpatialSubdivision</code> – Managed: SimSpace Weaver starts one app for each spatial partition.</p> </li> <li> <p> <code>ByRequest</code> – Unmanaged: You use the <code>StartApp</code> API to start the apps and use the <code>StopApp</code> API to stop the apps.</p> </li> </ul>" 583 }, 584 "Name":{ 585 "shape":"SimSpaceWeaverResourceName", 586 "documentation":"<p>The name of the domain.</p>" 587 } 588 }, 589 "documentation":"<p>A collection of app instances that run the same executable app code and have the same launch options and commands.</p> <p>For more information about domains, see <a href=\"https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_domains\">Key concepts: Domains</a> in the <i>SimSpace Weaver User Guide</i>.</p>" 590 }, 591 "DomainList":{ 592 "type":"list", 593 "member":{"shape":"Domain"} 594 }, 595 "InternalServerException":{ 596 "type":"structure", 597 "members":{ 598 "Message":{"shape":"NonEmptyString"} 599 }, 600 "documentation":"<p/>", 601 "error":{"httpStatusCode":500}, 602 "exception":true, 603 "fault":true 604 }, 605 "LaunchCommandList":{ 606 "type":"list", 607 "member":{"shape":"NonEmptyString"} 608 }, 609 "LaunchOverrides":{ 610 "type":"structure", 611 "members":{ 612 "LaunchCommands":{ 613 "shape":"LaunchCommandList", 614 "documentation":"<p>App launch commands and command line parameters that override the launch command configured in the simulation schema.</p>" 615 } 616 }, 617 "documentation":"<p>Options that apply when the app starts. These options override default behavior.</p>" 618 }, 619 "LifecycleManagementStrategy":{ 620 "type":"string", 621 "enum":[ 622 "Unknown", 623 "PerWorker", 624 "BySpatialSubdivision", 625 "ByRequest" 626 ] 627 }, 628 "ListAppsInput":{ 629 "type":"structure", 630 "required":["Simulation"], 631 "members":{ 632 "Domain":{ 633 "shape":"SimSpaceWeaverResourceName", 634 "documentation":"<p>The name of the domain that you want to list apps for.</p>", 635 "location":"querystring", 636 "locationName":"domain" 637 }, 638 "MaxResults":{ 639 "shape":"PositiveInteger", 640 "documentation":"<p>The maximum number of apps to list.</p>", 641 "location":"querystring", 642 "locationName":"maxResults" 643 }, 644 "NextToken":{ 645 "shape":"OptionalString", 646 "documentation":"<p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> 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 <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</p>", 647 "location":"querystring", 648 "locationName":"nextToken" 649 }, 650 "Simulation":{ 651 "shape":"SimSpaceWeaverResourceName", 652 "documentation":"<p>The name of the simulation that you want to list apps for.</p>", 653 "location":"querystring", 654 "locationName":"simulation" 655 } 656 } 657 }, 658 "ListAppsOutput":{ 659 "type":"structure", 660 "members":{ 661 "Apps":{ 662 "shape":"SimulationAppList", 663 "documentation":"<p>The list of apps for the given simulation and domain.</p>" 664 }, 665 "NextToken":{ 666 "shape":"OptionalString", 667 "documentation":"<p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> 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 <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</p>" 668 } 669 } 670 }, 671 "ListSimulationsInput":{ 672 "type":"structure", 673 "members":{ 674 "MaxResults":{ 675 "shape":"PositiveInteger", 676 "documentation":"<p>The maximum number of simulations to list.</p>", 677 "location":"querystring", 678 "locationName":"maxResults" 679 }, 680 "NextToken":{ 681 "shape":"OptionalString", 682 "documentation":"<p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> 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 <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</p>", 683 "location":"querystring", 684 "locationName":"nextToken" 685 } 686 } 687 }, 688 "ListSimulationsOutput":{ 689 "type":"structure", 690 "members":{ 691 "NextToken":{ 692 "shape":"OptionalString", 693 "documentation":"<p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> 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 <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</p>" 694 }, 695 "Simulations":{ 696 "shape":"SimulationList", 697 "documentation":"<p>The list of simulations.</p>" 698 } 699 } 700 }, 701 "ListTagsForResourceInput":{ 702 "type":"structure", 703 "required":["ResourceArn"], 704 "members":{ 705 "ResourceArn":{ 706 "shape":"SimSpaceWeaverArn", 707 "documentation":"<p>The Amazon Resource Name (ARN) of the resource. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>", 708 "location":"uri", 709 "locationName":"ResourceArn" 710 } 711 } 712 }, 713 "ListTagsForResourceOutput":{ 714 "type":"structure", 715 "members":{ 716 "Tags":{ 717 "shape":"TagMap", 718 "documentation":"<p>The list of tags for the resource.</p>" 719 } 720 } 721 }, 722 "LiveSimulationState":{ 723 "type":"structure", 724 "members":{ 725 "Clocks":{ 726 "shape":"SimulationClockList", 727 "documentation":"<p>A list of simulation clocks.</p> <note> <p>At this time, a simulation has only one clock.</p> </note>" 728 }, 729 "Domains":{ 730 "shape":"DomainList", 731 "documentation":"<p>A list of domains for the simulation. For more information about domains, see <a href=\"https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_domains\">Key concepts: Domains</a> in the <i>SimSpace Weaver User Guide</i>.</p>" 732 } 733 }, 734 "documentation":"<p>A collection of additional state information, such as domain and clock configuration.</p>" 735 }, 736 "LogDestination":{ 737 "type":"structure", 738 "members":{ 739 "CloudWatchLogsLogGroup":{ 740 "shape":"CloudWatchLogsLogGroup", 741 "documentation":"<p>An Amazon CloudWatch Logs log group that stores simulation log data. For more information about log groups, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html\">Working with log groups and log streams</a> in the <i>Amazon CloudWatch Logs User Guide</i>.</p>" 742 } 743 }, 744 "documentation":"<p>The location where SimSpace Weaver sends simulation log data.</p>" 745 }, 746 "LogDestinations":{ 747 "type":"list", 748 "member":{"shape":"LogDestination"} 749 }, 750 "LogGroupArn":{ 751 "type":"string", 752 "max":1600, 753 "min":0, 754 "pattern":"^arn:(?:aws|aws-cn|aws-us-gov):log-group:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:role\\/(.+)$" 755 }, 756 "LoggingConfiguration":{ 757 "type":"structure", 758 "members":{ 759 "Destinations":{ 760 "shape":"LogDestinations", 761 "documentation":"<p>A list of the locations where SimSpace Weaver sends simulation log data.</p>" 762 } 763 }, 764 "documentation":"<p>The logging configuration for a simulation.</p>" 765 }, 766 "NonEmptyString":{ 767 "type":"string", 768 "max":1600, 769 "min":1 770 }, 771 "ObjectKey":{ 772 "type":"string", 773 "max":1024, 774 "min":1 775 }, 776 "ObjectKeyPrefix":{ 777 "type":"string", 778 "max":1024, 779 "min":0 780 }, 781 "OptionalString":{"type":"string"}, 782 "PortNumber":{ 783 "type":"integer", 784 "box":true, 785 "max":65535, 786 "min":0 787 }, 788 "PositiveInteger":{ 789 "type":"integer", 790 "box":true, 791 "min":1 792 }, 793 "ResourceNotFoundException":{ 794 "type":"structure", 795 "members":{ 796 "Message":{"shape":"NonEmptyString"} 797 }, 798 "documentation":"<p/>", 799 "error":{ 800 "httpStatusCode":404, 801 "senderFault":true 802 }, 803 "exception":true 804 }, 805 "RoleArn":{ 806 "type":"string", 807 "max":1600, 808 "min":0, 809 "pattern":"^arn:(?:aws|aws-cn|aws-us-gov):iam::(\\d{12})?:role\\/(.+)$" 810 }, 811 "S3Destination":{ 812 "type":"structure", 813 "required":["BucketName"], 814 "members":{ 815 "BucketName":{ 816 "shape":"BucketName", 817 "documentation":"<p>The name of an Amazon S3 bucket. For more information about buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html\">Creating, configuring, and working with Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>" 818 }, 819 "ObjectKeyPrefix":{ 820 "shape":"ObjectKeyPrefix", 821 "documentation":"<p>A string prefix for an Amazon S3 object key. It's usually a folder name. For more information about folders in Amazon S3, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-folders.html\">Organizing objects in the Amazon S3 console using folders</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>" 822 } 823 }, 824 "documentation":"<p>An Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates a file.</p>" 825 }, 826 "S3Location":{ 827 "type":"structure", 828 "required":[ 829 "BucketName", 830 "ObjectKey" 831 ], 832 "members":{ 833 "BucketName":{ 834 "shape":"BucketName", 835 "documentation":"<p>The name of an Amazon S3 bucket. For more information about buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html\">Creating, configuring, and working with Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>" 836 }, 837 "ObjectKey":{ 838 "shape":"ObjectKey", 839 "documentation":"<p>The key name of an object in Amazon S3. For more information about Amazon S3 objects and object keys, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/uploading-downloading-objects.html\">Uploading, downloading, and working with objects in Amazon S3</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>" 840 } 841 }, 842 "documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html\"> <i>Amazon Simple Storage Service User Guide</i> </a>.</p>" 843 }, 844 "ServiceQuotaExceededException":{ 845 "type":"structure", 846 "members":{ 847 "Message":{"shape":"NonEmptyString"} 848 }, 849 "documentation":"<p/>", 850 "error":{ 851 "httpStatusCode":402, 852 "senderFault":true 853 }, 854 "exception":true 855 }, 856 "SimSpaceWeaverArn":{ 857 "type":"string", 858 "max":1600, 859 "min":0, 860 "pattern":"^arn:(?:aws|aws-cn|aws-us-gov):simspaceweaver:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:([a-z]+)\\/(.+)$" 861 }, 862 "SimSpaceWeaverLongResourceName":{ 863 "type":"string", 864 "max":256, 865 "min":1, 866 "pattern":"^[a-zA-Z0-9_.-]+$" 867 }, 868 "SimSpaceWeaverResourceName":{ 869 "type":"string", 870 "max":64, 871 "min":1, 872 "pattern":"^[a-zA-Z0-9_.-]+$" 873 }, 874 "SimulationAppEndpointInfo":{ 875 "type":"structure", 876 "members":{ 877 "Address":{ 878 "shape":"NonEmptyString", 879 "documentation":"<p>The IP address of the app. SimSpace Weaver dynamically assigns this IP address when the app starts.</p>" 880 }, 881 "IngressPortMappings":{ 882 "shape":"AppPortMappings", 883 "documentation":"<p>The inbound TCP/UDP port numbers of the app. The combination of an IP address and a port number form a network endpoint.</p>" 884 } 885 }, 886 "documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_apps\">Key concepts: Apps</a> in the <i>SimSpace Weaver User Guide</i>..</p>" 887 }, 888 "SimulationAppList":{ 889 "type":"list", 890 "member":{"shape":"SimulationAppMetadata"} 891 }, 892 "SimulationAppMetadata":{ 893 "type":"structure", 894 "members":{ 895 "Domain":{ 896 "shape":"SimSpaceWeaverResourceName", 897 "documentation":"<p>The domain of the app. For more information about domains, see <a href=\"https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_domains\">Key concepts: Domains</a> in the <i>SimSpace Weaver User Guide</i>.</p>" 898 }, 899 "Name":{ 900 "shape":"SimSpaceWeaverLongResourceName", 901 "documentation":"<p>The name of the app.</p>" 902 }, 903 "Simulation":{ 904 "shape":"SimSpaceWeaverResourceName", 905 "documentation":"<p>The name of the simulation of the app.</p>" 906 }, 907 "Status":{ 908 "shape":"SimulationAppStatus", 909 "documentation":"<p>The current status of the app.</p>" 910 }, 911 "TargetStatus":{ 912 "shape":"SimulationAppTargetStatus", 913 "documentation":"<p>The desired status of the app.</p>" 914 } 915 }, 916 "documentation":"<p>A collection of metadata about the app.</p>" 917 }, 918 "SimulationAppPortMapping":{ 919 "type":"structure", 920 "members":{ 921 "Actual":{ 922 "shape":"PortNumber", 923 "documentation":"<p>The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port number when the app starts. SimSpace Weaver maps the <code>Declared</code> port to the <code>Actual</code> port. Clients connect to the app using the app's IP address and the <code>Actual</code> port number.</p>" 924 }, 925 "Declared":{ 926 "shape":"PortNumber", 927 "documentation":"<p>The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps the <code>Declared</code> port to the <code>Actual</code> port. The source code for the app should bind to the <code>Declared</code> port.</p>" 928 } 929 }, 930 "documentation":"<p>A collection of TCP/UDP ports for a custom or service app.</p>" 931 }, 932 "SimulationAppStatus":{ 933 "type":"string", 934 "enum":[ 935 "STARTING", 936 "STARTED", 937 "STOPPING", 938 "STOPPED", 939 "ERROR", 940 "UNKNOWN" 941 ] 942 }, 943 "SimulationAppTargetStatus":{ 944 "type":"string", 945 "enum":[ 946 "UNKNOWN", 947 "STARTED", 948 "STOPPED" 949 ] 950 }, 951 "SimulationClock":{ 952 "type":"structure", 953 "members":{ 954 "Status":{ 955 "shape":"ClockStatus", 956 "documentation":"<p>The current status of the simulation clock.</p>" 957 }, 958 "TargetStatus":{ 959 "shape":"ClockTargetStatus", 960 "documentation":"<p>The desired status of the simulation clock.</p>" 961 } 962 }, 963 "documentation":"<p>Status information about the simulation clock.</p>" 964 }, 965 "SimulationClockList":{ 966 "type":"list", 967 "member":{"shape":"SimulationClock"} 968 }, 969 "SimulationList":{ 970 "type":"list", 971 "member":{"shape":"SimulationMetadata"} 972 }, 973 "SimulationMetadata":{ 974 "type":"structure", 975 "members":{ 976 "Arn":{ 977 "shape":"SimSpaceWeaverArn", 978 "documentation":"<p>The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>" 979 }, 980 "CreationTime":{ 981 "shape":"Timestamp", 982 "documentation":"<p>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).</p>" 983 }, 984 "Name":{ 985 "shape":"SimSpaceWeaverResourceName", 986 "documentation":"<p>The name of the simulation.</p>" 987 }, 988 "Status":{ 989 "shape":"SimulationStatus", 990 "documentation":"<p>The current status of the simulation.</p>" 991 }, 992 "TargetStatus":{ 993 "shape":"SimulationTargetStatus", 994 "documentation":"<p>The desired status of the simulation.</p>" 995 } 996 }, 997 "documentation":"<p>A collection of data about the simulation.</p>" 998 }, 999 "SimulationStatus":{ 1000 "type":"string", 1001 "enum":[ 1002 "UNKNOWN", 1003 "STARTING", 1004 "STARTED", 1005 "STOPPING", 1006 "STOPPED", 1007 "FAILED", 1008 "DELETING", 1009 "DELETED", 1010 "SNAPSHOT_IN_PROGRESS" 1011 ] 1012 }, 1013 "SimulationTargetStatus":{ 1014 "type":"string", 1015 "enum":[ 1016 "UNKNOWN", 1017 "STARTED", 1018 "STOPPED", 1019 "DELETED" 1020 ] 1021 }, 1022 "StartAppInput":{ 1023 "type":"structure", 1024 "required":[ 1025 "Domain", 1026 "Name", 1027 "Simulation" 1028 ], 1029 "members":{ 1030 "ClientToken":{ 1031 "shape":"ClientToken", 1032 "documentation":"<p>A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A <code>ClientToken</code> is also known as an <i>idempotency token</i>. A <code>ClientToken</code> expires after 24 hours.</p>", 1033 "idempotencyToken":true 1034 }, 1035 "Description":{ 1036 "shape":"Description", 1037 "documentation":"<p>The description of the app.</p>" 1038 }, 1039 "Domain":{ 1040 "shape":"SimSpaceWeaverResourceName", 1041 "documentation":"<p>The name of the domain of the app.</p>" 1042 }, 1043 "LaunchOverrides":{"shape":"LaunchOverrides"}, 1044 "Name":{ 1045 "shape":"SimSpaceWeaverResourceName", 1046 "documentation":"<p>The name of the app.</p>" 1047 }, 1048 "Simulation":{ 1049 "shape":"SimSpaceWeaverResourceName", 1050 "documentation":"<p>The name of the simulation of the app.</p>" 1051 } 1052 } 1053 }, 1054 "StartAppOutput":{ 1055 "type":"structure", 1056 "members":{ 1057 "Domain":{ 1058 "shape":"SimSpaceWeaverResourceName", 1059 "documentation":"<p>The name of the domain of the app.</p>" 1060 }, 1061 "Name":{ 1062 "shape":"SimSpaceWeaverResourceName", 1063 "documentation":"<p>The name of the app.</p>" 1064 }, 1065 "Simulation":{ 1066 "shape":"SimSpaceWeaverResourceName", 1067 "documentation":"<p>The name of the simulation of the app.</p>" 1068 } 1069 } 1070 }, 1071 "StartClockInput":{ 1072 "type":"structure", 1073 "required":["Simulation"], 1074 "members":{ 1075 "Simulation":{ 1076 "shape":"SimSpaceWeaverResourceName", 1077 "documentation":"<p>The name of the simulation.</p>" 1078 } 1079 } 1080 }, 1081 "StartClockOutput":{ 1082 "type":"structure", 1083 "members":{ 1084 } 1085 }, 1086 "StartSimulationInput":{ 1087 "type":"structure", 1088 "required":[ 1089 "Name", 1090 "RoleArn" 1091 ], 1092 "members":{ 1093 "ClientToken":{ 1094 "shape":"ClientToken", 1095 "documentation":"<p>A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A <code>ClientToken</code> is also known as an <i>idempotency token</i>. A <code>ClientToken</code> expires after 24 hours.</p>", 1096 "idempotencyToken":true 1097 }, 1098 "Description":{ 1099 "shape":"Description", 1100 "documentation":"<p>The description of the simulation.</p>" 1101 }, 1102 "MaximumDuration":{ 1103 "shape":"TimeToLiveString", 1104 "documentation":"<p>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 <code>14D</code>, or its equivalent in the other units. The default value is <code>14D</code>. A value equivalent to <code>0</code> makes the simulation immediately transition to <code>Stopping</code> as soon as it reaches <code>Started</code>.</p>" 1105 }, 1106 "Name":{ 1107 "shape":"SimSpaceWeaverResourceName", 1108 "documentation":"<p>The name of the simulation.</p>" 1109 }, 1110 "RoleArn":{ 1111 "shape":"RoleArn", 1112 "documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. For more information about IAM roles, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html\">IAM roles</a> in the <i>Identity and Access Management User Guide</i>.</p>" 1113 }, 1114 "SchemaS3Location":{ 1115 "shape":"S3Location", 1116 "documentation":"<p>The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html\"> <i>Amazon Simple Storage Service User Guide</i> </a>.</p> <p>Provide a <code>SchemaS3Location</code> to start your simulation from a schema.</p> <p>If you provide a <code>SchemaS3Location</code> then you can't provide a <code>SnapshotS3Location</code>.</p>" 1117 }, 1118 "SnapshotS3Location":{ 1119 "shape":"S3Location", 1120 "documentation":"<p>The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html\"> <i>Amazon Simple Storage Service User Guide</i> </a>.</p> <p>Provide a <code>SnapshotS3Location</code> to start your simulation from a snapshot.</p> <p>The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.</p> <p>If you provide a <code>SnapshotS3Location</code> then you can't provide a <code>SchemaS3Location</code>.</p>" 1121 }, 1122 "Tags":{ 1123 "shape":"TagMap", 1124 "documentation":"<p>A list of tags for the simulation. For more information about tags, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</p>" 1125 } 1126 } 1127 }, 1128 "StartSimulationOutput":{ 1129 "type":"structure", 1130 "members":{ 1131 "Arn":{ 1132 "shape":"SimSpaceWeaverArn", 1133 "documentation":"<p>The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>" 1134 }, 1135 "CreationTime":{ 1136 "shape":"Timestamp", 1137 "documentation":"<p>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).</p>" 1138 }, 1139 "ExecutionId":{ 1140 "shape":"UUID", 1141 "documentation":"<p>A universally unique identifier (UUID) for this simulation.</p>" 1142 } 1143 } 1144 }, 1145 "StopAppInput":{ 1146 "type":"structure", 1147 "required":[ 1148 "App", 1149 "Domain", 1150 "Simulation" 1151 ], 1152 "members":{ 1153 "App":{ 1154 "shape":"SimSpaceWeaverResourceName", 1155 "documentation":"<p>The name of the app.</p>" 1156 }, 1157 "Domain":{ 1158 "shape":"SimSpaceWeaverResourceName", 1159 "documentation":"<p>The name of the domain of the app.</p>" 1160 }, 1161 "Simulation":{ 1162 "shape":"SimSpaceWeaverResourceName", 1163 "documentation":"<p>The name of the simulation of the app.</p>" 1164 } 1165 } 1166 }, 1167 "StopAppOutput":{ 1168 "type":"structure", 1169 "members":{ 1170 } 1171 }, 1172 "StopClockInput":{ 1173 "type":"structure", 1174 "required":["Simulation"], 1175 "members":{ 1176 "Simulation":{ 1177 "shape":"SimSpaceWeaverResourceName", 1178 "documentation":"<p>The name of the simulation.</p>" 1179 } 1180 } 1181 }, 1182 "StopClockOutput":{ 1183 "type":"structure", 1184 "members":{ 1185 } 1186 }, 1187 "StopSimulationInput":{ 1188 "type":"structure", 1189 "required":["Simulation"], 1190 "members":{ 1191 "Simulation":{ 1192 "shape":"SimSpaceWeaverResourceName", 1193 "documentation":"<p>The name of the simulation.</p>" 1194 } 1195 } 1196 }, 1197 "StopSimulationOutput":{ 1198 "type":"structure", 1199 "members":{ 1200 } 1201 }, 1202 "TagKey":{ 1203 "type":"string", 1204 "max":128, 1205 "min":1 1206 }, 1207 "TagKeyList":{ 1208 "type":"list", 1209 "member":{"shape":"TagKey"}, 1210 "max":50, 1211 "min":1 1212 }, 1213 "TagMap":{ 1214 "type":"map", 1215 "key":{"shape":"TagKey"}, 1216 "value":{"shape":"TagValue"}, 1217 "max":50, 1218 "min":1 1219 }, 1220 "TagResourceInput":{ 1221 "type":"structure", 1222 "required":[ 1223 "ResourceArn", 1224 "Tags" 1225 ], 1226 "members":{ 1227 "ResourceArn":{ 1228 "shape":"SimSpaceWeaverArn", 1229 "documentation":"<p>The Amazon Resource Name (ARN) of the resource that you want to add tags to. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>", 1230 "location":"uri", 1231 "locationName":"ResourceArn" 1232 }, 1233 "Tags":{ 1234 "shape":"TagMap", 1235 "documentation":"<p>A list of tags to apply to the resource.</p>" 1236 } 1237 } 1238 }, 1239 "TagResourceOutput":{ 1240 "type":"structure", 1241 "members":{ 1242 } 1243 }, 1244 "TagValue":{ 1245 "type":"string", 1246 "max":256, 1247 "min":0 1248 }, 1249 "TimeToLiveString":{ 1250 "type":"string", 1251 "max":6, 1252 "min":2, 1253 "pattern":"^\\d{1,5}[mhdMHD]$" 1254 }, 1255 "Timestamp":{"type":"timestamp"}, 1256 "TooManyTagsException":{ 1257 "type":"structure", 1258 "members":{ 1259 "Message":{"shape":"NonEmptyString"} 1260 }, 1261 "documentation":"<p/>", 1262 "error":{ 1263 "httpStatusCode":400, 1264 "senderFault":true 1265 }, 1266 "exception":true 1267 }, 1268 "UUID":{ 1269 "type":"string", 1270 "min":36, 1271 "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" 1272 }, 1273 "UntagResourceInput":{ 1274 "type":"structure", 1275 "required":[ 1276 "ResourceArn", 1277 "TagKeys" 1278 ], 1279 "members":{ 1280 "ResourceArn":{ 1281 "shape":"SimSpaceWeaverArn", 1282 "documentation":"<p>The Amazon Resource Name (ARN) of the resource that you want to remove tags from. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>", 1283 "location":"uri", 1284 "locationName":"ResourceArn" 1285 }, 1286 "TagKeys":{ 1287 "shape":"TagKeyList", 1288 "documentation":"<p>A list of tag keys to remove from the resource.</p>", 1289 "location":"querystring", 1290 "locationName":"tagKeys" 1291 } 1292 } 1293 }, 1294 "UntagResourceOutput":{ 1295 "type":"structure", 1296 "members":{ 1297 } 1298 }, 1299 "ValidationException":{ 1300 "type":"structure", 1301 "members":{ 1302 "Message":{"shape":"NonEmptyString"} 1303 }, 1304 "documentation":"<p/>", 1305 "error":{ 1306 "httpStatusCode":400, 1307 "senderFault":true 1308 }, 1309 "exception":true 1310 } 1311 }, 1312 "documentation":"<p>SimSpace Weaver (SimSpace Weaver) is a service that you can use to build and run large-scale spatial simulations in the Amazon Web Services Cloud. For example, you can create crowd simulations, large real-world environments, and immersive and interactive experiences. For more information about SimSpace Weaver, see the <i> <a href=\"https://docs.aws.amazon.com/simspaceweaver/latest/userguide/\">SimSpace Weaver User Guide</a> </i>.</p> <p>This API reference describes the API operations and data types that you can use to communicate directly with SimSpace Weaver.</p> <p>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.</p>" 1313} 1314