Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RobOMaker.Types.SimulationJobRequest

Description

Synopsis

data SimulationJobRequest = SimulationJobRequest' {
- compute :: Maybe Compute
- dataSources :: Maybe (NonEmpty DataSourceConfig)
- failureBehavior :: Maybe FailureBehavior
- iamRole :: Maybe Text
- loggingConfig :: Maybe LoggingConfig
- outputLocation :: Maybe OutputLocation
- robotApplications :: Maybe (NonEmpty RobotApplicationConfig)
- simulationApplications :: Maybe (NonEmpty SimulationApplicationConfig)
- tags :: Maybe (HashMap Text Text)
- useDefaultApplications :: Maybe Bool
- vpcConfig :: Maybe VPCConfig
- maxJobDurationInSeconds :: Integer
}
newSimulationJobRequest :: Integer -> SimulationJobRequest
simulationJobRequest_compute :: Lens' SimulationJobRequest (Maybe Compute)
simulationJobRequest_dataSources :: Lens' SimulationJobRequest (Maybe (NonEmpty DataSourceConfig))
simulationJobRequest_failureBehavior :: Lens' SimulationJobRequest (Maybe FailureBehavior)
simulationJobRequest_iamRole :: Lens' SimulationJobRequest (Maybe Text)
simulationJobRequest_loggingConfig :: Lens' SimulationJobRequest (Maybe LoggingConfig)
simulationJobRequest_outputLocation :: Lens' SimulationJobRequest (Maybe OutputLocation)
simulationJobRequest_robotApplications :: Lens' SimulationJobRequest (Maybe (NonEmpty RobotApplicationConfig))
simulationJobRequest_simulationApplications :: Lens' SimulationJobRequest (Maybe (NonEmpty SimulationApplicationConfig))
simulationJobRequest_tags :: Lens' SimulationJobRequest (Maybe (HashMap Text Text))
simulationJobRequest_useDefaultApplications :: Lens' SimulationJobRequest (Maybe Bool)
simulationJobRequest_vpcConfig :: Lens' SimulationJobRequest (Maybe VPCConfig)
simulationJobRequest_maxJobDurationInSeconds :: Lens' SimulationJobRequest Integer

Documentation

data SimulationJobRequest Source #

Information about a simulation job request.

See: newSimulationJobRequest smart constructor.

Constructors

SimulationJobRequest'

Fields

compute :: Maybe Compute
Compute information for the simulation job
dataSources :: Maybe (NonEmpty DataSourceConfig)
Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.
There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.
failureBehavior :: Maybe FailureBehavior
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.
iamRole :: Maybe Text
The IAM role name 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.
loggingConfig :: Maybe LoggingConfig
outputLocation :: Maybe OutputLocation
robotApplications :: Maybe (NonEmpty RobotApplicationConfig)
The robot applications to use in the simulation job.
simulationApplications :: Maybe (NonEmpty SimulationApplicationConfig)
The simulation applications to use in the simulation job.
tags :: Maybe (HashMap Text Text)
A map that contains tag keys and tag values that are attached to the simulation job request.
useDefaultApplications :: Maybe Bool
A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
vpcConfig :: Maybe VPCConfig
maxJobDurationInSeconds :: Integer
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

Instances

Instances details

