Package software.amazon.awssdk.services.simspaceweaver

Interface SimSpaceWeaverAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SimSpaceWeaverAsyncClient extends AwsClient
Service client for accessing AWS SimSpace Weaver asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • createSnapshot

      default CompletableFuture<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest createSnapshotRequest)

      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:
      A Java Future containing the result of the CreateSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSnapshot

      default CompletableFuture<CreateSnapshotResponse> createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)

      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:
      A Java Future containing the result of the CreateSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApp

      default CompletableFuture<DeleteAppResponse> deleteApp(DeleteAppRequest deleteAppRequest)

      Deletes the instance of the given custom app.

      Parameters:
      deleteAppRequest -
      Returns:
      A Java Future containing the result of the DeleteApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApp

      default CompletableFuture<DeleteAppResponse> deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest)

      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:
      A Java Future containing the result of the DeleteApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSimulation

      default CompletableFuture<DeleteSimulationResponse> deleteSimulation(DeleteSimulationRequest deleteSimulationRequest)

      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:
      A Java Future containing the result of the DeleteSimulation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSimulation

      default CompletableFuture<DeleteSimulationResponse> deleteSimulation(Consumer<DeleteSimulationRequest.Builder> deleteSimulationRequest)

      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:
      A Java Future containing the result of the DeleteSimulation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeApp

      default CompletableFuture<DescribeAppResponse> describeApp(DescribeAppRequest describeAppRequest)

      Returns the state of the given custom app.

      Parameters:
      describeAppRequest -
      Returns:
      A Java Future containing the result of the DescribeApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeApp

      default CompletableFuture<DescribeAppResponse> describeApp(Consumer<DescribeAppRequest.Builder> describeAppRequest)

      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:
      A Java Future containing the result of the DescribeApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSimulation

      default CompletableFuture<DescribeSimulationResponse> describeSimulation(DescribeSimulationRequest describeSimulationRequest)

      Returns the current state of the given simulation.

      Parameters:
      describeSimulationRequest -
      Returns:
      A Java Future containing the result of the DescribeSimulation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSimulation

      default CompletableFuture<DescribeSimulationResponse> describeSimulation(Consumer<DescribeSimulationRequest.Builder> describeSimulationRequest)

      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:
      A Java Future containing the result of the DescribeSimulation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApps

      default CompletableFuture<ListAppsResponse> listApps(ListAppsRequest listAppsRequest)

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

      Parameters:
      listAppsRequest -
      Returns:
      A Java Future containing the result of the ListApps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApps

      default CompletableFuture<ListAppsResponse> listApps(Consumer<ListAppsRequest.Builder> listAppsRequest)

      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:
      A Java Future containing the result of the ListApps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAppsPaginator

      default ListAppsPublisher listAppsPaginator(ListAppsRequest listAppsRequest)

      This is a variant of listApps(software.amazon.awssdk.services.simspaceweaver.model.ListAppsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.simspaceweaver.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.simspaceweaver.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.simspaceweaver.model.ListAppsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.simspaceweaver.model.ListAppsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAppsPaginator

      default ListAppsPublisher listAppsPaginator(Consumer<ListAppsRequest.Builder> listAppsRequest)

      This is a variant of listApps(software.amazon.awssdk.services.simspaceweaver.model.ListAppsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.simspaceweaver.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.simspaceweaver.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.simspaceweaver.model.ListAppsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.simspaceweaver.model.ListAppsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSimulations

      default CompletableFuture<ListSimulationsResponse> listSimulations(ListSimulationsRequest listSimulationsRequest)

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

      Parameters:
      listSimulationsRequest -
      Returns:
      A Java Future containing the result of the ListSimulations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSimulations

      default CompletableFuture<ListSimulationsResponse> listSimulations(Consumer<ListSimulationsRequest.Builder> listSimulationsRequest)

      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:
      A Java Future containing the result of the ListSimulations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSimulationsPaginator

      default ListSimulationsPublisher listSimulationsPaginator(ListSimulationsRequest listSimulationsRequest)

      This is a variant of listSimulations(software.amazon.awssdk.services.simspaceweaver.model.ListSimulationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.simspaceweaver.paginators.ListSimulationsPublisher publisher = client.listSimulationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.simspaceweaver.paginators.ListSimulationsPublisher publisher = client.listSimulationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.simspaceweaver.model.ListSimulationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.simspaceweaver.model.ListSimulationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSimulationsPaginator

      default ListSimulationsPublisher listSimulationsPaginator(Consumer<ListSimulationsRequest.Builder> listSimulationsRequest)

      This is a variant of listSimulations(software.amazon.awssdk.services.simspaceweaver.model.ListSimulationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.simspaceweaver.paginators.ListSimulationsPublisher publisher = client.listSimulationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.simspaceweaver.paginators.ListSimulationsPublisher publisher = client.listSimulationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.simspaceweaver.model.ListSimulationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.simspaceweaver.model.ListSimulationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists all tags on a SimSpace Weaver resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      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:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startApp

      default CompletableFuture<StartAppResponse> startApp(StartAppRequest startAppRequest)

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

      Parameters:
      startAppRequest -
      Returns:
      A Java Future containing the result of the StartApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ServiceQuotaExceededException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startApp

      default CompletableFuture<StartAppResponse> startApp(Consumer<StartAppRequest.Builder> startAppRequest)

      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:
      A Java Future containing the result of the StartApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ServiceQuotaExceededException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startClock

      default CompletableFuture<StartClockResponse> startClock(StartClockRequest startClockRequest)

      Starts the simulation clock.

      Parameters:
      startClockRequest -
      Returns:
      A Java Future containing the result of the StartClock operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startClock

      default CompletableFuture<StartClockResponse> startClock(Consumer<StartClockRequest.Builder> startClockRequest)

      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:
      A Java Future containing the result of the StartClock operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startSimulation

      default CompletableFuture<StartSimulationResponse> startSimulation(StartSimulationRequest startSimulationRequest)

      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:
      A Java Future containing the result of the StartSimulation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ServiceQuotaExceededException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startSimulation

      default CompletableFuture<StartSimulationResponse> startSimulation(Consumer<StartSimulationRequest.Builder> startSimulationRequest)

      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:
      A Java Future containing the result of the StartSimulation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ServiceQuotaExceededException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopApp

      default CompletableFuture<StopAppResponse> stopApp(StopAppRequest stopAppRequest)

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

      Parameters:
      stopAppRequest -
      Returns:
      A Java Future containing the result of the StopApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopApp

      default CompletableFuture<StopAppResponse> stopApp(Consumer<StopAppRequest.Builder> stopAppRequest)

      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:
      A Java Future containing the result of the StopApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopClock

      default CompletableFuture<StopClockResponse> stopClock(StopClockRequest stopClockRequest)

      Stops the simulation clock.

      Parameters:
      stopClockRequest -
      Returns:
      A Java Future containing the result of the StopClock operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopClock

      default CompletableFuture<StopClockResponse> stopClock(Consumer<StopClockRequest.Builder> stopClockRequest)

      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:
      A Java Future containing the result of the StopClock operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopSimulation

      default CompletableFuture<StopSimulationResponse> stopSimulation(StopSimulationRequest stopSimulationRequest)

      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:
      A Java Future containing the result of the StopSimulation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopSimulation

      default CompletableFuture<StopSimulationResponse> stopSimulation(Consumer<StopSimulationRequest.Builder> stopSimulationRequest)

      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:
      A Java Future containing the result of the StopSimulation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • InternalServerException
      • AccessDeniedException
      • ValidationException
      • ConflictException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> 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:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyTagsException
      • ResourceNotFoundException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.


      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:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyTagsException
      • ResourceNotFoundException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> 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:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> 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.


      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:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException
      • ValidationException
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SimSpaceWeaverException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • 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

    • create

      static SimSpaceWeaverAsyncClient create()
      Create a SimSpaceWeaverAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static SimSpaceWeaverAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SimSpaceWeaverAsyncClient.