/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.simspaceweaver; import javax.annotation.Generated; import com.amazonaws.services.simspaceweaver.model.*; /** * Interface for accessing AWS SimSpace Weaver asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.simspaceweaver.AbstractAWSSimSpaceWeaverAsync} instead. *

*

*

* 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. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSSimSpaceWeaverAsync extends AWSSimSpaceWeaver { /** *

* 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: *

* * * @param createSnapshotRequest * @return A Java Future containing the result of the CreateSnapshot operation returned by the service. * @sample AWSSimSpaceWeaverAsync.CreateSnapshot * @see AWS * API Documentation */ java.util.concurrent.Future createSnapshotAsync(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: *

* * * @param createSnapshotRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateSnapshot operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.CreateSnapshot * @see AWS * API Documentation */ java.util.concurrent.Future createSnapshotAsync(CreateSnapshotRequest createSnapshotRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Deletes the instance of the given custom app. *

* * @param deleteAppRequest * @return A Java Future containing the result of the DeleteApp operation returned by the service. * @sample AWSSimSpaceWeaverAsync.DeleteApp * @see AWS API * Documentation */ java.util.concurrent.Future deleteAppAsync(DeleteAppRequest deleteAppRequest); /** *

* Deletes the instance of the given custom app. *

* * @param deleteAppRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteApp operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.DeleteApp * @see AWS API * Documentation */ java.util.concurrent.Future deleteAppAsync(DeleteAppRequest deleteAppRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * * @param deleteSimulationRequest * @return A Java Future containing the result of the DeleteSimulation operation returned by the service. * @sample AWSSimSpaceWeaverAsync.DeleteSimulation * @see AWS API Documentation */ java.util.concurrent.Future deleteSimulationAsync(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. *

* * * @param deleteSimulationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteSimulation operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.DeleteSimulation * @see AWS API Documentation */ java.util.concurrent.Future deleteSimulationAsync(DeleteSimulationRequest deleteSimulationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns the state of the given custom app. *

* * @param describeAppRequest * @return A Java Future containing the result of the DescribeApp operation returned by the service. * @sample AWSSimSpaceWeaverAsync.DescribeApp * @see AWS API * Documentation */ java.util.concurrent.Future describeAppAsync(DescribeAppRequest describeAppRequest); /** *

* Returns the state of the given custom app. *

* * @param describeAppRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeApp operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.DescribeApp * @see AWS API * Documentation */ java.util.concurrent.Future describeAppAsync(DescribeAppRequest describeAppRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns the current state of the given simulation. *

* * @param describeSimulationRequest * @return A Java Future containing the result of the DescribeSimulation operation returned by the service. * @sample AWSSimSpaceWeaverAsync.DescribeSimulation * @see AWS API Documentation */ java.util.concurrent.Future describeSimulationAsync(DescribeSimulationRequest describeSimulationRequest); /** *

* Returns the current state of the given simulation. *

* * @param describeSimulationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeSimulation operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.DescribeSimulation * @see AWS API Documentation */ java.util.concurrent.Future describeSimulationAsync(DescribeSimulationRequest describeSimulationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists all custom apps or service apps for the given simulation and domain. *

* * @param listAppsRequest * @return A Java Future containing the result of the ListApps operation returned by the service. * @sample AWSSimSpaceWeaverAsync.ListApps * @see AWS API * Documentation */ java.util.concurrent.Future listAppsAsync(ListAppsRequest listAppsRequest); /** *

* Lists all custom apps or service apps for the given simulation and domain. *

* * @param listAppsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListApps operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.ListApps * @see AWS API * Documentation */ java.util.concurrent.Future listAppsAsync(ListAppsRequest listAppsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call. *

* * @param listSimulationsRequest * @return A Java Future containing the result of the ListSimulations operation returned by the service. * @sample AWSSimSpaceWeaverAsync.ListSimulations * @see AWS * API Documentation */ java.util.concurrent.Future listSimulationsAsync(ListSimulationsRequest listSimulationsRequest); /** *

* Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call. *

* * @param listSimulationsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListSimulations operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.ListSimulations * @see AWS * API Documentation */ java.util.concurrent.Future listSimulationsAsync(ListSimulationsRequest listSimulationsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists all tags on a SimSpace Weaver resource. *

* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSSimSpaceWeaverAsync.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* Lists all tags on a SimSpace Weaver resource. *

* * @param listTagsForResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Starts a custom app with the configuration specified in the simulation schema. *

* * @param startAppRequest * @return A Java Future containing the result of the StartApp operation returned by the service. * @sample AWSSimSpaceWeaverAsync.StartApp * @see AWS API * Documentation */ java.util.concurrent.Future startAppAsync(StartAppRequest startAppRequest); /** *

* Starts a custom app with the configuration specified in the simulation schema. *

* * @param startAppRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StartApp operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.StartApp * @see AWS API * Documentation */ java.util.concurrent.Future startAppAsync(StartAppRequest startAppRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Starts the simulation clock. *

* * @param startClockRequest * @return A Java Future containing the result of the StartClock operation returned by the service. * @sample AWSSimSpaceWeaverAsync.StartClock * @see AWS API * Documentation */ java.util.concurrent.Future startClockAsync(StartClockRequest startClockRequest); /** *

* Starts the simulation clock. *

* * @param startClockRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StartClock operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.StartClock * @see AWS API * Documentation */ java.util.concurrent.Future startClockAsync(StartClockRequest startClockRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param startSimulationRequest * @return A Java Future containing the result of the StartSimulation operation returned by the service. * @sample AWSSimSpaceWeaverAsync.StartSimulation * @see AWS * API Documentation */ java.util.concurrent.Future startSimulationAsync(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. *

* * @param startSimulationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StartSimulation operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.StartSimulation * @see AWS * API Documentation */ java.util.concurrent.Future startSimulationAsync(StartSimulationRequest startSimulationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Stops the given custom app and shuts down all of its allocated compute resources. *

* * @param stopAppRequest * @return A Java Future containing the result of the StopApp operation returned by the service. * @sample AWSSimSpaceWeaverAsync.StopApp * @see AWS API * Documentation */ java.util.concurrent.Future stopAppAsync(StopAppRequest stopAppRequest); /** *

* Stops the given custom app and shuts down all of its allocated compute resources. *

* * @param stopAppRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StopApp operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.StopApp * @see AWS API * Documentation */ java.util.concurrent.Future stopAppAsync(StopAppRequest stopAppRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Stops the simulation clock. *

* * @param stopClockRequest * @return A Java Future containing the result of the StopClock operation returned by the service. * @sample AWSSimSpaceWeaverAsync.StopClock * @see AWS API * Documentation */ java.util.concurrent.Future stopClockAsync(StopClockRequest stopClockRequest); /** *

* Stops the simulation clock. *

* * @param stopClockRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StopClock operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.StopClock * @see AWS API * Documentation */ java.util.concurrent.Future stopClockAsync(StopClockRequest stopClockRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * * @param stopSimulationRequest * @return A Java Future containing the result of the StopSimulation operation returned by the service. * @sample AWSSimSpaceWeaverAsync.StopSimulation * @see AWS * API Documentation */ java.util.concurrent.Future stopSimulationAsync(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. *

* * * @param stopSimulationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StopSimulation operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.StopSimulation * @see AWS * API Documentation */ java.util.concurrent.Future stopSimulationAsync(StopSimulationRequest stopSimulationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSSimSpaceWeaverAsync.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future tagResourceAsync(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. *

* * @param tagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSSimSpaceWeaverAsync.UntagResource * @see AWS * API Documentation */ java.util.concurrent.Future untagResourceAsync(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. *

* * @param untagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSSimSpaceWeaverAsyncHandler.UntagResource * @see AWS * API Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }