Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RobOMaker.Types.SimulationJob

Description

Synopsis

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

Documentation

data SimulationJob Source #

Information about a simulation job.

See: newSimulationJob smart constructor.

Constructors

SimulationJob'

Fields

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

Instances

Instances details

Eq SimulationJob Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJob Methods (==) :: SimulationJob -> SimulationJob -> Bool # (/=) :: SimulationJob -> SimulationJob -> Bool #
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 #
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 #
NFData SimulationJob Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJob Methods rnf :: SimulationJob -> () #
Hashable SimulationJob Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJob Methods hashWithSalt :: Int -> SimulationJob -> Int # hash :: SimulationJob -> Int #
FromJSON SimulationJob Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJob Methods parseJSON :: Value -> Parser SimulationJob # parseJSONList :: Value -> Parser [SimulationJob] #
type Rep SimulationJob Source #
Instance details Defined in Amazonka.RobOMaker.Types.SimulationJob type Rep SimulationJob = D1 ('MetaData "SimulationJob" "Amazonka.RobOMaker.Types.SimulationJob" "libZSservicesZSamazonka-robomakerZSamazonka-robomaker" 'False) (C1 ('MetaCons "SimulationJob'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "failureBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailureBehavior))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimulationJobStatus)) :: (S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "robotApplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty RobotApplicationConfig))) :: S1 ('MetaSel ('Just "failureCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimulationJobErrorCode))) :: (S1 ('MetaSel ('Just "compute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComputeResponse)) :: (S1 ('MetaSel ('Just "networkInterface") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkInterface)) :: S1 ('MetaSel ('Just "dataSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataSource])))))) :: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VPCConfigResponse))) :: (S1 ('MetaSel ('Just "outputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputLocation)) :: (S1 ('MetaSel ('Just "simulationApplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SimulationApplicationConfig))) :: S1 ('MetaSel ('Just "simulationTimeMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :: ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastStartedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "loggingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfig)))) :: (S1 ('MetaSel ('Just "iamRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxJobDurationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))))

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:failureReason:SimulationJob', simulationJob_failureReason - The reason why the simulation job failed.

$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:status:SimulationJob', simulationJob_status - Status of the simulation job.

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

$sel:arn:SimulationJob', simulationJob_arn - The Amazon Resource Name (ARN) of the simulation job.

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

$sel:failureCode:SimulationJob', simulationJob_failureCode - The failure code of the simulation job if it failed.

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

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

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

$sel:name:SimulationJob', simulationJob_name - The name of the simulation job.

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

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

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

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

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

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

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

$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:maxJobDurationInSeconds:SimulationJob', simulationJob_maxJobDurationInSeconds - The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

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

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

The reason why the simulation job failed.

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_status :: Lens' SimulationJob (Maybe SimulationJobStatus) Source #

Status of the simulation job.

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

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

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

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

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

A list of robot applications.

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

The failure code of the simulation job if it failed.

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

Compute information for the simulation job

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

Information about a network interface.

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

The data sources for the simulation job.

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

The name of the simulation job.

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

VPC configuration information.

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

Location for output files generated by the simulation job.

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_clientRequestToken :: Lens' SimulationJob (Maybe Text) Source #

A unique identifier for this SimulationJob request.

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

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

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

The logging configuration.

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_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_tags :: Lens' SimulationJob (Maybe (HashMap Text Text)) Source #

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