Class: Aws::SimSpaceWeaver::Types::DescribeSimulationOutput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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.

Returns:

  • (String)


317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 317

class DescribeSimulationOutput < Struct.new(
  :arn,
  :creation_time,
  :description,
  :execution_id,
  :live_simulation_state,
  :logging_configuration,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_error,
  :schema_s3_location,
  :snapshot_s3_location,
  :start_error,
  :status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

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

Returns:

  • (Time)


317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 317

class DescribeSimulationOutput < Struct.new(
  :arn,
  :creation_time,
  :description,
  :execution_id,
  :live_simulation_state,
  :logging_configuration,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_error,
  :schema_s3_location,
  :snapshot_s3_location,
  :start_error,
  :status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the simulation.

Returns:

  • (String)


317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 317

class DescribeSimulationOutput < Struct.new(
  :arn,
  :creation_time,
  :description,
  :execution_id,
  :live_simulation_state,
  :logging_configuration,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_error,
  :schema_s3_location,
  :snapshot_s3_location,
  :start_error,
  :status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#execution_idString

A universally unique identifier (UUID) for this simulation.

Returns:

  • (String)


317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 317

class DescribeSimulationOutput < Struct.new(
  :arn,
  :creation_time,
  :description,
  :execution_id,
  :live_simulation_state,
  :logging_configuration,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_error,
  :schema_s3_location,
  :snapshot_s3_location,
  :start_error,
  :status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#live_simulation_stateTypes::LiveSimulationState

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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 317

class DescribeSimulationOutput < Struct.new(
  :arn,
  :creation_time,
  :description,
  :execution_id,
  :live_simulation_state,
  :logging_configuration,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_error,
  :schema_s3_location,
  :snapshot_s3_location,
  :start_error,
  :status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#logging_configurationTypes::LoggingConfiguration

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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 317

class DescribeSimulationOutput < Struct.new(
  :arn,
  :creation_time,
  :description,
  :execution_id,
  :live_simulation_state,
  :logging_configuration,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_error,
  :schema_s3_location,
  :snapshot_s3_location,
  :start_error,
  :status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_durationString

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.

Returns:

  • (String)


317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 317

class DescribeSimulationOutput < Struct.new(
  :arn,
  :creation_time,
  :description,
  :execution_id,
  :live_simulation_state,
  :logging_configuration,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_error,
  :schema_s3_location,
  :snapshot_s3_location,
  :start_error,
  :status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the simulation.

Returns:

  • (String)


317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 317

class DescribeSimulationOutput < Struct.new(
  :arn,
  :creation_time,
  :description,
  :execution_id,
  :live_simulation_state,
  :logging_configuration,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_error,
  :schema_s3_location,
  :snapshot_s3_location,
  :start_error,
  :status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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.

Returns:

  • (String)


317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 317

class DescribeSimulationOutput < Struct.new(
  :arn,
  :creation_time,
  :description,
  :execution_id,
  :live_simulation_state,
  :logging_configuration,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_error,
  :schema_s3_location,
  :snapshot_s3_location,
  :start_error,
  :status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#schema_errorString

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

Returns:

  • (String)


317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 317

class DescribeSimulationOutput < Struct.new(
  :arn,
  :creation_time,
  :description,
  :execution_id,
  :live_simulation_state,
  :logging_configuration,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_error,
  :schema_s3_location,
  :snapshot_s3_location,
  :start_error,
  :status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#schema_s3_locationTypes::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 .

Returns:



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 317

class DescribeSimulationOutput < Struct.new(
  :arn,
  :creation_time,
  :description,
  :execution_id,
  :live_simulation_state,
  :logging_configuration,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_error,
  :schema_s3_location,
  :snapshot_s3_location,
  :start_error,
  :status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_s3_locationTypes::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 .

Returns:



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 317

class DescribeSimulationOutput < Struct.new(
  :arn,
  :creation_time,
  :description,
  :execution_id,
  :live_simulation_state,
  :logging_configuration,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_error,
  :schema_s3_location,
  :snapshot_s3_location,
  :start_error,
  :status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#start_errorString

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

Returns:

  • (String)


317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 317

class DescribeSimulationOutput < Struct.new(
  :arn,
  :creation_time,
  :description,
  :execution_id,
  :live_simulation_state,
  :logging_configuration,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_error,
  :schema_s3_location,
  :snapshot_s3_location,
  :start_error,
  :status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current lifecycle state of the simulation.

Returns:

  • (String)


317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 317

class DescribeSimulationOutput < Struct.new(
  :arn,
  :creation_time,
  :description,
  :execution_id,
  :live_simulation_state,
  :logging_configuration,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_error,
  :schema_s3_location,
  :snapshot_s3_location,
  :start_error,
  :status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#target_statusString

The desired lifecycle state of the simulation.

Returns:

  • (String)


317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 317

class DescribeSimulationOutput < Struct.new(
  :arn,
  :creation_time,
  :description,
  :execution_id,
  :live_simulation_state,
  :logging_configuration,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_error,
  :schema_s3_location,
  :snapshot_s3_location,
  :start_error,
  :status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end