/* * Copyright 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. */ /* * Do not modify this file. This file is generated from the simspaceweaver-2022-10-28.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.SimSpaceWeaver.Model; namespace Amazon.SimSpaceWeaver { /// /// Interface for accessing SimSpaceWeaver /// /// 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. /// /// public partial interface IAmazonSimSpaceWeaver : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// ISimSpaceWeaverPaginatorFactory Paginators { get; } #endif #region CreateSnapshot /// /// 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: /// /// /// /// Container for the necessary parameters to execute the CreateSnapshot service method. /// /// The response from the CreateSnapshot service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for CreateSnapshot Operation CreateSnapshotResponse CreateSnapshot(CreateSnapshotRequest request); /// /// Initiates the asynchronous execution of the CreateSnapshot operation. /// /// /// Container for the necessary parameters to execute the CreateSnapshot operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateSnapshot /// operation. /// REST API Reference for CreateSnapshot Operation IAsyncResult BeginCreateSnapshot(CreateSnapshotRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateSnapshot operation. /// /// /// The IAsyncResult returned by the call to BeginCreateSnapshot. /// /// Returns a CreateSnapshotResult from SimSpaceWeaver. /// REST API Reference for CreateSnapshot Operation CreateSnapshotResponse EndCreateSnapshot(IAsyncResult asyncResult); #endregion #region DeleteApp /// /// Deletes the instance of the given custom app. /// /// Container for the necessary parameters to execute the DeleteApp service method. /// /// The response from the DeleteApp service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for DeleteApp Operation DeleteAppResponse DeleteApp(DeleteAppRequest request); /// /// Initiates the asynchronous execution of the DeleteApp operation. /// /// /// Container for the necessary parameters to execute the DeleteApp operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteApp /// operation. /// REST API Reference for DeleteApp Operation IAsyncResult BeginDeleteApp(DeleteAppRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteApp operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteApp. /// /// Returns a DeleteAppResult from SimSpaceWeaver. /// REST API Reference for DeleteApp Operation DeleteAppResponse EndDeleteApp(IAsyncResult asyncResult); #endregion #region DeleteSimulation /// /// 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. /// /// /// /// Container for the necessary parameters to execute the DeleteSimulation service method. /// /// The response from the DeleteSimulation service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for DeleteSimulation Operation DeleteSimulationResponse DeleteSimulation(DeleteSimulationRequest request); /// /// Initiates the asynchronous execution of the DeleteSimulation operation. /// /// /// Container for the necessary parameters to execute the DeleteSimulation operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSimulation /// operation. /// REST API Reference for DeleteSimulation Operation IAsyncResult BeginDeleteSimulation(DeleteSimulationRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteSimulation operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteSimulation. /// /// Returns a DeleteSimulationResult from SimSpaceWeaver. /// REST API Reference for DeleteSimulation Operation DeleteSimulationResponse EndDeleteSimulation(IAsyncResult asyncResult); #endregion #region DescribeApp /// /// Returns the state of the given custom app. /// /// Container for the necessary parameters to execute the DescribeApp service method. /// /// The response from the DescribeApp service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for DescribeApp Operation DescribeAppResponse DescribeApp(DescribeAppRequest request); /// /// Initiates the asynchronous execution of the DescribeApp operation. /// /// /// Container for the necessary parameters to execute the DescribeApp operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeApp /// operation. /// REST API Reference for DescribeApp Operation IAsyncResult BeginDescribeApp(DescribeAppRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeApp operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeApp. /// /// Returns a DescribeAppResult from SimSpaceWeaver. /// REST API Reference for DescribeApp Operation DescribeAppResponse EndDescribeApp(IAsyncResult asyncResult); #endregion #region DescribeSimulation /// /// Returns the current state of the given simulation. /// /// Container for the necessary parameters to execute the DescribeSimulation service method. /// /// The response from the DescribeSimulation service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for DescribeSimulation Operation DescribeSimulationResponse DescribeSimulation(DescribeSimulationRequest request); /// /// Initiates the asynchronous execution of the DescribeSimulation operation. /// /// /// Container for the necessary parameters to execute the DescribeSimulation operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSimulation /// operation. /// REST API Reference for DescribeSimulation Operation IAsyncResult BeginDescribeSimulation(DescribeSimulationRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeSimulation operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeSimulation. /// /// Returns a DescribeSimulationResult from SimSpaceWeaver. /// REST API Reference for DescribeSimulation Operation DescribeSimulationResponse EndDescribeSimulation(IAsyncResult asyncResult); #endregion #region ListApps /// /// Lists all custom apps or service apps for the given simulation and domain. /// /// Container for the necessary parameters to execute the ListApps service method. /// /// The response from the ListApps service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for ListApps Operation ListAppsResponse ListApps(ListAppsRequest request); /// /// Initiates the asynchronous execution of the ListApps operation. /// /// /// Container for the necessary parameters to execute the ListApps operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListApps /// operation. /// REST API Reference for ListApps Operation IAsyncResult BeginListApps(ListAppsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListApps operation. /// /// /// The IAsyncResult returned by the call to BeginListApps. /// /// Returns a ListAppsResult from SimSpaceWeaver. /// REST API Reference for ListApps Operation ListAppsResponse EndListApps(IAsyncResult asyncResult); #endregion #region ListSimulations /// /// Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make /// the API call. /// /// Container for the necessary parameters to execute the ListSimulations service method. /// /// The response from the ListSimulations service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// /// /// /// REST API Reference for ListSimulations Operation ListSimulationsResponse ListSimulations(ListSimulationsRequest request); /// /// Initiates the asynchronous execution of the ListSimulations operation. /// /// /// Container for the necessary parameters to execute the ListSimulations operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSimulations /// operation. /// REST API Reference for ListSimulations Operation IAsyncResult BeginListSimulations(ListSimulationsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListSimulations operation. /// /// /// The IAsyncResult returned by the call to BeginListSimulations. /// /// Returns a ListSimulationsResult from SimSpaceWeaver. /// REST API Reference for ListSimulations Operation ListSimulationsResponse EndListSimulations(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// /// Lists all tags on a SimSpace Weaver resource. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// /// Initiates the asynchronous execution of the ListTagsForResource operation. /// /// /// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource /// operation. /// REST API Reference for ListTagsForResource Operation IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListTagsForResource operation. /// /// /// The IAsyncResult returned by the call to BeginListTagsForResource. /// /// Returns a ListTagsForResourceResult from SimSpaceWeaver. /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region StartApp /// /// Starts a custom app with the configuration specified in the simulation schema. /// /// Container for the necessary parameters to execute the StartApp service method. /// /// The response from the StartApp service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for StartApp Operation StartAppResponse StartApp(StartAppRequest request); /// /// Initiates the asynchronous execution of the StartApp operation. /// /// /// Container for the necessary parameters to execute the StartApp operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartApp /// operation. /// REST API Reference for StartApp Operation IAsyncResult BeginStartApp(StartAppRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StartApp operation. /// /// /// The IAsyncResult returned by the call to BeginStartApp. /// /// Returns a StartAppResult from SimSpaceWeaver. /// REST API Reference for StartApp Operation StartAppResponse EndStartApp(IAsyncResult asyncResult); #endregion #region StartClock /// /// Starts the simulation clock. /// /// Container for the necessary parameters to execute the StartClock service method. /// /// The response from the StartClock service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for StartClock Operation StartClockResponse StartClock(StartClockRequest request); /// /// Initiates the asynchronous execution of the StartClock operation. /// /// /// Container for the necessary parameters to execute the StartClock operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartClock /// operation. /// REST API Reference for StartClock Operation IAsyncResult BeginStartClock(StartClockRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StartClock operation. /// /// /// The IAsyncResult returned by the call to BeginStartClock. /// /// Returns a StartClockResult from SimSpaceWeaver. /// REST API Reference for StartClock Operation StartClockResponse EndStartClock(IAsyncResult asyncResult); #endregion #region StartSimulation /// /// 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. /// /// Container for the necessary parameters to execute the StartSimulation service method. /// /// The response from the StartSimulation service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for StartSimulation Operation StartSimulationResponse StartSimulation(StartSimulationRequest request); /// /// Initiates the asynchronous execution of the StartSimulation operation. /// /// /// Container for the necessary parameters to execute the StartSimulation operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartSimulation /// operation. /// REST API Reference for StartSimulation Operation IAsyncResult BeginStartSimulation(StartSimulationRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StartSimulation operation. /// /// /// The IAsyncResult returned by the call to BeginStartSimulation. /// /// Returns a StartSimulationResult from SimSpaceWeaver. /// REST API Reference for StartSimulation Operation StartSimulationResponse EndStartSimulation(IAsyncResult asyncResult); #endregion #region StopApp /// /// Stops the given custom app and shuts down all of its allocated compute resources. /// /// Container for the necessary parameters to execute the StopApp service method. /// /// The response from the StopApp service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for StopApp Operation StopAppResponse StopApp(StopAppRequest request); /// /// Initiates the asynchronous execution of the StopApp operation. /// /// /// Container for the necessary parameters to execute the StopApp operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopApp /// operation. /// REST API Reference for StopApp Operation IAsyncResult BeginStopApp(StopAppRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StopApp operation. /// /// /// The IAsyncResult returned by the call to BeginStopApp. /// /// Returns a StopAppResult from SimSpaceWeaver. /// REST API Reference for StopApp Operation StopAppResponse EndStopApp(IAsyncResult asyncResult); #endregion #region StopClock /// /// Stops the simulation clock. /// /// Container for the necessary parameters to execute the StopClock service method. /// /// The response from the StopClock service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for StopClock Operation StopClockResponse StopClock(StopClockRequest request); /// /// Initiates the asynchronous execution of the StopClock operation. /// /// /// Container for the necessary parameters to execute the StopClock operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopClock /// operation. /// REST API Reference for StopClock Operation IAsyncResult BeginStopClock(StopClockRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StopClock operation. /// /// /// The IAsyncResult returned by the call to BeginStopClock. /// /// Returns a StopClockResult from SimSpaceWeaver. /// REST API Reference for StopClock Operation StopClockResponse EndStopClock(IAsyncResult asyncResult); #endregion #region StopSimulation /// /// 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. /// /// /// /// Container for the necessary parameters to execute the StopSimulation service method. /// /// The response from the StopSimulation service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for StopSimulation Operation StopSimulationResponse StopSimulation(StopSimulationRequest request); /// /// Initiates the asynchronous execution of the StopSimulation operation. /// /// /// Container for the necessary parameters to execute the StopSimulation operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopSimulation /// operation. /// REST API Reference for StopSimulation Operation IAsyncResult BeginStopSimulation(StopSimulationRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StopSimulation operation. /// /// /// The IAsyncResult returned by the call to BeginStopSimulation. /// /// Returns a StopSimulationResult from SimSpaceWeaver. /// REST API Reference for StopSimulation Operation StopSimulationResponse EndStopSimulation(IAsyncResult asyncResult); #endregion #region TagResource /// /// 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. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// /// /// /// REST API Reference for TagResource Operation TagResourceResponse TagResource(TagResourceRequest request); /// /// Initiates the asynchronous execution of the TagResource operation. /// /// /// Container for the necessary parameters to execute the TagResource operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource /// operation. /// REST API Reference for TagResource Operation IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TagResource operation. /// /// /// The IAsyncResult returned by the call to BeginTagResource. /// /// Returns a TagResourceResult from SimSpaceWeaver. /// REST API Reference for TagResource Operation TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region UntagResource /// /// 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. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by SimSpaceWeaver. /// /// /// /// /// /// /// REST API Reference for UntagResource Operation UntagResourceResponse UntagResource(UntagResourceRequest request); /// /// Initiates the asynchronous execution of the UntagResource operation. /// /// /// Container for the necessary parameters to execute the UntagResource operation on AmazonSimSpaceWeaverClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource /// operation. /// REST API Reference for UntagResource Operation IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UntagResource operation. /// /// /// The IAsyncResult returned by the call to BeginUntagResource. /// /// Returns a UntagResourceResult from SimSpaceWeaver. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion } }