@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SimSpaceWeaverClient extends AwsClient
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and 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)
Lists all custom apps or service apps for the given simulation and domain.
|
default ListAppsIterable |
listAppsPaginator(ListAppsRequest listAppsRequest)
Lists all custom apps or service apps for the given simulation and domain.
|
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)
Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.
|
default ListSimulationsIterable |
listSimulationsPaginator(ListSimulationsRequest listSimulationsRequest)
Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.
|
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() |
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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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
createSnapshotRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault 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()
createSnapshotRequest - A Consumer that will call methods on
CreateSnapshotRequest.Builder to create a
request.ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault DeleteAppResponse deleteApp(DeleteAppRequest deleteAppRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SimSpaceWeaverException
Deletes the instance of the given custom app.
deleteAppRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault 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()
deleteAppRequest - A Consumer that will call methods on
DeleteAppRequest.Builder to create a request.ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault 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.
deleteSimulationRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault 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()
deleteSimulationRequest - A Consumer that will call methods on
DeleteSimulationRequest.Builder to create a
request.ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault DescribeAppResponse describeApp(DescribeAppRequest describeAppRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SimSpaceWeaverException
Returns the state of the given custom app.
describeAppRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault 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()
describeAppRequest - A Consumer that will call methods on
DescribeAppRequest.Builder to create a
request.ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault DescribeSimulationResponse describeSimulation(DescribeSimulationRequest describeSimulationRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, SimSpaceWeaverException
Returns the current state of the given simulation.
describeSimulationRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault 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()
describeSimulationRequest - A Consumer that will call methods on
DescribeSimulationRequest.Builder to create a
request.ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault 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.
listAppsRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault 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()
listAppsRequest - A Consumer that will call methods on
ListAppsRequest.Builder to create a request.ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault ListAppsIterable listAppsPaginator(ListAppsRequest 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 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.
listAppsRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault ListAppsIterable listAppsPaginator(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 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()
listAppsRequest - A Consumer that will call methods on
ListAppsRequest.Builder to create a request.ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault 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.
listSimulationsRequest - InternalServerExceptionAccessDeniedExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault 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()
listSimulationsRequest - A Consumer that will call methods on
ListSimulationsRequest.Builder to create a
request.InternalServerExceptionAccessDeniedExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault ListSimulationsIterable listSimulationsPaginator(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.
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.
listSimulationsRequest - InternalServerExceptionAccessDeniedExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault ListSimulationsIterable listSimulationsPaginator(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 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()
listSimulationsRequest - A Consumer that will call methods on
ListSimulationsRequest.Builder to create a
request.InternalServerExceptionAccessDeniedExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, SimSpaceWeaverException
Lists all tags on a SimSpace Weaver resource.
listTagsForResourceRequest - ResourceNotFoundExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault 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()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create
a request.ResourceNotFoundExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault 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.
startAppRequest - InternalServerExceptionAccessDeniedExceptionValidationExceptionServiceQuotaExceededExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault 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()
startAppRequest - A Consumer that will call methods on
StartAppRequest.Builder to create a request.InternalServerExceptionAccessDeniedExceptionValidationExceptionServiceQuotaExceededExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault StartClockResponse startClock(StartClockRequest startClockRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SimSpaceWeaverException
Starts the simulation clock.
startClockRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault 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()
startClockRequest - A Consumer that will call methods on
StartClockRequest.Builder to create a
request.ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault 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.
startSimulationRequest - InternalServerExceptionAccessDeniedExceptionValidationExceptionServiceQuotaExceededExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault 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()
startSimulationRequest - A Consumer that will call methods on
StartSimulationRequest.Builder to create a
request.InternalServerExceptionAccessDeniedExceptionValidationExceptionServiceQuotaExceededExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault 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.
stopAppRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault 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()
stopAppRequest - A Consumer that will call methods on
StopAppRequest.Builder to create a request.ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault StopClockResponse stopClock(StopClockRequest stopClockRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SimSpaceWeaverException
Stops the simulation clock.
stopClockRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault 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()
stopClockRequest - A Consumer that will call methods on
StopClockRequest.Builder to create a request.ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault 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.
stopSimulationRequest - ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault 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()
stopSimulationRequest - A Consumer that will call methods on
StopSimulationRequest.Builder to create a
request.ResourceNotFoundExceptionInternalServerExceptionAccessDeniedExceptionValidationExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault 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.
tagResourceRequest - TooManyTagsExceptionResourceNotFoundExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault 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()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a
request.TooManyTagsExceptionResourceNotFoundExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault 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.
untagResourceRequest - ResourceNotFoundExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault 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()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a
request.ResourceNotFoundExceptionValidationExceptionSdkException - 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.AwsServiceExceptionstatic SimSpaceWeaverClient create()
SimSpaceWeaverClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SimSpaceWeaverClientBuilder builder()
SimSpaceWeaverClient.static ServiceMetadata serviceMetadata()
default SimSpaceWeaverServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.