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

Description

Synopsis

data SimulationJob = SimulationJob' {
- arn :: Maybe Text
- clientRequestToken :: Maybe Text
- compute :: Maybe ComputeResponse
- dataSources :: Maybe [DataSource]
- failureBehavior :: Maybe FailureBehavior
- failureCode :: Maybe SimulationJobErrorCode
- failureReason :: Maybe Text
- iamRole :: Maybe Text
- lastStartedAt :: Maybe POSIX
- lastUpdatedAt :: Maybe POSIX
- loggingConfig :: Maybe LoggingConfig
- maxJobDurationInSeconds :: Maybe Integer
- name :: Maybe Text
- networkInterface :: Maybe NetworkInterface
- outputLocation :: Maybe OutputLocation
- robotApplications :: Maybe (NonEmpty RobotApplicationConfig)
- simulationApplications :: Maybe (NonEmpty SimulationApplicationConfig)
- simulationTimeMillis :: Maybe Integer
- status :: Maybe SimulationJobStatus
- tags :: Maybe (HashMap Text Text)
- vpcConfig :: Maybe VPCConfigResponse
}
newSimulationJob :: SimulationJob
simulationJob_arn :: Lens' SimulationJob (Maybe Text)
simulationJob_clientRequestToken :: Lens' SimulationJob (Maybe Text)
simulationJob_compute :: Lens' SimulationJob (Maybe ComputeResponse)
simulationJob_dataSources :: Lens' SimulationJob (Maybe [DataSource])
simulationJob_failureBehavior :: Lens' SimulationJob (Maybe FailureBehavior)
simulationJob_failureCode :: Lens' SimulationJob (Maybe SimulationJobErrorCode)
simulationJob_failureReason :: Lens' SimulationJob (Maybe Text)
simulationJob_iamRole :: Lens' SimulationJob (Maybe Text)
simulationJob_lastStartedAt :: Lens' SimulationJob (Maybe UTCTime)
simulationJob_lastUpdatedAt :: Lens' SimulationJob (Maybe UTCTime)
simulationJob_loggingConfig :: Lens' SimulationJob (Maybe LoggingConfig)
simulationJob_maxJobDurationInSeconds :: Lens' SimulationJob (Maybe Integer)
simulationJob_name :: Lens' SimulationJob (Maybe Text)
simulationJob_networkInterface :: Lens' SimulationJob (Maybe NetworkInterface)
simulationJob_outputLocation :: Lens' SimulationJob (Maybe OutputLocation)
simulationJob_robotApplications :: Lens' SimulationJob (Maybe (NonEmpty RobotApplicationConfig))
simulationJob_simulationApplications :: Lens' SimulationJob (Maybe (NonEmpty SimulationApplicationConfig))
simulationJob_simulationTimeMillis :: Lens' SimulationJob (Maybe Integer)
simulationJob_status :: Lens' SimulationJob (Maybe SimulationJobStatus)
simulationJob_tags :: Lens' SimulationJob (Maybe (HashMap Text Text))
simulationJob_vpcConfig :: Lens' SimulationJob (Maybe VPCConfigResponse)

Documentation

data SimulationJob Source #

Information about a simulation job.

See: newSimulationJob smart constructor.

Constructors

SimulationJob'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the simulation job.
clientRequestToken :: Maybe Text
A unique identifier for this SimulationJob request.
compute :: Maybe ComputeResponse
Compute information for the simulation job
dataSources :: Maybe [DataSource]
The data sources for the simulation job.
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.
failureCode :: Maybe SimulationJobErrorCode
The failure code of the simulation job if it failed.
failureReason :: Maybe Text
The reason why the simulation job failed.
iamRole :: Maybe Text
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.
lastStartedAt :: Maybe POSIX
The time, in milliseconds since the epoch, when the simulation job was last started.
lastUpdatedAt :: Maybe POSIX
The time, in milliseconds since the epoch, when the simulation job was last updated.
loggingConfig :: Maybe LoggingConfig
The logging configuration.
maxJobDurationInSeconds :: Maybe Integer
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
name :: Maybe Text
The name of the simulation job.
networkInterface :: Maybe NetworkInterface
Information about a network interface.
outputLocation :: Maybe OutputLocation
Location for output files generated by the simulation job.
robotApplications :: Maybe (NonEmpty RobotApplicationConfig)
A list of robot applications.
simulationApplications :: Maybe (NonEmpty SimulationApplicationConfig)
A list of simulation applications.
simulationTimeMillis :: Maybe Integer
The simulation job execution duration in milliseconds.
status :: Maybe SimulationJobStatus
Status of the simulation job.
tags :: Maybe (HashMap Text Text)
A map that contains tag keys and tag values that are attached to the simulation job.
vpcConfig :: Maybe VPCConfigResponse
VPC configuration information.

Instances

Instances details

