com.amazonaws.services.simspaceweaver.AWSSimSpaceWeaver Maven / Gradle / Ivy
Show all versions of aws-java-sdk-simspaceweaver Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.simspaceweaver;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.simspaceweaver.model.*;
/**
* Interface for accessing AWS SimSpace Weaver.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.simspaceweaver.AbstractAWSSimSpaceWeaver} instead.
*
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSimSpaceWeaver {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "simspaceweaver";
/**
*
* 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
*
*
*
*
* @param createSnapshotRequest
* @return Result of the CreateSnapshot operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ConflictException
* @sample AWSSimSpaceWeaver.CreateSnapshot
* @see AWS
* API Documentation
*/
CreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest);
/**
*
* Deletes the instance of the given custom app.
*
*
* @param deleteAppRequest
* @return Result of the DeleteApp operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ConflictException
* @sample AWSSimSpaceWeaver.DeleteApp
* @see AWS API
* Documentation
*/
DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest);
/**
*
* 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.
*
*
*
* @param deleteSimulationRequest
* @return Result of the DeleteSimulation operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ConflictException
* @sample AWSSimSpaceWeaver.DeleteSimulation
* @see AWS API Documentation
*/
DeleteSimulationResult deleteSimulation(DeleteSimulationRequest deleteSimulationRequest);
/**
*
* Returns the state of the given custom app.
*
*
* @param describeAppRequest
* @return Result of the DescribeApp operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @sample AWSSimSpaceWeaver.DescribeApp
* @see AWS API
* Documentation
*/
DescribeAppResult describeApp(DescribeAppRequest describeAppRequest);
/**
*
* Returns the current state of the given simulation.
*
*
* @param describeSimulationRequest
* @return Result of the DescribeSimulation operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @sample AWSSimSpaceWeaver.DescribeSimulation
* @see AWS API Documentation
*/
DescribeSimulationResult describeSimulation(DescribeSimulationRequest describeSimulationRequest);
/**
*
* Lists all custom apps or service apps for the given simulation and domain.
*
*
* @param listAppsRequest
* @return Result of the ListApps operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @sample AWSSimSpaceWeaver.ListApps
* @see AWS API
* Documentation
*/
ListAppsResult listApps(ListAppsRequest listAppsRequest);
/**
*
* Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.
*
*
* @param listSimulationsRequest
* @return Result of the ListSimulations operation returned by the service.
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @sample AWSSimSpaceWeaver.ListSimulations
* @see AWS
* API Documentation
*/
ListSimulationsResult listSimulations(ListSimulationsRequest listSimulationsRequest);
/**
*
* Lists all tags on a SimSpace Weaver resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* @throws ValidationException
* @sample AWSSimSpaceWeaver.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Starts a custom app with the configuration specified in the simulation schema.
*
*
* @param startAppRequest
* @return Result of the StartApp operation returned by the service.
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ServiceQuotaExceededException
* @throws ConflictException
* @sample AWSSimSpaceWeaver.StartApp
* @see AWS API
* Documentation
*/
StartAppResult startApp(StartAppRequest startAppRequest);
/**
*
* Starts the simulation clock.
*
*
* @param startClockRequest
* @return Result of the StartClock operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ConflictException
* @sample AWSSimSpaceWeaver.StartClock
* @see AWS API
* Documentation
*/
StartClockResult startClock(StartClockRequest startClockRequest);
/**
*
* 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.
*
*
* @param startSimulationRequest
* @return Result of the StartSimulation operation returned by the service.
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ServiceQuotaExceededException
* @throws ConflictException
* @sample AWSSimSpaceWeaver.StartSimulation
* @see AWS
* API Documentation
*/
StartSimulationResult startSimulation(StartSimulationRequest startSimulationRequest);
/**
*
* Stops the given custom app and shuts down all of its allocated compute resources.
*
*
* @param stopAppRequest
* @return Result of the StopApp operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ConflictException
* @sample AWSSimSpaceWeaver.StopApp
* @see AWS API
* Documentation
*/
StopAppResult stopApp(StopAppRequest stopAppRequest);
/**
*
* Stops the simulation clock.
*
*
* @param stopClockRequest
* @return Result of the StopClock operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ConflictException
* @sample AWSSimSpaceWeaver.StopClock
* @see AWS API
* Documentation
*/
StopClockResult stopClock(StopClockRequest stopClockRequest);
/**
*
* 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.
*
*
*
* @param stopSimulationRequest
* @return Result of the StopSimulation operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ConflictException
* @sample AWSSimSpaceWeaver.StopSimulation
* @see AWS
* API Documentation
*/
StopSimulationResult stopSimulation(StopSimulationRequest stopSimulationRequest);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws TooManyTagsException
* @throws ResourceNotFoundException
* @throws ValidationException
* @sample AWSSimSpaceWeaver.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* 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.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* @throws ValidationException
* @sample AWSSimSpaceWeaver.UntagResource
* @see AWS
* API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}