FromJSON SimulationJobRequest Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJobRequest Methods parseJSON :: Value -> Parser SimulationJobRequest # parseJSONList :: Value -> Parser [SimulationJobRequest] #
ToJSON SimulationJobRequest Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJobRequest Methods toJSON :: SimulationJobRequest -> Value # toEncoding :: SimulationJobRequest -> Encoding # toJSONList :: [SimulationJobRequest] -> Value # toEncodingList :: [SimulationJobRequest] -> Encoding #
Generic SimulationJobRequest Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJobRequest Associated Types type Rep SimulationJobRequest :: Type -> Type # Methods from :: SimulationJobRequest -> Rep SimulationJobRequest x # to :: Rep SimulationJobRequest x -> SimulationJobRequest #
Read SimulationJobRequest Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJobRequest Methods readsPrec :: Int -> ReadS SimulationJobRequest # readList :: ReadS [SimulationJobRequest] # readPrec :: ReadPrec SimulationJobRequest # readListPrec :: ReadPrec [SimulationJobRequest] #
Show SimulationJobRequest Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJobRequest Methods showsPrec :: Int -> SimulationJobRequest -> ShowS # show :: SimulationJobRequest -> String # showList :: [SimulationJobRequest] -> ShowS #
NFData SimulationJobRequest Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJobRequest Methods rnf :: SimulationJobRequest -> () #
Eq SimulationJobRequest Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJobRequest Methods (==) :: SimulationJobRequest -> SimulationJobRequest -> Bool # (/=) :: SimulationJobRequest -> SimulationJobRequest -> Bool #
Hashable SimulationJobRequest Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJobRequest Methods hashWithSalt :: Int -> SimulationJobRequest -> Int # hash :: SimulationJobRequest -> Int #
type Rep SimulationJobRequest Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJobRequest type Rep SimulationJobRequest = D1 ('MetaData "SimulationJobRequest" "Amazonka.RobOMaker.Types.SimulationJobRequest" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "SimulationJobRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "compute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Compute)) :: (S1 ('MetaSel ('Just "dataSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceConfig))) :: S1 ('MetaSel ('Just "failureBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailureBehavior)))) :: (S1 ('MetaSel ('Just "iamRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "loggingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfig)) :: S1 ('MetaSel ('Just "outputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputLocation))))) :: ((S1 ('MetaSel ('Just "robotApplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty RobotApplicationConfig))) :: (S1 ('MetaSel ('Just "simulationApplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SimulationApplicationConfig))) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: (S1 ('MetaSel ('Just "useDefaultApplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VPCConfig)) :*: S1 ('MetaSel ('Just "maxJobDurationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))))))

newSimulationJobRequest Source #

Arguments

:: Integer	`$sel:maxJobDurationInSeconds:SimulationJobRequest'`
-> SimulationJobRequest

Create a value of SimulationJobRequest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:compute:SimulationJobRequest', simulationJobRequest_compute - Compute information for the simulation job

$sel:dataSources:SimulationJobRequest', simulationJobRequest_dataSources - Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

$sel:failureBehavior:SimulationJobRequest', simulationJobRequest_failureBehavior - 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.

$sel:iamRole:SimulationJobRequest', simulationJobRequest_iamRole - The IAM role name 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.

$sel:loggingConfig:SimulationJobRequest', simulationJobRequest_loggingConfig - Undocumented member.

$sel:outputLocation:SimulationJobRequest', simulationJobRequest_outputLocation - Undocumented member.

$sel:robotApplications:SimulationJobRequest', simulationJobRequest_robotApplications - The robot applications to use in the simulation job.

$sel:simulationApplications:SimulationJobRequest', simulationJobRequest_simulationApplications - The simulation applications to use in the simulation job.

$sel:tags:SimulationJobRequest', simulationJobRequest_tags - A map that contains tag keys and tag values that are attached to the simulation job request.

$sel:useDefaultApplications:SimulationJobRequest', simulationJobRequest_useDefaultApplications - A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.

$sel:vpcConfig:SimulationJobRequest', simulationJobRequest_vpcConfig - Undocumented member.

$sel:maxJobDurationInSeconds:SimulationJobRequest', simulationJobRequest_maxJobDurationInSeconds - The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

simulationJobRequest_compute :: Lens' SimulationJobRequest (Maybe Compute) Source #

Compute information for the simulation job

simulationJobRequest_dataSources :: Lens' SimulationJobRequest (Maybe (NonEmpty DataSourceConfig)) Source #

Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

simulationJobRequest_failureBehavior :: Lens' SimulationJobRequest (Maybe FailureBehavior) Source #

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.

simulationJobRequest_iamRole :: Lens' SimulationJobRequest (Maybe Text) Source #

The IAM role name 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.

simulationJobRequest_loggingConfig :: Lens' SimulationJobRequest (Maybe LoggingConfig) Source #

Undocumented member.

simulationJobRequest_outputLocation :: Lens' SimulationJobRequest (Maybe OutputLocation) Source #

Undocumented member.

simulationJobRequest_robotApplications :: Lens' SimulationJobRequest (Maybe (NonEmpty RobotApplicationConfig)) Source #

The robot applications to use in the simulation job.

simulationJobRequest_simulationApplications :: Lens' SimulationJobRequest (Maybe (NonEmpty SimulationApplicationConfig)) Source #

The simulation applications to use in the simulation job.

simulationJobRequest_tags :: Lens' SimulationJobRequest (Maybe (HashMap Text Text)) Source #

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

simulationJobRequest_useDefaultApplications :: Lens' SimulationJobRequest (Maybe Bool) Source #

A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.

simulationJobRequest_vpcConfig :: Lens' SimulationJobRequest (Maybe VPCConfig) Source #

Undocumented member.

simulationJobRequest_maxJobDurationInSeconds :: Lens' SimulationJobRequest Integer Source #

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