aws-sdk-simspaceweaver 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1049 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
32
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
33
+ require 'aws-sdk-core/plugins/sign.rb'
34
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
35
+
36
+ Aws::Plugins::GlobalConfiguration.add_identifier(:simspaceweaver)
37
+
38
+ module Aws::SimSpaceWeaver
39
+ # An API client for SimSpaceWeaver. To construct a client, you need to configure a `:region` and `:credentials`.
40
+ #
41
+ # client = Aws::SimSpaceWeaver::Client.new(
42
+ # region: region_name,
43
+ # credentials: credentials,
44
+ # # ...
45
+ # )
46
+ #
47
+ # For details on configuring region and credentials see
48
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
49
+ #
50
+ # See {#initialize} for a full list of supported configuration options.
51
+ class Client < Seahorse::Client::Base
52
+
53
+ include Aws::ClientStubs
54
+
55
+ @identifier = :simspaceweaver
56
+
57
+ set_api(ClientApi::API)
58
+
59
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
60
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
61
+ add_plugin(Aws::Plugins::Logging)
62
+ add_plugin(Aws::Plugins::ParamConverter)
63
+ add_plugin(Aws::Plugins::ParamValidator)
64
+ add_plugin(Aws::Plugins::UserAgent)
65
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
66
+ add_plugin(Aws::Plugins::RetryErrors)
67
+ add_plugin(Aws::Plugins::GlobalConfiguration)
68
+ add_plugin(Aws::Plugins::RegionalEndpoint)
69
+ add_plugin(Aws::Plugins::EndpointDiscovery)
70
+ add_plugin(Aws::Plugins::EndpointPattern)
71
+ add_plugin(Aws::Plugins::ResponsePaging)
72
+ add_plugin(Aws::Plugins::StubResponses)
73
+ add_plugin(Aws::Plugins::IdempotencyToken)
74
+ add_plugin(Aws::Plugins::JsonvalueConverter)
75
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
76
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
77
+ add_plugin(Aws::Plugins::TransferEncoding)
78
+ add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
+ add_plugin(Aws::Plugins::DefaultsMode)
81
+ add_plugin(Aws::Plugins::RecursionDetection)
82
+ add_plugin(Aws::Plugins::Sign)
83
+ add_plugin(Aws::Plugins::Protocols::RestJson)
84
+ add_plugin(Aws::SimSpaceWeaver::Plugins::Endpoints)
85
+
86
+ # @overload initialize(options)
87
+ # @param [Hash] options
88
+ # @option options [required, Aws::CredentialProvider] :credentials
89
+ # Your AWS credentials. This can be an instance of any one of the
90
+ # following classes:
91
+ #
92
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
93
+ # credentials.
94
+ #
95
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
96
+ # shared file, such as `~/.aws/config`.
97
+ #
98
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
99
+ #
100
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
101
+ # assume a role after providing credentials via the web.
102
+ #
103
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
104
+ # access token generated from `aws login`.
105
+ #
106
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
107
+ # process that outputs to stdout.
108
+ #
109
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
110
+ # from an EC2 IMDS on an EC2 instance.
111
+ #
112
+ # * `Aws::ECSCredentials` - Used for loading credentials from
113
+ # instances running in ECS.
114
+ #
115
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
116
+ # from the Cognito Identity service.
117
+ #
118
+ # When `:credentials` are not configured directly, the following
119
+ # locations will be searched for credentials:
120
+ #
121
+ # * `Aws.config[:credentials]`
122
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
123
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
124
+ # * `~/.aws/credentials`
125
+ # * `~/.aws/config`
126
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
127
+ # are very aggressive. Construct and pass an instance of
128
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
129
+ # enable retries and extended timeouts. Instance profile credential
130
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
131
+ # to true.
132
+ #
133
+ # @option options [required, String] :region
134
+ # The AWS region to connect to. The configured `:region` is
135
+ # used to determine the service `:endpoint`. When not passed,
136
+ # a default `:region` is searched for in the following locations:
137
+ #
138
+ # * `Aws.config[:region]`
139
+ # * `ENV['AWS_REGION']`
140
+ # * `ENV['AMAZON_REGION']`
141
+ # * `ENV['AWS_DEFAULT_REGION']`
142
+ # * `~/.aws/credentials`
143
+ # * `~/.aws/config`
144
+ #
145
+ # @option options [String] :access_key_id
146
+ #
147
+ # @option options [Boolean] :active_endpoint_cache (false)
148
+ # When set to `true`, a thread polling for endpoints will be running in
149
+ # the background every 60 secs (default). Defaults to `false`.
150
+ #
151
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
152
+ # Used only in `adaptive` retry mode. When true, the request will sleep
153
+ # until there is sufficent client side capacity to retry the request.
154
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
155
+ # not retry instead of sleeping.
156
+ #
157
+ # @option options [Boolean] :client_side_monitoring (false)
158
+ # When `true`, client-side metrics will be collected for all API requests from
159
+ # this client.
160
+ #
161
+ # @option options [String] :client_side_monitoring_client_id ("")
162
+ # Allows you to provide an identifier for this client which will be attached to
163
+ # all generated client side metrics. Defaults to an empty string.
164
+ #
165
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
166
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
167
+ # side monitoring agent is running on, where client metrics will be published via UDP.
168
+ #
169
+ # @option options [Integer] :client_side_monitoring_port (31000)
170
+ # Required for publishing client metrics. The port that the client side monitoring
171
+ # agent is running on, where client metrics will be published via UDP.
172
+ #
173
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
174
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
175
+ # will use the Client Side Monitoring Agent Publisher.
176
+ #
177
+ # @option options [Boolean] :convert_params (true)
178
+ # When `true`, an attempt is made to coerce request parameters into
179
+ # the required types.
180
+ #
181
+ # @option options [Boolean] :correct_clock_skew (true)
182
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
183
+ # a clock skew correction and retry requests with skewed client clocks.
184
+ #
185
+ # @option options [String] :defaults_mode ("legacy")
186
+ # See {Aws::DefaultsModeConfiguration} for a list of the
187
+ # accepted modes and the configuration defaults that are included.
188
+ #
189
+ # @option options [Boolean] :disable_host_prefix_injection (false)
190
+ # Set to true to disable SDK automatically adding host prefix
191
+ # to default service endpoint when available.
192
+ #
193
+ # @option options [String] :endpoint
194
+ # The client endpoint is normally constructed from the `:region`
195
+ # option. You should only configure an `:endpoint` when connecting
196
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
197
+ #
198
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
199
+ # Used for the maximum size limit of the LRU cache storing endpoints data
200
+ # for endpoint discovery enabled operations. Defaults to 1000.
201
+ #
202
+ # @option options [Integer] :endpoint_cache_max_threads (10)
203
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
204
+ #
205
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
206
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
207
+ # Use this option to config the time interval in seconds for making
208
+ # requests fetching endpoints information. Defaults to 60 sec.
209
+ #
210
+ # @option options [Boolean] :endpoint_discovery (false)
211
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
212
+ #
213
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
214
+ # The log formatter.
215
+ #
216
+ # @option options [Symbol] :log_level (:info)
217
+ # The log level to send messages to the `:logger` at.
218
+ #
219
+ # @option options [Logger] :logger
220
+ # The Logger instance to send log messages to. If this option
221
+ # is not set, logging will be disabled.
222
+ #
223
+ # @option options [Integer] :max_attempts (3)
224
+ # An integer representing the maximum number attempts that will be made for
225
+ # a single request, including the initial attempt. For example,
226
+ # setting this value to 5 will result in a request being retried up to
227
+ # 4 times. Used in `standard` and `adaptive` retry modes.
228
+ #
229
+ # @option options [String] :profile ("default")
230
+ # Used when loading credentials from the shared credentials file
231
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
232
+ #
233
+ # @option options [Proc] :retry_backoff
234
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
235
+ # This option is only used in the `legacy` retry mode.
236
+ #
237
+ # @option options [Float] :retry_base_delay (0.3)
238
+ # The base delay in seconds used by the default backoff function. This option
239
+ # is only used in the `legacy` retry mode.
240
+ #
241
+ # @option options [Symbol] :retry_jitter (:none)
242
+ # A delay randomiser function used by the default backoff function.
243
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
244
+ # otherwise a Proc that takes and returns a number. This option is only used
245
+ # in the `legacy` retry mode.
246
+ #
247
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
248
+ #
249
+ # @option options [Integer] :retry_limit (3)
250
+ # The maximum number of times to retry failed requests. Only
251
+ # ~ 500 level server errors and certain ~ 400 level client errors
252
+ # are retried. Generally, these are throttling errors, data
253
+ # checksum errors, networking errors, timeout errors, auth errors,
254
+ # endpoint discovery, and errors from expired credentials.
255
+ # This option is only used in the `legacy` retry mode.
256
+ #
257
+ # @option options [Integer] :retry_max_delay (0)
258
+ # The maximum number of seconds to delay between retries (0 for no limit)
259
+ # used by the default backoff function. This option is only used in the
260
+ # `legacy` retry mode.
261
+ #
262
+ # @option options [String] :retry_mode ("legacy")
263
+ # Specifies which retry algorithm to use. Values are:
264
+ #
265
+ # * `legacy` - The pre-existing retry behavior. This is default value if
266
+ # no retry mode is provided.
267
+ #
268
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
269
+ # This includes support for retry quotas, which limit the number of
270
+ # unsuccessful retries a client can make.
271
+ #
272
+ # * `adaptive` - An experimental retry mode that includes all the
273
+ # functionality of `standard` mode along with automatic client side
274
+ # throttling. This is a provisional mode that may change behavior
275
+ # in the future.
276
+ #
277
+ #
278
+ # @option options [String] :secret_access_key
279
+ #
280
+ # @option options [String] :session_token
281
+ #
282
+ # @option options [Boolean] :stub_responses (false)
283
+ # Causes the client to return stubbed responses. By default
284
+ # fake responses are generated and returned. You can specify
285
+ # the response data to return or errors to raise by calling
286
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
287
+ #
288
+ # ** Please note ** When response stubbing is enabled, no HTTP
289
+ # requests are made, and retries are disabled.
290
+ #
291
+ # @option options [Aws::TokenProvider] :token_provider
292
+ # A Bearer Token Provider. This can be an instance of any one of the
293
+ # following classes:
294
+ #
295
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
296
+ # tokens.
297
+ #
298
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
299
+ # access token generated from `aws login`.
300
+ #
301
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
302
+ # will be used to search for tokens configured for your profile in shared configuration files.
303
+ #
304
+ # @option options [Boolean] :use_dualstack_endpoint
305
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
306
+ # will be used if available.
307
+ #
308
+ # @option options [Boolean] :use_fips_endpoint
309
+ # When set to `true`, fips compatible endpoints will be used if available.
310
+ # When a `fips` region is used, the region is normalized and this config
311
+ # is set to `true`.
312
+ #
313
+ # @option options [Boolean] :validate_params (true)
314
+ # When `true`, request parameters are validated before
315
+ # sending the request.
316
+ #
317
+ # @option options [Aws::SimSpaceWeaver::EndpointProvider] :endpoint_provider
318
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::SimSpaceWeaver::EndpointParameters`
319
+ #
320
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
321
+ # requests through. Formatted like 'http://proxy.com:123'.
322
+ #
323
+ # @option options [Float] :http_open_timeout (15) The number of
324
+ # seconds to wait when opening a HTTP session before raising a
325
+ # `Timeout::Error`.
326
+ #
327
+ # @option options [Float] :http_read_timeout (60) The default
328
+ # number of seconds to wait for response data. This value can
329
+ # safely be set per-request on the session.
330
+ #
331
+ # @option options [Float] :http_idle_timeout (5) The number of
332
+ # seconds a connection is allowed to sit idle before it is
333
+ # considered stale. Stale connections are closed and removed
334
+ # from the pool before making a request.
335
+ #
336
+ # @option options [Float] :http_continue_timeout (1) The number of
337
+ # seconds to wait for a 100-continue response before sending the
338
+ # request body. This option has no effect unless the request has
339
+ # "Expect" header set to "100-continue". Defaults to `nil` which
340
+ # disables this behaviour. This value can safely be set per
341
+ # request on the session.
342
+ #
343
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
344
+ # in seconds.
345
+ #
346
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
347
+ # HTTP debug output will be sent to the `:logger`.
348
+ #
349
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
350
+ # SSL peer certificates are verified when establishing a
351
+ # connection.
352
+ #
353
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
354
+ # certificate authority bundle file that should be used when
355
+ # verifying peer certificates. If you do not pass
356
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
357
+ # will be used if available.
358
+ #
359
+ # @option options [String] :ssl_ca_directory Full path of the
360
+ # directory that contains the unbundled SSL certificate
361
+ # authority files for verifying peer certificates. If you do
362
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
363
+ # system default will be used if available.
364
+ #
365
+ def initialize(*args)
366
+ super
367
+ end
368
+
369
+ # @!group API Operations
370
+
371
+ # Deletes the instance of the given custom app.
372
+ #
373
+ # @option params [required, String] :app
374
+ # The name of the app.
375
+ #
376
+ # @option params [required, String] :domain
377
+ # The name of the domain of the app.
378
+ #
379
+ # @option params [required, String] :simulation
380
+ # The name of the simulation of the app.
381
+ #
382
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
383
+ #
384
+ # @example Request syntax with placeholder values
385
+ #
386
+ # resp = client.delete_app({
387
+ # app: "SimSpaceWeaverResourceName", # required
388
+ # domain: "SimSpaceWeaverResourceName", # required
389
+ # simulation: "SimSpaceWeaverResourceName", # required
390
+ # })
391
+ #
392
+ # @see http://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/DeleteApp AWS API Documentation
393
+ #
394
+ # @overload delete_app(params = {})
395
+ # @param [Hash] params ({})
396
+ def delete_app(params = {}, options = {})
397
+ req = build_request(:delete_app, params)
398
+ req.send_request(options)
399
+ end
400
+
401
+ # Deletes all SimSpace Weaver resources assigned to the given
402
+ # simulation.
403
+ #
404
+ # <note markdown="1"> Your simulation uses resources in other Amazon Web Services services.
405
+ # This API operation doesn't delete resources in other Amazon Web
406
+ # Services services.
407
+ #
408
+ # </note>
409
+ #
410
+ # @option params [required, String] :simulation
411
+ # The name of the simulation.
412
+ #
413
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
414
+ #
415
+ # @example Request syntax with placeholder values
416
+ #
417
+ # resp = client.delete_simulation({
418
+ # simulation: "SimSpaceWeaverResourceName", # required
419
+ # })
420
+ #
421
+ # @see http://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/DeleteSimulation AWS API Documentation
422
+ #
423
+ # @overload delete_simulation(params = {})
424
+ # @param [Hash] params ({})
425
+ def delete_simulation(params = {}, options = {})
426
+ req = build_request(:delete_simulation, params)
427
+ req.send_request(options)
428
+ end
429
+
430
+ # Returns the state of the given custom app.
431
+ #
432
+ # @option params [required, String] :app
433
+ # The name of the app.
434
+ #
435
+ # @option params [required, String] :domain
436
+ # The name of the domain of the app.
437
+ #
438
+ # @option params [required, String] :simulation
439
+ # The name of the simulation of the app.
440
+ #
441
+ # @return [Types::DescribeAppOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
442
+ #
443
+ # * {Types::DescribeAppOutput#description #description} => String
444
+ # * {Types::DescribeAppOutput#domain #domain} => String
445
+ # * {Types::DescribeAppOutput#endpoint_info #endpoint_info} => Types::SimulationAppEndpointInfo
446
+ # * {Types::DescribeAppOutput#launch_overrides #launch_overrides} => Types::LaunchOverrides
447
+ # * {Types::DescribeAppOutput#name #name} => String
448
+ # * {Types::DescribeAppOutput#simulation #simulation} => String
449
+ # * {Types::DescribeAppOutput#status #status} => String
450
+ # * {Types::DescribeAppOutput#target_status #target_status} => String
451
+ #
452
+ # @example Request syntax with placeholder values
453
+ #
454
+ # resp = client.describe_app({
455
+ # app: "SimSpaceWeaverResourceName", # required
456
+ # domain: "SimSpaceWeaverResourceName", # required
457
+ # simulation: "SimSpaceWeaverResourceName", # required
458
+ # })
459
+ #
460
+ # @example Response structure
461
+ #
462
+ # resp.description #=> String
463
+ # resp.domain #=> String
464
+ # resp.endpoint_info.address #=> String
465
+ # resp.endpoint_info.ingress_port_mappings #=> Array
466
+ # resp.endpoint_info.ingress_port_mappings[0].actual #=> Integer
467
+ # resp.endpoint_info.ingress_port_mappings[0].declared #=> Integer
468
+ # resp.launch_overrides.launch_commands #=> Array
469
+ # resp.launch_overrides.launch_commands[0] #=> String
470
+ # resp.name #=> String
471
+ # resp.simulation #=> String
472
+ # resp.status #=> String, one of "STARTING", "STARTED", "STOPPING", "STOPPED", "ERROR", "UNKNOWN"
473
+ # resp.target_status #=> String, one of "UNKNOWN", "STARTED", "STOPPED"
474
+ #
475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/DescribeApp AWS API Documentation
476
+ #
477
+ # @overload describe_app(params = {})
478
+ # @param [Hash] params ({})
479
+ def describe_app(params = {}, options = {})
480
+ req = build_request(:describe_app, params)
481
+ req.send_request(options)
482
+ end
483
+
484
+ # Returns the current state of the given simulation.
485
+ #
486
+ # @option params [required, String] :simulation
487
+ # The name of the simulation.
488
+ #
489
+ # @return [Types::DescribeSimulationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
490
+ #
491
+ # * {Types::DescribeSimulationOutput#arn #arn} => String
492
+ # * {Types::DescribeSimulationOutput#creation_time #creation_time} => Time
493
+ # * {Types::DescribeSimulationOutput#description #description} => String
494
+ # * {Types::DescribeSimulationOutput#execution_id #execution_id} => String
495
+ # * {Types::DescribeSimulationOutput#live_simulation_state #live_simulation_state} => Types::LiveSimulationState
496
+ # * {Types::DescribeSimulationOutput#logging_configuration #logging_configuration} => Types::LoggingConfiguration
497
+ # * {Types::DescribeSimulationOutput#maximum_duration #maximum_duration} => String
498
+ # * {Types::DescribeSimulationOutput#name #name} => String
499
+ # * {Types::DescribeSimulationOutput#role_arn #role_arn} => String
500
+ # * {Types::DescribeSimulationOutput#schema_error #schema_error} => String
501
+ # * {Types::DescribeSimulationOutput#schema_s3_location #schema_s3_location} => Types::S3Location
502
+ # * {Types::DescribeSimulationOutput#status #status} => String
503
+ # * {Types::DescribeSimulationOutput#target_status #target_status} => String
504
+ #
505
+ # @example Request syntax with placeholder values
506
+ #
507
+ # resp = client.describe_simulation({
508
+ # simulation: "SimSpaceWeaverResourceName", # required
509
+ # })
510
+ #
511
+ # @example Response structure
512
+ #
513
+ # resp.arn #=> String
514
+ # resp.creation_time #=> Time
515
+ # resp.description #=> String
516
+ # resp.execution_id #=> String
517
+ # resp.live_simulation_state.clocks #=> Array
518
+ # resp.live_simulation_state.clocks[0].status #=> String, one of "UNKNOWN", "STARTING", "STARTED", "STOPPING", "STOPPED"
519
+ # resp.live_simulation_state.clocks[0].target_status #=> String, one of "UNKNOWN", "STARTED", "STOPPED"
520
+ # resp.live_simulation_state.domains #=> Array
521
+ # resp.live_simulation_state.domains[0].lifecycle #=> String, one of "Unknown", "PerWorker", "BySpatialSubdivision", "ByRequest"
522
+ # resp.live_simulation_state.domains[0].name #=> String
523
+ # resp.logging_configuration.destinations #=> Array
524
+ # resp.logging_configuration.destinations[0].cloud_watch_logs_log_group.log_group_arn #=> String
525
+ # resp.maximum_duration #=> String
526
+ # resp.name #=> String
527
+ # resp.role_arn #=> String
528
+ # resp.schema_error #=> String
529
+ # resp.schema_s3_location.bucket_name #=> String
530
+ # resp.schema_s3_location.object_key #=> String
531
+ # resp.status #=> String, one of "UNKNOWN", "STARTING", "STARTED", "STOPPING", "STOPPED", "FAILED", "DELETING", "DELETED"
532
+ # resp.target_status #=> String, one of "UNKNOWN", "STARTED", "STOPPED", "DELETED"
533
+ #
534
+ # @see http://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/DescribeSimulation AWS API Documentation
535
+ #
536
+ # @overload describe_simulation(params = {})
537
+ # @param [Hash] params ({})
538
+ def describe_simulation(params = {}, options = {})
539
+ req = build_request(:describe_simulation, params)
540
+ req.send_request(options)
541
+ end
542
+
543
+ # Lists all custom apps or service apps for the given simulation and
544
+ # domain.
545
+ #
546
+ # @option params [String] :domain
547
+ # The name of the domain that you want to list apps for.
548
+ #
549
+ # @option params [Integer] :max_results
550
+ # The maximum number of apps to list.
551
+ #
552
+ # @option params [String] :next_token
553
+ # If SimSpace Weaver returns `nextToken`, there are more results
554
+ # available. The value of `nextToken` is a unique pagination token for
555
+ # each page. To retrieve the next page, call the operation again using
556
+ # the returned token. Keep all other arguments unchanged. If no results
557
+ # remain, `nextToken` is set to `null`. Each pagination token expires
558
+ # after 24 hours. If you provide a token that isn't valid, you receive
559
+ # an *HTTP 400 ValidationException* error.
560
+ #
561
+ # @option params [required, String] :simulation
562
+ # The name of the simulation that you want to list apps for.
563
+ #
564
+ # @return [Types::ListAppsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
565
+ #
566
+ # * {Types::ListAppsOutput#apps #apps} => Array&lt;Types::SimulationAppMetadata&gt;
567
+ # * {Types::ListAppsOutput#next_token #next_token} => String
568
+ #
569
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
570
+ #
571
+ # @example Request syntax with placeholder values
572
+ #
573
+ # resp = client.list_apps({
574
+ # domain: "SimSpaceWeaverResourceName",
575
+ # max_results: 1,
576
+ # next_token: "OptionalString",
577
+ # simulation: "SimSpaceWeaverResourceName", # required
578
+ # })
579
+ #
580
+ # @example Response structure
581
+ #
582
+ # resp.apps #=> Array
583
+ # resp.apps[0].domain #=> String
584
+ # resp.apps[0].name #=> String
585
+ # resp.apps[0].simulation #=> String
586
+ # resp.apps[0].status #=> String, one of "STARTING", "STARTED", "STOPPING", "STOPPED", "ERROR", "UNKNOWN"
587
+ # resp.apps[0].target_status #=> String, one of "UNKNOWN", "STARTED", "STOPPED"
588
+ # resp.next_token #=> String
589
+ #
590
+ # @see http://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/ListApps AWS API Documentation
591
+ #
592
+ # @overload list_apps(params = {})
593
+ # @param [Hash] params ({})
594
+ def list_apps(params = {}, options = {})
595
+ req = build_request(:list_apps, params)
596
+ req.send_request(options)
597
+ end
598
+
599
+ # Lists the SimSpace Weaver simulations in the Amazon Web Services
600
+ # account used to make the API call.
601
+ #
602
+ # @option params [Integer] :max_results
603
+ # The maximum number of simulations to list.
604
+ #
605
+ # @option params [String] :next_token
606
+ # If SimSpace Weaver returns `nextToken`, there are more results
607
+ # available. The value of `nextToken` is a unique pagination token for
608
+ # each page. To retrieve the next page, call the operation again using
609
+ # the returned token. Keep all other arguments unchanged. If no results
610
+ # remain, `nextToken` is set to `null`. Each pagination token expires
611
+ # after 24 hours. If you provide a token that isn't valid, you receive
612
+ # an *HTTP 400 ValidationException* error.
613
+ #
614
+ # @return [Types::ListSimulationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
615
+ #
616
+ # * {Types::ListSimulationsOutput#next_token #next_token} => String
617
+ # * {Types::ListSimulationsOutput#simulations #simulations} => Array&lt;Types::SimulationMetadata&gt;
618
+ #
619
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
620
+ #
621
+ # @example Request syntax with placeholder values
622
+ #
623
+ # resp = client.list_simulations({
624
+ # max_results: 1,
625
+ # next_token: "OptionalString",
626
+ # })
627
+ #
628
+ # @example Response structure
629
+ #
630
+ # resp.next_token #=> String
631
+ # resp.simulations #=> Array
632
+ # resp.simulations[0].arn #=> String
633
+ # resp.simulations[0].creation_time #=> Time
634
+ # resp.simulations[0].name #=> String
635
+ # resp.simulations[0].status #=> String, one of "UNKNOWN", "STARTING", "STARTED", "STOPPING", "STOPPED", "FAILED", "DELETING", "DELETED"
636
+ # resp.simulations[0].target_status #=> String, one of "UNKNOWN", "STARTED", "STOPPED", "DELETED"
637
+ #
638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/ListSimulations AWS API Documentation
639
+ #
640
+ # @overload list_simulations(params = {})
641
+ # @param [Hash] params ({})
642
+ def list_simulations(params = {}, options = {})
643
+ req = build_request(:list_simulations, params)
644
+ req.send_request(options)
645
+ end
646
+
647
+ # Lists all tags on a SimSpace Weaver resource.
648
+ #
649
+ # @option params [required, String] :resource_arn
650
+ # The Amazon Resource Name (ARN) of the resource. For more information
651
+ # about ARNs, see [Amazon Resource Names (ARNs)][1] in the *Amazon Web
652
+ # Services General Reference*.
653
+ #
654
+ #
655
+ #
656
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
657
+ #
658
+ # @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
659
+ #
660
+ # * {Types::ListTagsForResourceOutput#tags #tags} => Hash&lt;String,String&gt;
661
+ #
662
+ # @example Request syntax with placeholder values
663
+ #
664
+ # resp = client.list_tags_for_resource({
665
+ # resource_arn: "SimSpaceWeaverArn", # required
666
+ # })
667
+ #
668
+ # @example Response structure
669
+ #
670
+ # resp.tags #=> Hash
671
+ # resp.tags["TagKey"] #=> String
672
+ #
673
+ # @see http://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/ListTagsForResource AWS API Documentation
674
+ #
675
+ # @overload list_tags_for_resource(params = {})
676
+ # @param [Hash] params ({})
677
+ def list_tags_for_resource(params = {}, options = {})
678
+ req = build_request(:list_tags_for_resource, params)
679
+ req.send_request(options)
680
+ end
681
+
682
+ # Starts a custom app with the configuration specified in the simulation
683
+ # schema.
684
+ #
685
+ # @option params [String] :client_token
686
+ # A value that you provide to ensure that repeated calls to this API
687
+ # operation using the same parameters complete only once. A
688
+ # `ClientToken` is also known as an *idempotency token*. A `ClientToken`
689
+ # expires after 24 hours.
690
+ #
691
+ # **A suitable default value is auto-generated.** You should normally
692
+ # not need to pass this option.**
693
+ #
694
+ # @option params [String] :description
695
+ # The description of the app.
696
+ #
697
+ # @option params [required, String] :domain
698
+ # The name of the domain of the app.
699
+ #
700
+ # @option params [Types::LaunchOverrides] :launch_overrides
701
+ # Options that apply when the app starts. These optiAons override
702
+ # default behavior.
703
+ #
704
+ # @option params [required, String] :name
705
+ # The name of the app.
706
+ #
707
+ # @option params [required, String] :simulation
708
+ # The name of the simulation of the app.
709
+ #
710
+ # @return [Types::StartAppOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
711
+ #
712
+ # * {Types::StartAppOutput#domain #domain} => String
713
+ # * {Types::StartAppOutput#name #name} => String
714
+ # * {Types::StartAppOutput#simulation #simulation} => String
715
+ #
716
+ # @example Request syntax with placeholder values
717
+ #
718
+ # resp = client.start_app({
719
+ # client_token: "ClientToken",
720
+ # description: "Description",
721
+ # domain: "SimSpaceWeaverResourceName", # required
722
+ # launch_overrides: {
723
+ # launch_commands: ["NonEmptyString"],
724
+ # },
725
+ # name: "SimSpaceWeaverResourceName", # required
726
+ # simulation: "SimSpaceWeaverResourceName", # required
727
+ # })
728
+ #
729
+ # @example Response structure
730
+ #
731
+ # resp.domain #=> String
732
+ # resp.name #=> String
733
+ # resp.simulation #=> String
734
+ #
735
+ # @see http://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StartApp AWS API Documentation
736
+ #
737
+ # @overload start_app(params = {})
738
+ # @param [Hash] params ({})
739
+ def start_app(params = {}, options = {})
740
+ req = build_request(:start_app, params)
741
+ req.send_request(options)
742
+ end
743
+
744
+ # Starts the simulation clock.
745
+ #
746
+ # @option params [required, String] :simulation
747
+ # The name of the simulation.
748
+ #
749
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
750
+ #
751
+ # @example Request syntax with placeholder values
752
+ #
753
+ # resp = client.start_clock({
754
+ # simulation: "SimSpaceWeaverResourceName", # required
755
+ # })
756
+ #
757
+ # @see http://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StartClock AWS API Documentation
758
+ #
759
+ # @overload start_clock(params = {})
760
+ # @param [Hash] params ({})
761
+ def start_clock(params = {}, options = {})
762
+ req = build_request(:start_clock, params)
763
+ req.send_request(options)
764
+ end
765
+
766
+ # Starts a simulation with the given name and schema.
767
+ #
768
+ # @option params [String] :client_token
769
+ # A value that you provide to ensure that repeated calls to this API
770
+ # operation using the same parameters complete only once. A
771
+ # `ClientToken` is also known as an *idempotency token*. A `ClientToken`
772
+ # expires after 24 hours.
773
+ #
774
+ # **A suitable default value is auto-generated.** You should normally
775
+ # not need to pass this option.**
776
+ #
777
+ # @option params [String] :description
778
+ # The description of the simulation.
779
+ #
780
+ # @option params [String] :maximum_duration
781
+ # The maximum running time of the simulation, specified as a number of
782
+ # months (m or M), hours (h or H), or days (d or D). The simulation
783
+ # stops when it reaches this limit.
784
+ #
785
+ # @option params [required, String] :name
786
+ # The name of the simulation.
787
+ #
788
+ # @option params [required, String] :role_arn
789
+ # The Amazon Resource Name (ARN) of the Identity and Access Management
790
+ # (IAM) role that the simulation assumes to perform actions. For more
791
+ # information about ARNs, see [Amazon Resource Names (ARNs)][1] in the
792
+ # *Amazon Web Services General Reference*. For more information about
793
+ # IAM roles, see [IAM roles][2] in the *Identity and Access Management
794
+ # User Guide*.
795
+ #
796
+ #
797
+ #
798
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
799
+ # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html
800
+ #
801
+ # @option params [required, Types::S3Location] :schema_s3_location
802
+ # The location of the simulation schema in Amazon Simple Storage Service
803
+ # (Amazon S3). For more information about Amazon S3, see the [ *Amazon
804
+ # Simple Storage Service User Guide* ][1].
805
+ #
806
+ #
807
+ #
808
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html
809
+ #
810
+ # @option params [Hash<String,String>] :tags
811
+ # A list of tags for the simulation. For more information about tags,
812
+ # see [Tagging Amazon Web Services resources][1] in the *Amazon Web
813
+ # Services General Reference*.
814
+ #
815
+ #
816
+ #
817
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
818
+ #
819
+ # @return [Types::StartSimulationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
820
+ #
821
+ # * {Types::StartSimulationOutput#arn #arn} => String
822
+ # * {Types::StartSimulationOutput#creation_time #creation_time} => Time
823
+ # * {Types::StartSimulationOutput#execution_id #execution_id} => String
824
+ #
825
+ # @example Request syntax with placeholder values
826
+ #
827
+ # resp = client.start_simulation({
828
+ # client_token: "ClientToken",
829
+ # description: "Description",
830
+ # maximum_duration: "TimeToLiveString",
831
+ # name: "SimSpaceWeaverResourceName", # required
832
+ # role_arn: "RoleArn", # required
833
+ # schema_s3_location: { # required
834
+ # bucket_name: "BucketName",
835
+ # object_key: "ObjectKey",
836
+ # },
837
+ # tags: {
838
+ # "TagKey" => "TagValue",
839
+ # },
840
+ # })
841
+ #
842
+ # @example Response structure
843
+ #
844
+ # resp.arn #=> String
845
+ # resp.creation_time #=> Time
846
+ # resp.execution_id #=> String
847
+ #
848
+ # @see http://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StartSimulation AWS API Documentation
849
+ #
850
+ # @overload start_simulation(params = {})
851
+ # @param [Hash] params ({})
852
+ def start_simulation(params = {}, options = {})
853
+ req = build_request(:start_simulation, params)
854
+ req.send_request(options)
855
+ end
856
+
857
+ # Stops the given custom app and shuts down all of its allocated compute
858
+ # resources.
859
+ #
860
+ # @option params [required, String] :app
861
+ # The name of the app.
862
+ #
863
+ # @option params [required, String] :domain
864
+ # The name of the domain of the app.
865
+ #
866
+ # @option params [required, String] :simulation
867
+ # The name of the simulation of the app.
868
+ #
869
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
870
+ #
871
+ # @example Request syntax with placeholder values
872
+ #
873
+ # resp = client.stop_app({
874
+ # app: "SimSpaceWeaverResourceName", # required
875
+ # domain: "SimSpaceWeaverResourceName", # required
876
+ # simulation: "SimSpaceWeaverResourceName", # required
877
+ # })
878
+ #
879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StopApp AWS API Documentation
880
+ #
881
+ # @overload stop_app(params = {})
882
+ # @param [Hash] params ({})
883
+ def stop_app(params = {}, options = {})
884
+ req = build_request(:stop_app, params)
885
+ req.send_request(options)
886
+ end
887
+
888
+ # Stops the simulation clock.
889
+ #
890
+ # @option params [required, String] :simulation
891
+ # The name of the simulation.
892
+ #
893
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
894
+ #
895
+ # @example Request syntax with placeholder values
896
+ #
897
+ # resp = client.stop_clock({
898
+ # simulation: "SimSpaceWeaverResourceName", # required
899
+ # })
900
+ #
901
+ # @see http://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StopClock AWS API Documentation
902
+ #
903
+ # @overload stop_clock(params = {})
904
+ # @param [Hash] params ({})
905
+ def stop_clock(params = {}, options = {})
906
+ req = build_request(:stop_clock, params)
907
+ req.send_request(options)
908
+ end
909
+
910
+ # Stops the given simulation.
911
+ #
912
+ # You can't restart a simulation after you stop it. If you need to
913
+ # restart a simulation, you must stop it, delete it, and start a new
914
+ # instance of it.
915
+ #
916
+ # @option params [required, String] :simulation
917
+ # The name of the simulation.
918
+ #
919
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
920
+ #
921
+ # @example Request syntax with placeholder values
922
+ #
923
+ # resp = client.stop_simulation({
924
+ # simulation: "SimSpaceWeaverResourceName", # required
925
+ # })
926
+ #
927
+ # @see http://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/StopSimulation AWS API Documentation
928
+ #
929
+ # @overload stop_simulation(params = {})
930
+ # @param [Hash] params ({})
931
+ def stop_simulation(params = {}, options = {})
932
+ req = build_request(:stop_simulation, params)
933
+ req.send_request(options)
934
+ end
935
+
936
+ # Adds tags to a SimSpace Weaver resource. For more information about
937
+ # tags, see [Tagging Amazon Web Services resources][1] in the *Amazon
938
+ # Web Services General Reference*.
939
+ #
940
+ #
941
+ #
942
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
943
+ #
944
+ # @option params [required, String] :resource_arn
945
+ # The Amazon Resource Name (ARN) of the resource that you want to add
946
+ # tags to. For more information about ARNs, see [Amazon Resource Names
947
+ # (ARNs)][1] in the *Amazon Web Services General Reference*.
948
+ #
949
+ #
950
+ #
951
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
952
+ #
953
+ # @option params [required, Hash<String,String>] :tags
954
+ # A list of tags to apply to the resource.
955
+ #
956
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
957
+ #
958
+ # @example Request syntax with placeholder values
959
+ #
960
+ # resp = client.tag_resource({
961
+ # resource_arn: "SimSpaceWeaverArn", # required
962
+ # tags: { # required
963
+ # "TagKey" => "TagValue",
964
+ # },
965
+ # })
966
+ #
967
+ # @see http://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/TagResource AWS API Documentation
968
+ #
969
+ # @overload tag_resource(params = {})
970
+ # @param [Hash] params ({})
971
+ def tag_resource(params = {}, options = {})
972
+ req = build_request(:tag_resource, params)
973
+ req.send_request(options)
974
+ end
975
+
976
+ # Removes tags from a SimSpace Weaver resource. For more information
977
+ # about tags, see [Tagging Amazon Web Services resources][1] in the
978
+ # *Amazon Web Services General Reference*.
979
+ #
980
+ #
981
+ #
982
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
983
+ #
984
+ # @option params [required, String] :resource_arn
985
+ # The Amazon Resource Name (ARN) of the resource that you want to remove
986
+ # tags from. For more information about ARNs, see [Amazon Resource Names
987
+ # (ARNs)][1] in the *Amazon Web Services General Reference*.
988
+ #
989
+ #
990
+ #
991
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
992
+ #
993
+ # @option params [required, Array<String>] :tag_keys
994
+ # A list of tag keys to remove from the resource.
995
+ #
996
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
997
+ #
998
+ # @example Request syntax with placeholder values
999
+ #
1000
+ # resp = client.untag_resource({
1001
+ # resource_arn: "SimSpaceWeaverArn", # required
1002
+ # tag_keys: ["TagKey"], # required
1003
+ # })
1004
+ #
1005
+ # @see http://docs.aws.amazon.com/goto/WebAPI/simspaceweaver-2022-10-28/UntagResource AWS API Documentation
1006
+ #
1007
+ # @overload untag_resource(params = {})
1008
+ # @param [Hash] params ({})
1009
+ def untag_resource(params = {}, options = {})
1010
+ req = build_request(:untag_resource, params)
1011
+ req.send_request(options)
1012
+ end
1013
+
1014
+ # @!endgroup
1015
+
1016
+ # @param params ({})
1017
+ # @api private
1018
+ def build_request(operation_name, params = {})
1019
+ handlers = @handlers.for(operation_name)
1020
+ context = Seahorse::Client::RequestContext.new(
1021
+ operation_name: operation_name,
1022
+ operation: config.api.operation(operation_name),
1023
+ client: self,
1024
+ params: params,
1025
+ config: config)
1026
+ context[:gem_name] = 'aws-sdk-simspaceweaver'
1027
+ context[:gem_version] = '1.0.0'
1028
+ Seahorse::Client::Request.new(handlers, context)
1029
+ end
1030
+
1031
+ # @api private
1032
+ # @deprecated
1033
+ def waiter_names
1034
+ []
1035
+ end
1036
+
1037
+ class << self
1038
+
1039
+ # @api private
1040
+ attr_reader :identifier
1041
+
1042
+ # @api private
1043
+ def errors_module
1044
+ Errors
1045
+ end
1046
+
1047
+ end
1048
+ end
1049
+ end