Interface SimSpaceWeaverClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface SimSpaceWeaverClient
extends AwsClient

Service client for accessing AWS SimSpace Weaver. This can be created using the static builder() method.

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 .

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static SimSpaceWeaverClientBuilder	builder()	Create a builder that can be used to configure and create a SimSpaceWeaverClient.
static SimSpaceWeaverClient	create()	Create a SimSpaceWeaverClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateSnapshotResponse	createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)	Creates a snapshot of the specified simulation.
default CreateSnapshotResponse	createSnapshot(CreateSnapshotRequest createSnapshotRequest)	Creates a snapshot of the specified simulation.
default DeleteAppResponse	deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest)	Deletes the instance of the given custom app.
default DeleteAppResponse	deleteApp(DeleteAppRequest deleteAppRequest)	Deletes the instance of the given custom app.
default DeleteSimulationResponse	deleteSimulation(Consumer<DeleteSimulationRequest.Builder> deleteSimulationRequest)	Deletes all SimSpace Weaver resources assigned to the given simulation.
default DeleteSimulationResponse	deleteSimulation(DeleteSimulationRequest deleteSimulationRequest)	Deletes all SimSpace Weaver resources assigned to the given simulation.
default DescribeAppResponse	describeApp(Consumer<DescribeAppRequest.Builder> describeAppRequest)	Returns the state of the given custom app.
default DescribeAppResponse	describeApp(DescribeAppRequest describeAppRequest)	Returns the state of the given custom app.
default DescribeSimulationResponse	describeSimulation(Consumer<DescribeSimulationRequest.Builder> describeSimulationRequest)	Returns the current state of the given simulation.
default DescribeSimulationResponse	describeSimulation(DescribeSimulationRequest describeSimulationRequest)	Returns the current state of the given simulation.
default ListAppsResponse	listApps(Consumer<ListAppsRequest.Builder> listAppsRequest)	Lists all custom apps or service apps for the given simulation and domain.
default ListAppsResponse	listApps(ListAppsRequest listAppsRequest)	Lists all custom apps or service apps for the given simulation and domain.
default ListAppsIterable	listAppsPaginator(Consumer<ListAppsRequest.Builder> listAppsRequest)	This is a variant of listApps(software.amazon.awssdk.services.simspaceweaver.model.ListAppsRequest) operation.
default ListAppsIterable	listAppsPaginator(ListAppsRequest listAppsRequest)	This is a variant of listApps(software.amazon.awssdk.services.simspaceweaver.model.ListAppsRequest) operation.
default ListSimulationsResponse	listSimulations(Consumer<ListSimulationsRequest.Builder> listSimulationsRequest)	Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.
default ListSimulationsResponse	listSimulations(ListSimulationsRequest listSimulationsRequest)	Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.
default ListSimulationsIterable	listSimulationsPaginator(Consumer<ListSimulationsRequest.Builder> listSimulationsRequest)	This is a variant of listSimulations(software.amazon.awssdk.services.simspaceweaver.model.ListSimulationsRequest) operation.
default ListSimulationsIterable	listSimulationsPaginator(ListSimulationsRequest listSimulationsRequest)	This is a variant of listSimulations(software.amazon.awssdk.services.simspaceweaver.model.ListSimulationsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all tags on a SimSpace Weaver resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all tags on a SimSpace Weaver resource.
default SimSpaceWeaverServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartAppResponse	startApp(Consumer<StartAppRequest.Builder> startAppRequest)	Starts a custom app with the configuration specified in the simulation schema.
default StartAppResponse	startApp(StartAppRequest startAppRequest)	Starts a custom app with the configuration specified in the simulation schema.
default StartClockResponse	startClock(Consumer<StartClockRequest.Builder> startClockRequest)	Starts the simulation clock.
default StartClockResponse	startClock(StartClockRequest startClockRequest)	Starts the simulation clock.
default StartSimulationResponse	startSimulation(Consumer<StartSimulationRequest.Builder> startSimulationRequest)	Starts a simulation with the given name.
default StartSimulationResponse	startSimulation(StartSimulationRequest startSimulationRequest)	Starts a simulation with the given name.
default StopAppResponse	stopApp(Consumer<StopAppRequest.Builder> stopAppRequest)	Stops the given custom app and shuts down all of its allocated compute resources.
default StopAppResponse	stopApp(StopAppRequest stopAppRequest)	Stops the given custom app and shuts down all of its allocated compute resources.
default StopClockResponse	stopClock(Consumer<StopClockRequest.Builder> stopClockRequest)	Stops the simulation clock.
default StopClockResponse	stopClock(StopClockRequest stopClockRequest)	Stops the simulation clock.
default StopSimulationResponse	stopSimulation(Consumer<StopSimulationRequest.Builder> stopSimulationRequest)	Stops the given simulation.
default StopSimulationResponse	stopSimulation(StopSimulationRequest stopSimulationRequest)	Stops the given simulation.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds tags to a SimSpace Weaver resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds tags to a SimSpace Weaver resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes tags from a SimSpace Weaver resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes tags from a SimSpace Weaver resource.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createSnapshot

default CreateSnapshotResponse createSnapshot(CreateSnapshotRequest createSnapshotRequest)
                                       throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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:

• YY is the 2-digit year

• MM is the 2-digit month

• dd is the 2-digit day of the month

• HH is the 2-digit hour (24-hour clock)

• mm is the 2-digit minutes

• ss is the 2-digit seconds

Parameters:

createSnapshotRequest -

Returns:

Result of the CreateSnapshot operation returned by the service.

See Also:

• AWS API Documentation

createSnapshot

default CreateSnapshotResponse createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)
                                       throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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:

• YY is the 2-digit year

• MM is the 2-digit month

• dd is the 2-digit day of the month

• HH is the 2-digit hour (24-hour clock)

• mm is the 2-digit minutes

• ss is the 2-digit seconds

This is a convenience which creates an instance of the CreateSnapshotRequest.Builder avoiding the need to create one manually via CreateSnapshotRequest.builder()

Parameters:

createSnapshotRequest - A Consumer that will call methods on CreateSnapshotRequest.Builder to create a request.

Returns:

Result of the CreateSnapshot operation returned by the service.

See Also:

• AWS API Documentation

deleteApp

default DeleteAppResponse deleteApp(DeleteAppRequest deleteAppRequest)
                             throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

Deletes the instance of the given custom app.

Parameters:

deleteAppRequest -

Returns:

Result of the DeleteApp operation returned by the service.

See Also:

• AWS API Documentation

deleteApp

default DeleteAppResponse deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest)
                             throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

Deletes the instance of the given custom app.

This is a convenience which creates an instance of the DeleteAppRequest.Builder avoiding the need to create one manually via DeleteAppRequest.builder()

Parameters:

deleteAppRequest - A Consumer that will call methods on DeleteAppRequest.Builder to create a request.

Returns:

Result of the DeleteApp operation returned by the service.

See Also:

• AWS API Documentation

deleteSimulation

default DeleteSimulationResponse deleteSimulation(DeleteSimulationRequest deleteSimulationRequest)
                                           throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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.

Parameters:

deleteSimulationRequest -

Returns:

Result of the DeleteSimulation operation returned by the service.

See Also:

• AWS API Documentation

deleteSimulation

default DeleteSimulationResponse deleteSimulation(Consumer<DeleteSimulationRequest.Builder> deleteSimulationRequest)
                                           throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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.

This is a convenience which creates an instance of the DeleteSimulationRequest.Builder avoiding the need to create one manually via DeleteSimulationRequest.builder()

Parameters:

deleteSimulationRequest - A Consumer that will call methods on DeleteSimulationRequest.Builder to create a request.

Returns:

Result of the DeleteSimulation operation returned by the service.

See Also:

• AWS API Documentation

describeApp

default DescribeAppResponse describeApp(DescribeAppRequest describeAppRequest)
                                 throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

Returns the state of the given custom app.

Parameters:

describeAppRequest -

Returns:

Result of the DescribeApp operation returned by the service.

See Also:

• AWS API Documentation

describeApp

default DescribeAppResponse describeApp(Consumer<DescribeAppRequest.Builder> describeAppRequest)
                                 throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

Returns the state of the given custom app.

This is a convenience which creates an instance of the DescribeAppRequest.Builder avoiding the need to create one manually via DescribeAppRequest.builder()

Parameters:

describeAppRequest - A Consumer that will call methods on DescribeAppRequest.Builder to create a request.

Returns:

Result of the DescribeApp operation returned by the service.

See Also:

• AWS API Documentation

describeSimulation

default DescribeSimulationResponse describeSimulation(DescribeSimulationRequest describeSimulationRequest)
                                               throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

Returns the current state of the given simulation.

Parameters:

describeSimulationRequest -

Returns:

Result of the DescribeSimulation operation returned by the service.

See Also:

• AWS API Documentation

describeSimulation

default DescribeSimulationResponse describeSimulation(Consumer<DescribeSimulationRequest.Builder> describeSimulationRequest)
                                               throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

Returns the current state of the given simulation.

This is a convenience which creates an instance of the DescribeSimulationRequest.Builder avoiding the need to create one manually via DescribeSimulationRequest.builder()

Parameters:

describeSimulationRequest - A Consumer that will call methods on DescribeSimulationRequest.Builder to create a request.

Returns:

Result of the DescribeSimulation operation returned by the service.

See Also:

• AWS API Documentation

listApps

default ListAppsResponse listApps(ListAppsRequest listAppsRequest)
                           throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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.

See Also:

• AWS API Documentation

listApps

default ListAppsResponse listApps(Consumer<ListAppsRequest.Builder> listAppsRequest)
                           throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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

This is a convenience which creates an instance of the ListAppsRequest.Builder avoiding the need to create one manually via ListAppsRequest.builder()

Parameters:

listAppsRequest - A Consumer that will call methods on ListAppsRequest.Builder to create a request.

Returns:

Result of the ListApps operation returned by the service.

See Also:

• AWS API Documentation

listAppsPaginator

default ListAppsIterable listAppsPaginator(ListAppsRequest listAppsRequest)
                                    throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

This is a variant of listApps(software.amazon.awssdk.services.simspaceweaver.model.ListAppsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.simspaceweaver.paginators.ListAppsIterable responses = client.listAppsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.simspaceweaver.paginators.ListAppsIterable responses = client.listAppsPaginator(request);
     for (software.amazon.awssdk.services.simspaceweaver.model.ListAppsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.simspaceweaver.paginators.ListAppsIterable responses = client.listAppsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listApps(software.amazon.awssdk.services.simspaceweaver.model.ListAppsRequest) operation.

Parameters:

listAppsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAppsPaginator

default ListAppsIterable listAppsPaginator(Consumer<ListAppsRequest.Builder> listAppsRequest)
                                    throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

This is a variant of listApps(software.amazon.awssdk.services.simspaceweaver.model.ListAppsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.simspaceweaver.paginators.ListAppsIterable responses = client.listAppsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.simspaceweaver.paginators.ListAppsIterable responses = client.listAppsPaginator(request);
     for (software.amazon.awssdk.services.simspaceweaver.model.ListAppsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.simspaceweaver.paginators.ListAppsIterable responses = client.listAppsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listApps(software.amazon.awssdk.services.simspaceweaver.model.ListAppsRequest) operation.

This is a convenience which creates an instance of the ListAppsRequest.Builder avoiding the need to create one manually via ListAppsRequest.builder()

Parameters:

listAppsRequest - A Consumer that will call methods on ListAppsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSimulations

default ListSimulationsResponse listSimulations(ListSimulationsRequest listSimulationsRequest)
                                         throws InternalServerException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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.

See Also:

• AWS API Documentation

listSimulations

default ListSimulationsResponse listSimulations(Consumer<ListSimulationsRequest.Builder> listSimulationsRequest)
                                         throws InternalServerException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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

This is a convenience which creates an instance of the ListSimulationsRequest.Builder avoiding the need to create one manually via ListSimulationsRequest.builder()

Parameters:

listSimulationsRequest - A Consumer that will call methods on ListSimulationsRequest.Builder to create a request.

Returns:

Result of the ListSimulations operation returned by the service.

See Also:

• AWS API Documentation

listSimulationsPaginator

default ListSimulationsIterable listSimulationsPaginator(ListSimulationsRequest listSimulationsRequest)
                                                  throws InternalServerException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

This is a variant of listSimulations(software.amazon.awssdk.services.simspaceweaver.model.ListSimulationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.simspaceweaver.paginators.ListSimulationsIterable responses = client.listSimulationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.simspaceweaver.paginators.ListSimulationsIterable responses = client
             .listSimulationsPaginator(request);
     for (software.amazon.awssdk.services.simspaceweaver.model.ListSimulationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.simspaceweaver.paginators.ListSimulationsIterable responses = client.listSimulationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSimulations(software.amazon.awssdk.services.simspaceweaver.model.ListSimulationsRequest) operation.

Parameters:

listSimulationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSimulationsPaginator

default ListSimulationsIterable listSimulationsPaginator(Consumer<ListSimulationsRequest.Builder> listSimulationsRequest)
                                                  throws InternalServerException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

This is a variant of listSimulations(software.amazon.awssdk.services.simspaceweaver.model.ListSimulationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.simspaceweaver.paginators.ListSimulationsIterable responses = client.listSimulationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.simspaceweaver.paginators.ListSimulationsIterable responses = client
             .listSimulationsPaginator(request);
     for (software.amazon.awssdk.services.simspaceweaver.model.ListSimulationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.simspaceweaver.paginators.ListSimulationsIterable responses = client.listSimulationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSimulations(software.amazon.awssdk.services.simspaceweaver.model.ListSimulationsRequest) operation.

This is a convenience which creates an instance of the ListSimulationsRequest.Builder avoiding the need to create one manually via ListSimulationsRequest.builder()

Parameters:

listSimulationsRequest - A Consumer that will call methods on ListSimulationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

Lists all tags on a SimSpace Weaver resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

Lists all tags on a SimSpace Weaver resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

startApp

default StartAppResponse startApp(StartAppRequest startAppRequest)
                           throws InternalServerException,
AccessDeniedException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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

Parameters:

startAppRequest -

Returns:

Result of the StartApp operation returned by the service.

See Also:

• AWS API Documentation

startApp

default StartAppResponse startApp(Consumer<StartAppRequest.Builder> startAppRequest)
                           throws InternalServerException,
AccessDeniedException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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

This is a convenience which creates an instance of the StartAppRequest.Builder avoiding the need to create one manually via StartAppRequest.builder()

Parameters:

startAppRequest - A Consumer that will call methods on StartAppRequest.Builder to create a request.

Returns:

Result of the StartApp operation returned by the service.

See Also:

• AWS API Documentation

startClock

default StartClockResponse startClock(StartClockRequest startClockRequest)
                               throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

Starts the simulation clock.

Parameters:

startClockRequest -

Returns:

Result of the StartClock operation returned by the service.

See Also:

• AWS API Documentation

startClock

default StartClockResponse startClock(Consumer<StartClockRequest.Builder> startClockRequest)
                               throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

Starts the simulation clock.

This is a convenience which creates an instance of the StartClockRequest.Builder avoiding the need to create one manually via StartClockRequest.builder()

Parameters:

startClockRequest - A Consumer that will call methods on StartClockRequest.Builder to create a request.

Returns:

Result of the StartClock operation returned by the service.

See Also:

• AWS API Documentation

startSimulation

default StartSimulationResponse startSimulation(StartSimulationRequest startSimulationRequest)
                                         throws InternalServerException,
AccessDeniedException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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.

Parameters:

startSimulationRequest -

Returns:

Result of the StartSimulation operation returned by the service.

See Also:

• AWS API Documentation

startSimulation

default StartSimulationResponse startSimulation(Consumer<StartSimulationRequest.Builder> startSimulationRequest)
                                         throws InternalServerException,
AccessDeniedException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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.

This is a convenience which creates an instance of the StartSimulationRequest.Builder avoiding the need to create one manually via StartSimulationRequest.builder()

Parameters:

startSimulationRequest - A Consumer that will call methods on StartSimulationRequest.Builder to create a request.

Returns:

Result of the StartSimulation operation returned by the service.

See Also:

• AWS API Documentation

stopApp

default StopAppResponse stopApp(StopAppRequest stopAppRequest)
                         throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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.

See Also:

• AWS API Documentation

stopApp

default StopAppResponse stopApp(Consumer<StopAppRequest.Builder> stopAppRequest)
                         throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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

This is a convenience which creates an instance of the StopAppRequest.Builder avoiding the need to create one manually via StopAppRequest.builder()

Parameters:

stopAppRequest - A Consumer that will call methods on StopAppRequest.Builder to create a request.

Returns:

Result of the StopApp operation returned by the service.

See Also:

• AWS API Documentation

stopClock

default StopClockResponse stopClock(StopClockRequest stopClockRequest)
                             throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

Stops the simulation clock.

Parameters:

stopClockRequest -

Returns:

Result of the StopClock operation returned by the service.

See Also:

• AWS API Documentation

stopClock

default StopClockResponse stopClock(Consumer<StopClockRequest.Builder> stopClockRequest)
                             throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

Stops the simulation clock.

This is a convenience which creates an instance of the StopClockRequest.Builder avoiding the need to create one manually via StopClockRequest.builder()

Parameters:

stopClockRequest - A Consumer that will call methods on StopClockRequest.Builder to create a request.

Returns:

Result of the StopClock operation returned by the service.

See Also:

• AWS API Documentation

stopSimulation

default StopSimulationResponse stopSimulation(StopSimulationRequest stopSimulationRequest)
                                       throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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.

Parameters:

stopSimulationRequest -

Returns:

Result of the StopSimulation operation returned by the service.

See Also:

• AWS API Documentation

stopSimulation

default StopSimulationResponse stopSimulation(Consumer<StopSimulationRequest.Builder> stopSimulationRequest)
                                       throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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.

This is a convenience which creates an instance of the StopSimulationRequest.Builder avoiding the need to create one manually via StopSimulationRequest.builder()

Parameters:

stopSimulationRequest - A Consumer that will call methods on StopSimulationRequest.Builder to create a request.

Returns:

Result of the StopSimulation operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws TooManyTagsException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws TooManyTagsException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
SimSpaceWeaverException

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.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

create

static SimSpaceWeaverClient create()

Create a SimSpaceWeaverClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SimSpaceWeaverClientBuilder builder()

Create a builder that can be used to configure and create a SimSpaceWeaverClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default SimSpaceWeaverServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration