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