Class: Aws::SimSpaceWeaver::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::SimSpaceWeaver::EndpointProvider) —

    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`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 473

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1261
1262
1263
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 1261

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1264
1265
1266
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 1264

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 1234

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::SimSpaceWeaver')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-simspaceweaver'
  context[:gem_version] = '1.46.0'
  Seahorse::Client::Request.new(handlers, context)
end

#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 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

[1]: docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html

Examples:

Request syntax with placeholder values


resp = client.create_snapshot({
  destination: { # required
    bucket_name: "BucketName", # required
    object_key_prefix: "ObjectKeyPrefix",
  },
  simulation: "SimSpaceWeaverResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination (required, Types::S3Destination) —

    The Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates the snapshot file.

    The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.

  • :simulation (required, String) —

    The name of the simulation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



539
540
541
542
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 539

def create_snapshot(params = {}, options = {})
  req = build_request(:create_snapshot, params)
  req.send_request(options)
end

#delete_app(params = {}) ⇒ Struct

Deletes the instance of the given custom app.

Examples:

Request syntax with placeholder values


resp = client.delete_app({
  app: "SimSpaceWeaverResourceName", # required
  domain: "SimSpaceWeaverResourceName", # required
  simulation: "SimSpaceWeaverResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :app (required, String) —

    The name of the app.

  • :domain (required, String) —

    The name of the domain of the app.

  • :simulation (required, String) —

    The name of the simulation of the app.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



569
570
571
572
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 569

def delete_app(params = {}, options = {})
  req = build_request(:delete_app, params)
  req.send_request(options)
end

#delete_simulation(params = {}) ⇒ Struct

Deletes all SimSpace Weaver resources assigned to the given simulation.

<note markdown=“1”> Your simulation uses resources in other Amazon Web Services. This API operation doesn’t delete resources in other Amazon Web Services.

</note>

Examples:

Request syntax with placeholder values


resp = client.delete_simulation({
  simulation: "SimSpaceWeaverResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :simulation (required, String) —

    The name of the simulation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



597
598
599
600
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 597

def delete_simulation(params = {}, options = {})
  req = build_request(:delete_simulation, params)
  req.send_request(options)
end

#describe_app(params = {}) ⇒ Types::DescribeAppOutput

Returns the state of the given custom app.

Examples:

Request syntax with placeholder values


resp = client.describe_app({
  app: "SimSpaceWeaverLongResourceName", # required
  domain: "SimSpaceWeaverResourceName", # required
  simulation: "SimSpaceWeaverResourceName", # required
})

Response structure


resp.description #=> String
resp.domain #=> String
resp.endpoint_info.address #=> String
resp.endpoint_info.ingress_port_mappings #=> Array
resp.endpoint_info.ingress_port_mappings[0].actual #=> Integer
resp.endpoint_info.ingress_port_mappings[0].declared #=> Integer
resp.launch_overrides.launch_commands #=> Array
resp.launch_overrides.launch_commands[0] #=> String
resp.name #=> String
resp.simulation #=> String
resp.status #=> String, one of "STARTING", "STARTED", "STOPPING", "STOPPED", "ERROR", "UNKNOWN"
resp.target_status #=> String, one of "UNKNOWN", "STARTED", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :app (required, String) —

    The name of the app.

  • :domain (required, String) —

    The name of the domain of the app.

  • :simulation (required, String) —

    The name of the simulation of the app.

Returns:

See Also:



651
652
653
654
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 651

def describe_app(params = {}, options = {})
  req = build_request(:describe_app, params)
  req.send_request(options)
end

#describe_simulation(params = {}) ⇒ Types::DescribeSimulationOutput

Returns the current state of the given simulation.

Examples:

Request syntax with placeholder values


resp = client.describe_simulation({
  simulation: "SimSpaceWeaverResourceName", # required
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.description #=> String
resp.execution_id #=> String
resp.live_simulation_state.clocks #=> Array
resp.live_simulation_state.clocks[0].status #=> String, one of "UNKNOWN", "STARTING", "STARTED", "STOPPING", "STOPPED"
resp.live_simulation_state.clocks[0].target_status #=> String, one of "UNKNOWN", "STARTED", "STOPPED"
resp.live_simulation_state.domains #=> Array
resp.live_simulation_state.domains[0].lifecycle #=> String, one of "Unknown", "PerWorker", "BySpatialSubdivision", "ByRequest"
resp.live_simulation_state.domains[0].name #=> String
resp.logging_configuration.destinations #=> Array
resp.logging_configuration.destinations[0].cloud_watch_logs_log_group.log_group_arn #=> String
resp.maximum_duration #=> String
resp.name #=> String
resp.role_arn #=> String
resp.schema_error #=> String
resp.schema_s3_location.bucket_name #=> String
resp.schema_s3_location.object_key #=> String
resp.snapshot_s3_location.bucket_name #=> String
resp.snapshot_s3_location.object_key #=> String
resp.start_error #=> String
resp.status #=> String, one of "UNKNOWN", "STARTING", "STARTED", "STOPPING", "STOPPED", "FAILED", "DELETING", "DELETED", "SNAPSHOT_IN_PROGRESS"
resp.target_status #=> String, one of "UNKNOWN", "STARTED", "STOPPED", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :simulation (required, String) —

    The name of the simulation.

Returns:

See Also:



715
716
717
718
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 715

def describe_simulation(params = {}, options = {})
  req = build_request(:describe_simulation, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_apps({
  domain: "SimSpaceWeaverResourceName",
  max_results: 1,
  next_token: "OptionalString",
  simulation: "SimSpaceWeaverResourceName", # required
})

Response structure


resp.apps #=> Array
resp.apps[0].domain #=> String
resp.apps[0].name #=> String
resp.apps[0].simulation #=> String
resp.apps[0].status #=> String, one of "STARTING", "STARTED", "STOPPING", "STOPPED", "ERROR", "UNKNOWN"
resp.apps[0].target_status #=> String, one of "UNKNOWN", "STARTED", "STOPPED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain (String) —

    The name of the domain that you want to list apps for.

  • :max_results (Integer) —

    The maximum number of apps to list.

  • :next_token (String) —

    If SimSpace Weaver returns ‘nextToken`, then there are more results available. The value of `nextToken` is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then `nextToken` is set to `null`. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an *HTTP 400 ValidationException* error.

  • :simulation (required, String) —

    The name of the simulation that you want to list apps for.

