AWSSimSpaceWeaverClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.simspaceweaver.AWSSimSpaceWeaverClient

All Implemented Interfaces:

AWSSimSpaceWeaver

Direct Known Subclasses:

AWSSimSpaceWeaverAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSSimSpaceWeaverClient
extends AmazonWebServiceClient
implements AWSSimSpaceWeaver
```
Client for accessing AWS SimSpace Weaver. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.simspaceweaver.AWSSimSpaceWeaver
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AWSSimSpaceWeaverClientBuilder`	`builder()`
`DeleteAppResult`	`deleteApp(DeleteAppRequest request)` Deletes the instance of the given custom app.
`DeleteSimulationResult`	`deleteSimulation(DeleteSimulationRequest request)` Deletes all SimSpace Weaver resources assigned to the given simulation.
`DescribeAppResult`	`describeApp(DescribeAppRequest request)` Returns the state of the given custom app.
`DescribeSimulationResult`	`describeSimulation(DescribeSimulationRequest request)` 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 request)` Lists all custom apps or service apps for the given simulation and domain.
`ListSimulationsResult`	`listSimulations(ListSimulationsRequest request)` Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` 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 request)` Starts a custom app with the configuration specified in the simulation schema.
`StartClockResult`	`startClock(StartClockRequest request)` Starts the simulation clock.
`StartSimulationResult`	`startSimulation(StartSimulationRequest request)` Starts a simulation with the given name and schema.
`StopAppResult`	`stopApp(StopAppRequest request)` Stops the given custom app and shuts down all of its allocated compute resources.
`StopClockResult`	`stopClock(StopClockRequest request)` Stops the simulation clock.
`StopSimulationResult`	`stopSimulation(StopSimulationRequest request)` Stops the given simulation.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds tags to a SimSpace Weaver resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes tags from a SimSpace Weaver resource.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AWSSimSpaceWeaverClientBuilder builder()
```
  - deleteApp
```
public DeleteAppResult deleteApp(DeleteAppRequest request)
```
    Deletes the instance of the given custom app.
    
    Specified by:
    
    deleteApp in interface AWSSimSpaceWeaver
    
    Parameters:
    
    deleteAppRequest -
    
    Returns:
    
    Result of the DeleteApp operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    ConflictException
    
    See Also:
    
    AWS API Documentation
  - deleteSimulation
```
public DeleteSimulationResult deleteSimulation(DeleteSimulationRequest request)
```
    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.
    
    Specified by:
    
    deleteSimulation in interface AWSSimSpaceWeaver
    
    Parameters:
    
    deleteSimulationRequest -
    
    Returns:
    
    Result of the DeleteSimulation operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    ConflictException
    
    See Also:
    
    AWS API Documentation
  - describeApp
```
public DescribeAppResult describeApp(DescribeAppRequest request)
```
    Returns the state of the given custom app.
    
    Specified by:
    
    describeApp in interface AWSSimSpaceWeaver
    
    Parameters:
    
    describeAppRequest -
    
    Returns:
    
    Result of the DescribeApp operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - describeSimulation
```
public DescribeSimulationResult describeSimulation(DescribeSimulationRequest request)
```
    Returns the current state of the given simulation.
    
    Specified by:
    
    describeSimulation in interface AWSSimSpaceWeaver
    
    Parameters:
    
    describeSimulationRequest -
    
    Returns:
    
    Result of the DescribeSimulation operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - listApps
```
public ListAppsResult listApps(ListAppsRequest request)
```
    Lists all custom apps or service apps for the given simulation and domain.
    
    Specified by:
    
    listApps in interface AWSSimSpaceWeaver
    
    Parameters:
    
    listAppsRequest -
    
    Returns:
    
    Result of the ListApps operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - listSimulations
```
public ListSimulationsResult listSimulations(ListSimulationsRequest request)
```
    Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.
    
    Specified by:
    
    listSimulations in interface AWSSimSpaceWeaver
    
    Parameters:
    
    listSimulationsRequest -
    
    Returns:
    
    Result of the ListSimulations operation returned by the service.
    
    Throws:
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Lists all tags on a SimSpace Weaver resource.
    
    Specified by:
    
    listTagsForResource in interface AWSSimSpaceWeaver
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - startApp
```
public StartAppResult startApp(StartAppRequest request)
```
    Starts a custom app with the configuration specified in the simulation schema.
    
    Specified by:
    
    startApp in interface AWSSimSpaceWeaver
    
    Parameters:
    
    startAppRequest -
    
    Returns:
    
    Result of the StartApp operation returned by the service.
    
    Throws:
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    ServiceQuotaExceededException
    
    ConflictException
    
    See Also:
    
    AWS API Documentation
  - startClock
```
public StartClockResult startClock(StartClockRequest request)
```
    Starts the simulation clock.
    
    Specified by:
    
    startClock in interface AWSSimSpaceWeaver
    
    Parameters:
    
    startClockRequest -
    
    Returns:
    
    Result of the StartClock operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    ConflictException
    
    See Also:
    
    AWS API Documentation
  - startSimulation
```
public StartSimulationResult startSimulation(StartSimulationRequest request)
```
    Starts a simulation with the given name and schema.
    
    Specified by:
    
    startSimulation in interface AWSSimSpaceWeaver
    
    Parameters:
    
    startSimulationRequest -
    
    Returns:
    
    Result of the StartSimulation operation returned by the service.
    
    Throws:
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    ServiceQuotaExceededException
    
    ConflictException
    
    See Also:
    
    AWS API Documentation
  - stopApp
```
public StopAppResult stopApp(StopAppRequest request)
```
    Stops the given custom app and shuts down all of its allocated compute resources.
    
    Specified by:
    
    stopApp in interface AWSSimSpaceWeaver
    
    Parameters:
    
    stopAppRequest -
    
    Returns:
    
    Result of the StopApp operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    ConflictException
    
    See Also:
    
    AWS API Documentation
  - stopClock
```
public StopClockResult stopClock(StopClockRequest request)
```
    Stops the simulation clock.
    
    Specified by:
    
    stopClock in interface AWSSimSpaceWeaver
    
    Parameters:
    
    stopClockRequest -
    
    Returns:
    
    Result of the StopClock operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    ConflictException
    
    See Also:
    
    AWS API Documentation
  - stopSimulation
```
public StopSimulationResult stopSimulation(StopSimulationRequest request)
```
    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.
    
    Specified by:
    
    stopSimulation in interface AWSSimSpaceWeaver
    
    Parameters:
    
    stopSimulationRequest -
    
    Returns:
    
    Result of the StopSimulation operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    ConflictException
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    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.
    
    Specified by:
    
    tagResource in interface AWSSimSpaceWeaver
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    TooManyTagsException
    
    ResourceNotFoundException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    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.
    
    Specified by:
    
    untagResource in interface AWSSimSpaceWeaver
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSSimSpaceWeaver
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSSimSpaceWeaver
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AWSSimSpaceWeaverClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.simspaceweaver.AWSSimSpaceWeaver

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

deleteApp

deleteSimulation

describeApp

describeSimulation

listApps

listSimulations

listTagsForResource

startApp

startClock

startSimulation

stopApp

stopClock

stopSimulation

tagResource

untagResource

getCachedResponseMetadata

shutdown