simspaceweaver/aws.sdk.kotlin.services.simspaceweaver

Package-level declarations

Types

interface SimSpaceWeaverClient : SdkClient

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createSnapshot

inline suspend fun SimSpaceWeaverClient.createSnapshot(crossinline block: CreateSnapshotRequest.Builder.() -> Unit): CreateSnapshotResponse

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.

deleteApp

inline suspend fun SimSpaceWeaverClient.deleteApp(crossinline block: DeleteAppRequest.Builder.() -> Unit): DeleteAppResponse

Deletes the instance of the given custom app.

deleteSimulation

inline suspend fun SimSpaceWeaverClient.deleteSimulation(crossinline block: DeleteSimulationRequest.Builder.() -> Unit): DeleteSimulationResponse

Deletes all SimSpace Weaver resources assigned to the given simulation.

describeApp

inline suspend fun SimSpaceWeaverClient.describeApp(crossinline block: DescribeAppRequest.Builder.() -> Unit): DescribeAppResponse

Returns the state of the given custom app.

describeSimulation

inline suspend fun SimSpaceWeaverClient.describeSimulation(crossinline block: DescribeSimulationRequest.Builder.() -> Unit): DescribeSimulationResponse

Returns the current state of the given simulation.

listApps

inline suspend fun SimSpaceWeaverClient.listApps(crossinline block: ListAppsRequest.Builder.() -> Unit): ListAppsResponse

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

listSimulations

inline suspend fun SimSpaceWeaverClient.listSimulations(crossinline block: ListSimulationsRequest.Builder.() -> Unit): ListSimulationsResponse

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

listTagsForResource

inline suspend fun SimSpaceWeaverClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists all tags on a SimSpace Weaver resource.

startApp

inline suspend fun SimSpaceWeaverClient.startApp(crossinline block: StartAppRequest.Builder.() -> Unit): StartAppResponse

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

startClock

inline suspend fun SimSpaceWeaverClient.startClock(crossinline block: StartClockRequest.Builder.() -> Unit): StartClockResponse

Starts the simulation clock.

startSimulation

inline suspend fun SimSpaceWeaverClient.startSimulation(crossinline block: StartSimulationRequest.Builder.() -> Unit): StartSimulationResponse

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.

stopApp

inline suspend fun SimSpaceWeaverClient.stopApp(crossinline block: StopAppRequest.Builder.() -> Unit): StopAppResponse

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

stopClock

inline suspend fun SimSpaceWeaverClient.stopClock(crossinline block: StopClockRequest.Builder.() -> Unit): StopClockResponse

Stops the simulation clock.

stopSimulation

inline suspend fun SimSpaceWeaverClient.stopSimulation(crossinline block: StopSimulationRequest.Builder.() -> Unit): StopSimulationResponse

Stops the given simulation.

tagResource

inline suspend fun SimSpaceWeaverClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

untagResource

inline suspend fun SimSpaceWeaverClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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.

withConfig

fun SimSpaceWeaverClient.withConfig(block: SimSpaceWeaverClient.Config.Builder.() -> Unit): SimSpaceWeaverClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.