libZSservicesZSamazonka-robomakerZSamazonka-robomaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.RobOMaker.Types.SimulationJobRequest

Description

 
Synopsis

Documentation

data SimulationJobRequest Source #

Information about a simulation job request.

See: newSimulationJobRequest smart constructor.

Constructors

SimulationJobRequest' 

Fields

Instances

Instances details
Eq SimulationJobRequest Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationJobRequest

Read SimulationJobRequest Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationJobRequest

Show SimulationJobRequest Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationJobRequest

Generic SimulationJobRequest Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationJobRequest

Associated Types

type Rep SimulationJobRequest :: Type -> Type #

NFData SimulationJobRequest Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationJobRequest

Methods

rnf :: SimulationJobRequest -> () #

Hashable SimulationJobRequest Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationJobRequest

ToJSON SimulationJobRequest Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationJobRequest

FromJSON SimulationJobRequest Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationJobRequest

type Rep SimulationJobRequest Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationJobRequest

type Rep SimulationJobRequest = D1 ('MetaData "SimulationJobRequest" "Amazonka.RobOMaker.Types.SimulationJobRequest" "libZSservicesZSamazonka-robomakerZSamazonka-robomaker" 'False) (C1 ('MetaCons "SimulationJobRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "failureBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailureBehavior)) :*: (S1 ('MetaSel ('Just "robotApplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty RobotApplicationConfig))) :*: S1 ('MetaSel ('Just "compute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Compute)))) :*: (S1 ('MetaSel ('Just "dataSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceConfig))) :*: (S1 ('MetaSel ('Just "useDefaultApplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VPCConfig))))) :*: ((S1 ('MetaSel ('Just "outputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputLocation)) :*: (S1 ('MetaSel ('Just "simulationApplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SimulationApplicationConfig))) :*: S1 ('MetaSel ('Just "loggingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfig)))) :*: (S1 ('MetaSel ('Just "iamRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "maxJobDurationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))))))

newSimulationJobRequest Source #

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: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:robotApplications:SimulationJobRequest', simulationJobRequest_robotApplications - The robot applications to use in the simulation job.

$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: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:outputLocation:SimulationJobRequest', simulationJobRequest_outputLocation - Undocumented member.

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

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

$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:tags:SimulationJobRequest', simulationJobRequest_tags - A map that contains tag keys and tag values that are attached to the simulation job request.

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

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_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_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_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_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_maxJobDurationInSeconds :: Lens' SimulationJobRequest Integer Source #

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