Class: Aws::RoboMaker::Types::SimulationJob

Inherits:

Struct

• Object
• Struct
• Aws::RoboMaker::Types::SimulationJob

Defined in:

gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb

Overview

Information about a simulation job.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the simulation job.

• #client_request_token ⇒ String

  A unique identifier for this SimulationJob request.

• #compute ⇒ Types::ComputeResponse

  Compute information for the simulation job.

• #data_sources ⇒ Array<Types::DataSource>

  The data sources for the simulation job.

• #failure_behavior ⇒ String

  The failure behavior the simulation job.

• #failure_code ⇒ String

  The failure code of the simulation job if it failed.

• #failure_reason ⇒ String

  The reason why the simulation job failed.

• #iam_role ⇒ String

  The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.

• #last_started_at ⇒ Time

  The time, in milliseconds since the epoch, when the simulation job was last started.

• #last_updated_at ⇒ Time

  The time, in milliseconds since the epoch, when the simulation job was last updated.

• #logging_config ⇒ Types::LoggingConfig

  The logging configuration.

• #max_job_duration_in_seconds ⇒ Integer

  The maximum simulation job duration in seconds.

• #name ⇒ String

  The name of the simulation job.

• #network_interface ⇒ Types::NetworkInterface

  Information about a network interface.

• #output_location ⇒ Types::OutputLocation

  Location for output files generated by the simulation job.

• #robot_applications ⇒ Array<Types::RobotApplicationConfig>

  A list of robot applications.

• #simulation_applications ⇒ Array<Types::SimulationApplicationConfig>

  A list of simulation applications.

• #simulation_time_millis ⇒ Integer

  The simulation job execution duration in milliseconds.

• #status ⇒ String

  Status of the simulation job.

• #tags ⇒ Hash<String,String>

  A map that contains tag keys and tag values that are attached to the simulation job.

• #vpc_config ⇒ Types::VPCConfigResponse

  VPC configuration information.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the simulation job.

Returns:

• (String)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ String

A unique identifier for this SimulationJob request.

Returns:

• (String)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#compute ⇒ Types::ComputeResponse

Compute information for the simulation job

Returns:

• (Types::ComputeResponse)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#data_sources ⇒ Array<Types::DataSource>

The data sources for the simulation job.

Returns:

• (Array<Types::DataSource>)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#failure_behavior ⇒ String

The failure behavior the simulation job.

Continue

Leaves the host running for its maximum timeout duration after a 4XX error code.

Fail

Stop the simulation job and terminate the instance.

Returns:

• (String)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#failure_code ⇒ String

The failure code of the simulation job if it failed.

Returns:

• (String)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

The reason why the simulation job failed.

Returns:

• (String)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role ⇒ String

The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.

Returns:

• (String)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#last_started_at ⇒ Time

The time, in milliseconds since the epoch, when the simulation job was last started.

Returns:

• (Time)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_at ⇒ Time

The time, in milliseconds since the epoch, when the simulation job was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#logging_config ⇒ Types::LoggingConfig

The logging configuration.

Returns:

• (Types::LoggingConfig)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#max_job_duration_in_seconds ⇒ Integer

The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

Returns:

• (Integer)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the simulation job.

Returns:

• (String)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#network_interface ⇒ Types::NetworkInterface

Information about a network interface.

Returns:

• (Types::NetworkInterface)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#output_location ⇒ Types::OutputLocation

Location for output files generated by the simulation job.

Returns:

• (Types::OutputLocation)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#robot_applications ⇒ Array<Types::RobotApplicationConfig>

A list of robot applications.

Returns:

• (Array<Types::RobotApplicationConfig>)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#simulation_applications ⇒ Array<Types::SimulationApplicationConfig>

A list of simulation applications.

Returns:

• (Array<Types::SimulationApplicationConfig>)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#simulation_time_millis ⇒ Integer

The simulation job execution duration in milliseconds.

Returns:

• (Integer)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Status of the simulation job.

Returns:

• (String)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A map that contains tag keys and tag values that are attached to the simulation job.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ Types::VPCConfigResponse

VPC configuration information.

Returns:

• (Types::VPCConfigResponse)

# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4624

class SimulationJob < Struct.new(
  :arn,
  :name,
  :status,
  :last_started_at,
  :last_updated_at,
  :failure_behavior,
  :failure_code,
  :failure_reason,
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :simulation_time_millis,
  :iam_role,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :network_interface,
  :compute)
  SENSITIVE = []
  include Aws::Structure
end