FromJSON SimulationJob Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJob Methods parseJSON :: Value -> Parser SimulationJob # parseJSONList :: Value -> Parser [SimulationJob] #
Generic SimulationJob Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJob Associated Types type Rep SimulationJob :: Type -> Type # Methods from :: SimulationJob -> Rep SimulationJob x # to :: Rep SimulationJob x -> SimulationJob #
Read SimulationJob Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJob Methods readsPrec :: Int -> ReadS SimulationJob # readList :: ReadS [SimulationJob] # readPrec :: ReadPrec SimulationJob # readListPrec :: ReadPrec [SimulationJob] #
Show SimulationJob Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJob Methods showsPrec :: Int -> SimulationJob -> ShowS # show :: SimulationJob -> String # showList :: [SimulationJob] -> ShowS #
NFData SimulationJob Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJob Methods rnf :: SimulationJob -> () #
Eq SimulationJob Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJob Methods (==) :: SimulationJob -> SimulationJob -> Bool # (/=) :: SimulationJob -> SimulationJob -> Bool #
Hashable SimulationJob Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJob Methods hashWithSalt :: Int -> SimulationJob -> Int # hash :: SimulationJob -> Int #
type Rep SimulationJob Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJob type Rep SimulationJob = D1 ('MetaData "SimulationJob" "Amazonka.RobOMaker.Types.SimulationJob" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "SimulationJob'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "compute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComputeResponse)) :: (S1 ('MetaSel ('Just "dataSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataSource])) :: S1 ('MetaSel ('Just "failureBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailureBehavior))))) :: ((S1 ('MetaSel ('Just "failureCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimulationJobErrorCode)) :: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "iamRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastStartedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))) :: (((S1 ('MetaSel ('Just "loggingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfig)) :: S1 ('MetaSel ('Just "maxJobDurationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "networkInterface") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkInterface)) :: 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 "simulationTimeMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimulationJobStatus)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VPCConfigResponse))))))))

newSimulationJob :: SimulationJob Source #

Create a value of SimulationJob 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:arn:SimulationJob', simulationJob_arn - The Amazon Resource Name (ARN) of the simulation job.

$sel:clientRequestToken:SimulationJob', simulationJob_clientRequestToken - A unique identifier for this SimulationJob request.

$sel:compute:SimulationJob', simulationJob_compute - Compute information for the simulation job

$sel:dataSources:SimulationJob', simulationJob_dataSources - The data sources for the simulation job.

$sel:failureBehavior:SimulationJob', simulationJob_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:failureCode:SimulationJob', simulationJob_failureCode - The failure code of the simulation job if it failed.

$sel:failureReason:SimulationJob', simulationJob_failureReason - The reason why the simulation job failed.

$sel:iamRole:SimulationJob', simulationJob_iamRole - 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.

$sel:lastStartedAt:SimulationJob', simulationJob_lastStartedAt - The time, in milliseconds since the epoch, when the simulation job was last started.

$sel:lastUpdatedAt:SimulationJob', simulationJob_lastUpdatedAt - The time, in milliseconds since the epoch, when the simulation job was last updated.

$sel:loggingConfig:SimulationJob', simulationJob_loggingConfig - The logging configuration.

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

SimulationJob, simulationJob_name - The name of the simulation job.

$sel:networkInterface:SimulationJob', simulationJob_networkInterface - Information about a network interface.

$sel:outputLocation:SimulationJob', simulationJob_outputLocation - Location for output files generated by the simulation job.

$sel:robotApplications:SimulationJob', simulationJob_robotApplications - A list of robot applications.

$sel:simulationApplications:SimulationJob', simulationJob_simulationApplications - A list of simulation applications.

$sel:simulationTimeMillis:SimulationJob', simulationJob_simulationTimeMillis - The simulation job execution duration in milliseconds.

$sel:status:SimulationJob', simulationJob_status - Status of the simulation job.

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

$sel:vpcConfig:SimulationJob', simulationJob_vpcConfig - VPC configuration information.

simulationJob_arn :: Lens' SimulationJob (Maybe Text) Source #

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

simulationJob_clientRequestToken :: Lens' SimulationJob (Maybe Text) Source #

A unique identifier for this SimulationJob request.

simulationJob_compute :: Lens' SimulationJob (Maybe ComputeResponse) Source #

Compute information for the simulation job

simulationJob_dataSources :: Lens' SimulationJob (Maybe [DataSource]) Source #

The data sources for the simulation job.

simulationJob_failureBehavior :: Lens' SimulationJob (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.

simulationJob_failureCode :: Lens' SimulationJob (Maybe SimulationJobErrorCode) Source #

The failure code of the simulation job if it failed.

simulationJob_failureReason :: Lens' SimulationJob (Maybe Text) Source #

The reason why the simulation job failed.

simulationJob_iamRole :: Lens' SimulationJob (Maybe Text) Source #

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.

simulationJob_lastStartedAt :: Lens' SimulationJob (Maybe UTCTime) Source #

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

simulationJob_lastUpdatedAt :: Lens' SimulationJob (Maybe UTCTime) Source #

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

simulationJob_loggingConfig :: Lens' SimulationJob (Maybe LoggingConfig) Source #

The logging configuration.

simulationJob_maxJobDurationInSeconds :: Lens' SimulationJob (Maybe Integer) Source #

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

simulationJob_name :: Lens' SimulationJob (Maybe Text) Source #

The name of the simulation job.

simulationJob_networkInterface :: Lens' SimulationJob (Maybe NetworkInterface) Source #

Information about a network interface.

simulationJob_outputLocation :: Lens' SimulationJob (Maybe OutputLocation) Source #

Location for output files generated by the simulation job.

simulationJob_robotApplications :: Lens' SimulationJob (Maybe (NonEmpty RobotApplicationConfig)) Source #

A list of robot applications.

simulationJob_simulationApplications :: Lens' SimulationJob (Maybe (NonEmpty SimulationApplicationConfig)) Source #

A list of simulation applications.

simulationJob_simulationTimeMillis :: Lens' SimulationJob (Maybe Integer) Source #

The simulation job execution duration in milliseconds.

simulationJob_status :: Lens' SimulationJob (Maybe SimulationJobStatus) Source #

Status of the simulation job.

simulationJob_tags :: Lens' SimulationJob (Maybe (HashMap Text Text)) Source #

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

simulationJob_vpcConfig :: Lens' SimulationJob (Maybe VPCConfigResponse) Source #

VPC configuration information.