Struct Client 

pub struct Client { /* private fields */ }

Client for AWS SimSpace Weaver

Client for invoking operations on AWS SimSpace Weaver. Each operation on AWS SimSpace Weaver is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_simspaceweaver::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_simspaceweaver::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateSnapshot operation has a Client::create_snapshot, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_snapshot()
    .simulation("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_snapshot(&self) -> CreateSnapshotFluentBuilder

Constructs a fluent builder for the CreateSnapshot operation.

• The fluent builder is configurable:
  • simulation(impl Into<String>) / set_simulation(Option<String>):
    required: true
    

    The name of the simulation.

    
    
  • destination(S3Destination) / set_destination(Option<S3Destination>):
    required: true
    

    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.

    
    
• On success, responds with CreateSnapshotOutput
• On failure, responds with SdkError<CreateSnapshotError>

impl Client

pub fn delete_app(&self) -> DeleteAppFluentBuilder

Constructs a fluent builder for the DeleteApp operation.

• The fluent builder is configurable:
  • simulation(impl Into<String>) / set_simulation(Option<String>):
    required: true
    

    The name of the simulation of the app.

    
    
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain of the app.

    
    
  • app(impl Into<String>) / set_app(Option<String>):
    required: true
    

    The name of the app.

    
    
• On success, responds with DeleteAppOutput
• On failure, responds with SdkError<DeleteAppError>

impl Client

pub fn delete_simulation(&self) -> DeleteSimulationFluentBuilder

Constructs a fluent builder for the DeleteSimulation operation.

• The fluent builder is configurable:
  • simulation(impl Into<String>) / set_simulation(Option<String>):
    required: true
    

    The name of the simulation.

    
    
• On success, responds with DeleteSimulationOutput
• On failure, responds with SdkError<DeleteSimulationError>

impl Client

pub fn describe_app(&self) -> DescribeAppFluentBuilder

Constructs a fluent builder for the DescribeApp operation.

• The fluent builder is configurable:
  • simulation(impl Into<String>) / set_simulation(Option<String>):
    required: true
    

    The name of the simulation of the app.

    
    
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain of the app.

    
    
  • app(impl Into<String>) / set_app(Option<String>):
    required: true
    

    The name of the app.

    
    
• On success, responds with DescribeAppOutput with field(s):
  • name(Option<String>):

    The name of the app.

  • simulation(Option<String>):

    The name of the simulation of the app.

  • domain(Option<String>):

    The name of the domain of the app.

  • status(Option<SimulationAppStatus>):

    The current lifecycle state of the custom app.

  • target_status(Option<SimulationAppTargetStatus>):

    The desired lifecycle state of the custom app.

  • launch_overrides(Option<LaunchOverrides>):

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

  • description(Option<String>):

    The description of the app.

  • endpoint_info(Option<SimulationAppEndpointInfo>):

    Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.

• On failure, responds with SdkError<DescribeAppError>

impl Client

pub fn describe_simulation(&self) -> DescribeSimulationFluentBuilder

Constructs a fluent builder for the DescribeSimulation operation.

• The fluent builder is configurable:
  • simulation(impl Into<String>) / set_simulation(Option<String>):
    required: true
    

    The name of the simulation.

    
    
• On success, responds with DescribeSimulationOutput with field(s):
  • name(Option<String>):

    The name of the simulation.

  • execution_id(Option<String>):

    A universally unique identifier (UUID) for this simulation.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

  • description(Option<String>):

    The description of the simulation.

  • role_arn(Option<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.

  • creation_time(Option<DateTime>):

    The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

  • status(Option<SimulationStatus>):

    The current lifecycle state of the simulation.

  • target_status(Option<SimulationTargetStatus>):

    The desired lifecycle state of the simulation.

  • schema_s3_location(Option<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 .

  • schema_error(Option<String>):

    An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.

  • logging_configuration(Option<LoggingConfiguration>):

    Settings that control how SimSpace Weaver handles your simulation log data.

  • live_simulation_state(Option<LiveSimulationState>):

    A collection of additional state information, such as domain and clock configuration.

  • maximum_duration(Option<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.

  • snapshot_s3_location(Option<S3Location>):

    A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app .zip files and schema file. For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .

  • start_error(Option<String>):

    An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the STARTING state.

• On failure, responds with SdkError<DescribeSimulationError>

impl Client

pub fn list_apps(&self) -> ListAppsFluentBuilder

Constructs a fluent builder for the ListApps operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • simulation(impl Into<String>) / set_simulation(Option<String>):
    required: true
    

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

    
    
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of apps to list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListAppsOutput with field(s):
  • apps(Option<Vec::<SimulationAppMetadata>>):

    The list of apps for the given simulation and domain.

  • next_token(Option<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.

• On failure, responds with SdkError<ListAppsError>

impl Client

pub fn list_simulations(&self) -> ListSimulationsFluentBuilder

Constructs a fluent builder for the ListSimulations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of simulations to list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListSimulationsOutput with field(s):
  • simulations(Option<Vec::<SimulationMetadata>>):

    The list of simulations.

  • next_token(Option<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.

• On failure, responds with SdkError<ListSimulationsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The list of tags for the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn start_app(&self) -> StartAppFluentBuilder

Constructs a fluent builder for the StartApp operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
  • simulation(impl Into<String>) / set_simulation(Option<String>):
    required: true
    

    The name of the simulation of the app.

    
    
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain of the app.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the app.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the app.

    
    
  • launch_overrides(LaunchOverrides) / set_launch_overrides(Option<LaunchOverrides>):
    required: false
    

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

    
    
• On success, responds with StartAppOutput with field(s):
  • name(Option<String>):

    The name of the app.

  • domain(Option<String>):

    The name of the domain of the app.

  • simulation(Option<String>):

    The name of the simulation of the app.

• On failure, responds with SdkError<StartAppError>

impl Client

pub fn start_clock(&self) -> StartClockFluentBuilder

Constructs a fluent builder for the StartClock operation.

• The fluent builder is configurable:
  • simulation(impl Into<String>) / set_simulation(Option<String>):
    required: true
    

    The name of the simulation.

    
    
• On success, responds with StartClockOutput
• On failure, responds with SdkError<StartClockError>

impl Client

pub fn start_simulation(&self) -> StartSimulationFluentBuilder

Constructs a fluent builder for the StartSimulation operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the simulation.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the simulation.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    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.

    
    
  • schema_s3_location(S3Location) / set_schema_s3_location(Option<S3Location>):
    required: false
    

    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 .

    Provide a SchemaS3Location to start your simulation from a schema.

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

    
    
  • maximum_duration(impl Into<String>) / set_maximum_duration(Option<String>):
    required: false
    

    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.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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.

    
    
  • snapshot_s3_location(S3Location) / set_snapshot_s3_location(Option<S3Location>):
    required: false
    

    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 .

    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.

    
    
• On success, responds with StartSimulationOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

  • execution_id(Option<String>):

    A universally unique identifier (UUID) for this simulation.

  • creation_time(Option<DateTime>):

    The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

• On failure, responds with SdkError<StartSimulationError>

impl Client

pub fn stop_app(&self) -> StopAppFluentBuilder

Constructs a fluent builder for the StopApp operation.

• The fluent builder is configurable:
  • simulation(impl Into<String>) / set_simulation(Option<String>):
    required: true
    

    The name of the simulation of the app.

    
    
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The name of the domain of the app.

    
    
  • app(impl Into<String>) / set_app(Option<String>):
    required: true
    

    The name of the app.

    
    
• On success, responds with StopAppOutput
• On failure, responds with SdkError<StopAppError>

impl Client

pub fn stop_clock(&self) -> StopClockFluentBuilder

Constructs a fluent builder for the StopClock operation.

• The fluent builder is configurable:
  • simulation(impl Into<String>) / set_simulation(Option<String>):
    required: true
    

    The name of the simulation.

    
    
• On success, responds with StopClockOutput
• On failure, responds with SdkError<StopClockError>

impl Client

pub fn stop_simulation(&self) -> StopSimulationFluentBuilder

Constructs a fluent builder for the StopSimulation operation.

• The fluent builder is configurable:
  • simulation(impl Into<String>) / set_simulation(Option<String>):
    required: true
    

    The name of the simulation.

    
    
• On success, responds with StopSimulationOutput
• On failure, responds with SdkError<StopSimulationError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    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.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    A list of tags to apply to the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    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.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    A list of tag keys to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.