com.amazonaws.services.simspaceweaver

Interface AWSSimSpaceWeaver

All Known Subinterfaces:

AWSSimSpaceWeaverAsync

All Known Implementing Classes:

AbstractAWSSimSpaceWeaver, AbstractAWSSimSpaceWeaverAsync, AWSSimSpaceWeaverAsyncClient, AWSSimSpaceWeaverClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSimSpaceWeaver

Interface for accessing AWS SimSpace Weaver.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSSimSpaceWeaver instead.

Amazon Web Services 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 massilvely-multiplayer games with hundreds of thousands of connected players. For more information about SimSpace Weaver, see the Amazon Web Services 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, which is part of the SimSpace Weaver app SDK distributable package.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
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 and schema.
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.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

deleteApp

DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest)

Deletes the instance of the given custom app.

Parameters:

deleteAppRequest -

Returns:

Result of the DeleteApp operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

AccessDeniedException

ValidationException

ConflictException

See Also:

AWS API Documentation

deleteSimulation

DeleteSimulationResult deleteSimulation(DeleteSimulationRequest deleteSimulationRequest)

Deletes all SimSpace Weaver resources assigned to the given simulation.

Your simulation uses resources in other Amazon Web Services services. This API operation doesn't delete resources in other Amazon Web Services services.

Parameters:

deleteSimulationRequest -

Returns:

Result of the DeleteSimulation operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

AccessDeniedException

ValidationException

ConflictException

See Also:

AWS API Documentation

describeApp

DescribeAppResult describeApp(DescribeAppRequest describeAppRequest)

Returns the state of the given custom app.

Parameters:

describeAppRequest -

Returns:

Result of the DescribeApp operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

AccessDeniedException

ValidationException

See Also:

AWS API Documentation

describeSimulation

DescribeSimulationResult describeSimulation(DescribeSimulationRequest describeSimulationRequest)

Returns the current state of the given simulation.

Parameters:

describeSimulationRequest -

Returns:

Result of the DescribeSimulation operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

AccessDeniedException

ValidationException

See Also:

AWS API Documentation

listApps

ListAppsResult listApps(ListAppsRequest listAppsRequest)

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

Parameters:

listAppsRequest -

Returns:

Result of the ListApps operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

AccessDeniedException

ValidationException

See Also:

AWS API Documentation

listSimulations

ListSimulationsResult listSimulations(ListSimulationsRequest listSimulationsRequest)

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

Parameters:

listSimulationsRequest -

Returns:

Result of the ListSimulations operation returned by the service.

Throws:

InternalServerException

AccessDeniedException

ValidationException

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all tags on a SimSpace Weaver resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException

ValidationException

See Also:

AWS API Documentation

startApp

StartAppResult startApp(StartAppRequest startAppRequest)

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

Parameters:

startAppRequest -

Returns:

Result of the StartApp operation returned by the service.

Throws:

InternalServerException

AccessDeniedException

ValidationException

ServiceQuotaExceededException

ConflictException

See Also:

AWS API Documentation

startClock

StartClockResult startClock(StartClockRequest startClockRequest)

Starts the simulation clock.

Parameters:

startClockRequest -

Returns:

Result of the StartClock operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

AccessDeniedException

ValidationException

ConflictException

See Also:

AWS API Documentation

startSimulation

StartSimulationResult startSimulation(StartSimulationRequest startSimulationRequest)

Starts a simulation with the given name and schema.

Parameters:

startSimulationRequest -

Returns:

Result of the StartSimulation operation returned by the service.

Throws:

InternalServerException

AccessDeniedException

ValidationException

ServiceQuotaExceededException

ConflictException

See Also:

AWS API Documentation

stopApp

StopAppResult stopApp(StopAppRequest stopAppRequest)

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

Parameters:

stopAppRequest -

Returns:

Result of the StopApp operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

AccessDeniedException

ValidationException

ConflictException

See Also:

AWS API Documentation

stopClock

StopClockResult stopClock(StopClockRequest stopClockRequest)

Stops the simulation clock.

Parameters:

stopClockRequest -

Returns:

Result of the StopClock operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

AccessDeniedException

ValidationException

ConflictException

See Also:

AWS API Documentation

stopSimulation

StopSimulationResult stopSimulation(StopSimulationRequest stopSimulationRequest)

Stops the given simulation.

You can't restart a simulation after you stop it. If you need to restart a simulation, you must stop it, delete it, and start a new instance of it.

Parameters:

stopSimulationRequest -

Returns:

Result of the StopSimulation operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

AccessDeniedException

ValidationException

ConflictException

See Also:

AWS API Documentation

tagResource

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

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

TooManyTagsException

ResourceNotFoundException

ValidationException

See Also:

AWS API Documentation

untagResource

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException

ValidationException

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.