Returns:

See Also:



771
772
773
774
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 771

def list_apps(params = {}, options = {})
  req = build_request(:list_apps, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_simulations({
  max_results: 1,
  next_token: "OptionalString",
})

Response structure


resp.next_token #=> String
resp.simulations #=> Array
resp.simulations[0].arn #=> String
resp.simulations[0].creation_time #=> Time
resp.simulations[0].name #=> String
resp.simulations[0].status #=> String, one of "UNKNOWN", "STARTING", "STARTED", "STOPPING", "STOPPED", "FAILED", "DELETING", "DELETED", "SNAPSHOT_IN_PROGRESS"
resp.simulations[0].target_status #=> String, one of "UNKNOWN", "STARTED", "STOPPED", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of simulations to list.

  • :next_token (String) —

    If SimSpace Weaver returns ‘nextToken`, then there are more results available. The value of `nextToken` is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then `nextToken` is set to `null`. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an *HTTP 400 ValidationException* error.

Returns:

See Also:



819
820
821
822
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 819

def list_simulations(params = {}, options = {})
  req = build_request(:list_simulations, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

Lists all tags on a SimSpace Weaver resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "SimSpaceWeaverArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



854
855
856
857
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 854

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#start_app(params = {}) ⇒ Types::StartAppOutput

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

Examples:

Request syntax with placeholder values


resp = client.start_app({
  client_token: "ClientToken",
  description: "Description",
  domain: "SimSpaceWeaverResourceName", # required
  launch_overrides: {
    launch_commands: ["NonEmptyString"],
  },
  name: "SimSpaceWeaverResourceName", # required
  simulation: "SimSpaceWeaverResourceName", # required
})

Response structure


resp.domain #=> String
resp.name #=> String
resp.simulation #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A ‘ClientToken` is also known as an *idempotency token*. A `ClientToken` expires after 24 hours.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :description (String) —

    The description of the app.

  • :domain (required, String) —

    The name of the domain of the app.

  • :launch_overrides (Types::LaunchOverrides) —

    Options that apply when the app starts. These options override default behavior.

  • :name (required, String) —

    The name of the app.

  • :simulation (required, String) —

    The name of the simulation of the app.

Returns:

See Also:



916
917
918
919
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 916

def start_app(params = {}, options = {})
  req = build_request(:start_app, params)
  req.send_request(options)
end

#start_clock(params = {}) ⇒ Struct

Starts the simulation clock.

Examples:

Request syntax with placeholder values


resp = client.start_clock({
  simulation: "SimSpaceWeaverResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :simulation (required, String) —

    The name of the simulation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



938
939
940
941
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 938

def start_clock(params = {}, options = {})
  req = build_request(:start_clock, params)
  req.send_request(options)
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][2

in the *SimSpace Weaver User Guide*.

[1]: docs.aws.amazon.com/simspaceweaver/latest/userguide/schema-reference.html [2]: docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html

Examples:

Request syntax with placeholder values


resp = client.start_simulation({
  client_token: "ClientToken",
  description: "Description",
  maximum_duration: "TimeToLiveString",
  name: "SimSpaceWeaverResourceName", # required
  role_arn: "RoleArn", # required
  schema_s3_location: {
    bucket_name: "BucketName", # required
    object_key: "ObjectKey", # required
  },
  snapshot_s3_location: {
    bucket_name: "BucketName", # required
    object_key: "ObjectKey", # required
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.creation_time #=> Time
resp.execution_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A ‘ClientToken` is also known as an *idempotency token*. A `ClientToken` expires after 24 hours.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :description (String) —

    The description of the simulation.

  • :maximum_duration (String) —

    The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches this limit. The maximum value is ‘14D`, or its equivalent in the other units. The default value is `14D`. A value equivalent to `0` makes the simulation immediately transition to `Stopping` as soon as it reaches `Started`.

  • :name (required, String) —

    The name of the simulation.

  • :role_arn (required, String) —

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to perform actions. For more information about ARNs, see [Amazon Resource Names (ARNs)] in the *Amazon Web Services General Reference*. For more information about IAM roles, see [IAM roles] in the *Identity and Access Management User Guide*.

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html

  • :schema_s3_location (Types::S3Location) —

    The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the [ *Amazon Simple Storage Service User Guide* ][1].

    Provide a ‘SchemaS3Location` to start your simulation from a schema.

    If you provide a ‘SchemaS3Location` then you can’t provide a ‘SnapshotS3Location`.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html

  • :snapshot_s3_location (Types::S3Location) —

    The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the [ *Amazon Simple Storage Service User Guide* ][1].

    Provide a ‘SnapshotS3Location` to start your simulation from a snapshot.

    The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.

    If you provide a ‘SnapshotS3Location` then you can’t provide a ‘SchemaS3Location`.

    [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html

  • :tags (Hash<String,String>) —

    A list of tags for the simulation. For more information about tags, see [Tagging Amazon Web Services resources] in the *Amazon Web Services General Reference*.

    [1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

See Also:



1068
1069
1070
1071
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 1068

def start_simulation(params = {}, options = {})
  req = build_request(:start_simulation, params)
  req.send_request(options)
end

#stop_app(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.stop_app({
  app: "SimSpaceWeaverResourceName", # required
  domain: "SimSpaceWeaverResourceName", # required
  simulation: "SimSpaceWeaverResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :app (required, String) —

    The name of the app.

  • :domain (required, String) —

    The name of the domain of the app.

  • :simulation (required, String) —

    The name of the simulation of the app.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1099
1100
1101
1102
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 1099

def stop_app(params = {}, options = {})
  req = build_request(:stop_app, params)
  req.send_request(options)
end

#stop_clock(params = {}) ⇒ Struct

Stops the simulation clock.

Examples:

Request syntax with placeholder values


resp = client.stop_clock({
  simulation: "SimSpaceWeaverResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :simulation (required, String) —

    The name of the simulation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1121
1122
1123
1124
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 1121

def stop_clock(params = {}, options = {})
  req = build_request(:stop_clock, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.stop_simulation({
  simulation: "SimSpaceWeaverResourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :simulation (required, String) —

    The name of the simulation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1147
1148
1149
1150
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 1147

def stop_simulation(params = {}, options = {})
  req = build_request(:stop_simulation, params)
  req.send_request(options)
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*.

[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "SimSpaceWeaverArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to add tags to. For more information about ARNs, see [Amazon Resource Names (ARNs)] in the *Amazon Web Services General Reference*.

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :tags (required, Hash<String,String>) —

    A list of tags to apply to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1187
1188
1189
1190
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 1187

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
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*.

[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "SimSpaceWeaverArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to remove tags from. For more information about ARNs, see [Amazon Resource Names (ARNs)] in the *Amazon Web Services General Reference*.

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :tag_keys (required, Array<String>) —

    A list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1225
1226
1227
1228
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 1225

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1254
1255
1256
 
# File 'lib/aws-sdk-simspaceweaver/client.rb', line 1254

def waiter_names
  []
end