Class: Aws::SimSpaceWeaver::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SimSpaceWeaver::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb
Overview
An API client for SimSpaceWeaver. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::SimSpaceWeaver::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_snapshot(params = {}) ⇒ Struct
Creates a snapshot of the specified simulation.
-
#delete_app(params = {}) ⇒ Struct
Deletes the instance of the given custom app.
-
#delete_simulation(params = {}) ⇒ Struct
Deletes all SimSpace Weaver resources assigned to the given simulation.
-
#describe_app(params = {}) ⇒ Types::DescribeAppOutput
Returns the state of the given custom app.
-
#describe_simulation(params = {}) ⇒ Types::DescribeSimulationOutput
Returns the current state of the given simulation.
-
#list_apps(params = {}) ⇒ Types::ListAppsOutput
Lists all custom apps or service apps for the given simulation and domain.
-
#list_simulations(params = {}) ⇒ Types::ListSimulationsOutput
Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists all tags on a SimSpace Weaver resource.
-
#start_app(params = {}) ⇒ Types::StartAppOutput
Starts a custom app with the configuration specified in the simulation schema.
-
#start_clock(params = {}) ⇒ Struct
Starts the simulation clock.
-
#start_simulation(params = {}) ⇒ Types::StartSimulationOutput
Starts a simulation with the given name.
-
#stop_app(params = {}) ⇒ Struct
Stops the given custom app and shuts down all of its allocated compute resources.
-
#stop_clock(params = {}) ⇒ Struct
Stops the simulation clock.
-
#stop_simulation(params = {}) ⇒ Struct
Stops the given simulation.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to a SimSpace Weaver resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a SimSpace Weaver resource.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#create_snapshot(params = {}) ⇒ Struct
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 yearMM
is the 2-digit monthdd
is the 2-digit day of the monthHH
is the 2-digit hour (24-hour clock)mm
is the 2-digit minutesss
is the 2-digit seconds
476 477 478 479 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 476 def create_snapshot(params = {}, = {}) req = build_request(:create_snapshot, params) req.send_request() end |
#delete_app(params = {}) ⇒ Struct
Deletes the instance of the given custom app.
506 507 508 509 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 506 def delete_app(params = {}, = {}) req = build_request(:delete_app, params) req.send_request() end |
#delete_simulation(params = {}) ⇒ Struct
Deletes all SimSpace Weaver resources assigned to the given simulation.
534 535 536 537 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 534 def delete_simulation(params = {}, = {}) req = build_request(:delete_simulation, params) req.send_request() end |
#describe_app(params = {}) ⇒ Types::DescribeAppOutput
Returns the state of the given custom app.
588 589 590 591 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 588 def describe_app(params = {}, = {}) req = build_request(:describe_app, params) req.send_request() end |
#describe_simulation(params = {}) ⇒ Types::DescribeSimulationOutput
Returns the current state of the given simulation.
652 653 654 655 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 652 def describe_simulation(params = {}, = {}) req = build_request(:describe_simulation, params) req.send_request() end |
#list_apps(params = {}) ⇒ Types::ListAppsOutput
Lists all custom apps or service apps for the given simulation and domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
708 709 710 711 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 708 def list_apps(params = {}, = {}) req = build_request(:list_apps, params) req.send_request() end |
#list_simulations(params = {}) ⇒ Types::ListSimulationsOutput
Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
756 757 758 759 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 756 def list_simulations(params = {}, = {}) req = build_request(:list_simulations, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists all tags on a SimSpace Weaver resource.
791 792 793 794 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 791 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_app(params = {}) ⇒ Types::StartAppOutput
Starts a custom app with the configuration specified in the simulation schema.
853 854 855 856 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 853 def start_app(params = {}, = {}) req = build_request(:start_app, params) req.send_request() end |
#start_clock(params = {}) ⇒ Struct
Starts the simulation clock.
875 876 877 878 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 875 def start_clock(params = {}, = {}) req = build_request(:start_clock, params) req.send_request() end |
#start_simulation(params = {}) ⇒ Types::StartSimulationOutput
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.
1005 1006 1007 1008 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 1005 def start_simulation(params = {}, = {}) req = build_request(:start_simulation, params) req.send_request() end |
#stop_app(params = {}) ⇒ Struct
Stops the given custom app and shuts down all of its allocated compute resources.
1036 1037 1038 1039 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 1036 def stop_app(params = {}, = {}) req = build_request(:stop_app, params) req.send_request() end |
#stop_clock(params = {}) ⇒ Struct
Stops the simulation clock.
1058 1059 1060 1061 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 1058 def stop_clock(params = {}, = {}) req = build_request(:stop_clock, params) req.send_request() end |
#stop_simulation(params = {}) ⇒ Struct
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.
1084 1085 1086 1087 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 1084 def stop_simulation(params = {}, = {}) req = build_request(:stop_simulation, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
1124 1125 1126 1127 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 1124 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
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.
1162 1163 1164 1165 |
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/client.rb', line 1162 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |