@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSSimSpaceWeaver
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSSimSpaceWeaver instead.
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 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateSnapshotResult |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of the specified simulation.
|
DeleteAppResult |
deleteApp(DeleteAppRequest deleteAppRequest)
Deletes the instance of the given custom app.
|
DeleteSimulationResult |
deleteSimulation(DeleteSimulationRequest deleteSimulationRequest)
Deletes all SimSpace Weaver resources assigned to the given simulation.
|
DescribeAppResult |
describeApp(DescribeAppRequest describeAppRequest)
Returns the state of the given custom app.
|
DescribeSimulationResult |
describeSimulation(DescribeSimulationRequest describeSimulationRequest)
Returns the current state of the given simulation.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListAppsResult |
listApps(ListAppsRequest listAppsRequest)
Lists all custom apps or service apps for the given simulation and domain.
|
ListSimulationsResult |
listSimulations(ListSimulationsRequest listSimulationsRequest)
Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on a SimSpace Weaver resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartAppResult |
startApp(StartAppRequest startAppRequest)
Starts a custom app with the configuration specified in the simulation schema.
|
StartClockResult |
startClock(StartClockRequest startClockRequest)
Starts the simulation clock.
|
StartSimulationResult |
startSimulation(StartSimulationRequest startSimulationRequest)
Starts a simulation with the given name.
|
StopAppResult |
stopApp(StopAppRequest stopAppRequest)
Stops the given custom app and shuts down all of its allocated compute resources.
|
StopClockResult |
stopClock(StopClockRequest stopClockRequest)
Stops the simulation clock.
|
StopSimulationResult |
stopSimulation(StopSimulationRequest stopSimulationRequest)
Stops the given simulation.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds tags to a SimSpace Weaver resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a SimSpace Weaver resource.
|
static final String ENDPOINT_PREFIX
CreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest)
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
createSnapshotRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionDeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest)
Deletes the instance of the given custom app.
deleteAppRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionDeleteSimulationResult deleteSimulation(DeleteSimulationRequest deleteSimulationRequest)
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.
deleteSimulationRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionDescribeAppResult describeApp(DescribeAppRequest describeAppRequest)
Returns the state of the given custom app.
describeAppRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionDescribeSimulationResult describeSimulation(DescribeSimulationRequest describeSimulationRequest)
Returns the current state of the given simulation.
describeSimulationRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionListAppsResult listApps(ListAppsRequest listAppsRequest)
Lists all custom apps or service apps for the given simulation and domain.
listAppsRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionListSimulationsResult listSimulations(ListSimulationsRequest listSimulationsRequest)
Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.
listSimulationsRequest - InternalServerExceptionAccessDeniedExceptionValidationExceptionListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on a SimSpace Weaver resource.
listTagsForResourceRequest - ResourceNotFoundExceptionValidationExceptionStartAppResult startApp(StartAppRequest startAppRequest)
Starts a custom app with the configuration specified in the simulation schema.
startAppRequest - InternalServerExceptionAccessDeniedExceptionValidationExceptionServiceQuotaExceededExceptionConflictExceptionStartClockResult startClock(StartClockRequest startClockRequest)
Starts the simulation clock.
startClockRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionStartSimulationResult startSimulation(StartSimulationRequest startSimulationRequest)
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.
startSimulationRequest - InternalServerExceptionAccessDeniedExceptionValidationExceptionServiceQuotaExceededExceptionConflictExceptionStopAppResult stopApp(StopAppRequest stopAppRequest)
Stops the given custom app and shuts down all of its allocated compute resources.
stopAppRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionStopClockResult stopClock(StopClockRequest stopClockRequest)
Stops the simulation clock.
stopClockRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionStopSimulationResult stopSimulation(StopSimulationRequest stopSimulationRequest)
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.
stopSimulationRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionTagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest - TooManyTagsExceptionResourceNotFoundExceptionValidationExceptionUntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
untagResourceRequest - ResourceNotFoundExceptionValidationExceptionvoid shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.