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 |
Returns the current state of the given simulation.
Synopsis
- data DescribeSimulation = DescribeSimulation' {
- simulation :: Text
- newDescribeSimulation :: Text -> DescribeSimulation
- describeSimulation_simulation :: Lens' DescribeSimulation Text
- data DescribeSimulationResponse = DescribeSimulationResponse' {
- arn :: Maybe Text
- creationTime :: Maybe POSIX
- description :: Maybe Text
- executionId :: Maybe Text
- liveSimulationState :: Maybe LiveSimulationState
- loggingConfiguration :: Maybe LoggingConfiguration
- maximumDuration :: Maybe Text
- name :: Maybe Text
- roleArn :: Maybe Text
- schemaError :: Maybe Text
- schemaS3Location :: Maybe S3Location
- status :: Maybe SimulationStatus
- targetStatus :: Maybe SimulationTargetStatus
- httpStatus :: Int
- newDescribeSimulationResponse :: Int -> DescribeSimulationResponse
- describeSimulationResponse_arn :: Lens' DescribeSimulationResponse (Maybe Text)
- describeSimulationResponse_creationTime :: Lens' DescribeSimulationResponse (Maybe UTCTime)
- describeSimulationResponse_description :: Lens' DescribeSimulationResponse (Maybe Text)
- describeSimulationResponse_executionId :: Lens' DescribeSimulationResponse (Maybe Text)
- describeSimulationResponse_liveSimulationState :: Lens' DescribeSimulationResponse (Maybe LiveSimulationState)
- describeSimulationResponse_loggingConfiguration :: Lens' DescribeSimulationResponse (Maybe LoggingConfiguration)
- describeSimulationResponse_maximumDuration :: Lens' DescribeSimulationResponse (Maybe Text)
- describeSimulationResponse_name :: Lens' DescribeSimulationResponse (Maybe Text)
- describeSimulationResponse_roleArn :: Lens' DescribeSimulationResponse (Maybe Text)
- describeSimulationResponse_schemaError :: Lens' DescribeSimulationResponse (Maybe Text)
- describeSimulationResponse_schemaS3Location :: Lens' DescribeSimulationResponse (Maybe S3Location)
- describeSimulationResponse_status :: Lens' DescribeSimulationResponse (Maybe SimulationStatus)
- describeSimulationResponse_targetStatus :: Lens' DescribeSimulationResponse (Maybe SimulationTargetStatus)
- describeSimulationResponse_httpStatus :: Lens' DescribeSimulationResponse Int
Creating a Request
data DescribeSimulation Source #
See: newDescribeSimulation
smart constructor.
DescribeSimulation' | |
|
Instances
newDescribeSimulation Source #
Create a value of DescribeSimulation
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:
DescribeSimulation
, describeSimulation_simulation
- The name of the simulation.
Request Lenses
describeSimulation_simulation :: Lens' DescribeSimulation Text Source #
The name of the simulation.
Destructuring the Response
data DescribeSimulationResponse Source #
See: newDescribeSimulationResponse
smart constructor.
DescribeSimulationResponse' | |
|
Instances
newDescribeSimulationResponse Source #
Create a value of DescribeSimulationResponse
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:
DescribeSimulationResponse
, describeSimulationResponse_arn
- The Amazon Resource Name (ARN) of the simulation. For more information
about ARNs, see
Amazon Resource Names (ARNs)
in the Amazon Web Services General Reference.
DescribeSimulationResponse
, describeSimulationResponse_creationTime
- The time when the simulation was created, expressed as the number of
seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January
1, 1970).
$sel:description:DescribeSimulationResponse'
, describeSimulationResponse_description
- The description of the simulation.
$sel:executionId:DescribeSimulationResponse'
, describeSimulationResponse_executionId
- A universally unique identifier (UUID) for this simulation.
$sel:liveSimulationState:DescribeSimulationResponse'
, describeSimulationResponse_liveSimulationState
- A collection of additional state information, such as domain and clock
configuration.
$sel:loggingConfiguration:DescribeSimulationResponse'
, describeSimulationResponse_loggingConfiguration
- Settings that control how SimSpace Weaver handles your simulation log
data.
$sel:maximumDuration:DescribeSimulationResponse'
, describeSimulationResponse_maximumDuration
- The maximum running time of the simulation, specified as a number of
months (m or M), hours (h or H), or days (d or D). The simulation stops
when it reaches this limit.
DescribeSimulationResponse
, describeSimulationResponse_name
- The name of the simulation.
$sel:roleArn:DescribeSimulationResponse'
, describeSimulationResponse_roleArn
- The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that the simulation assumes to perform actions. For more
information about ARNs, see
Amazon Resource Names (ARNs)
in the Amazon Web Services General Reference. For more information
about IAM roles, see
IAM roles
in the Identity and Access Management User Guide.
$sel:schemaError:DescribeSimulationResponse'
, describeSimulationResponse_schemaError
- An error message that SimSpace Weaver returns only if there is a problem
with the simulation schema.
$sel:schemaS3Location:DescribeSimulationResponse'
, describeSimulationResponse_schemaS3Location
- The location of the simulation schema in Amazon Simple Storage Service
(Amazon S3). For more information about Amazon S3, see the
Amazon Simple Storage Service User Guide
.
DescribeSimulationResponse
, describeSimulationResponse_status
- The current lifecycle state of the simulation.
DescribeSimulationResponse
, describeSimulationResponse_targetStatus
- The desired lifecycle state of the simulation.
$sel:httpStatus:DescribeSimulationResponse'
, describeSimulationResponse_httpStatus
- The response's http status code.
Response Lenses
describeSimulationResponse_arn :: Lens' DescribeSimulationResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
describeSimulationResponse_creationTime :: Lens' DescribeSimulationResponse (Maybe UTCTime) Source #
The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).
describeSimulationResponse_description :: Lens' DescribeSimulationResponse (Maybe Text) Source #
The description of the simulation.
describeSimulationResponse_executionId :: Lens' DescribeSimulationResponse (Maybe Text) Source #
A universally unique identifier (UUID) for this simulation.
describeSimulationResponse_liveSimulationState :: Lens' DescribeSimulationResponse (Maybe LiveSimulationState) Source #
A collection of additional state information, such as domain and clock configuration.
describeSimulationResponse_loggingConfiguration :: Lens' DescribeSimulationResponse (Maybe LoggingConfiguration) Source #
Settings that control how SimSpace Weaver handles your simulation log data.
describeSimulationResponse_maximumDuration :: Lens' DescribeSimulationResponse (Maybe Text) Source #
The maximum running time of the simulation, specified as a number of months (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches this limit.
describeSimulationResponse_name :: Lens' DescribeSimulationResponse (Maybe Text) Source #
The name of the simulation.
describeSimulationResponse_roleArn :: Lens' DescribeSimulationResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see IAM roles in the Identity and Access Management User Guide.
describeSimulationResponse_schemaError :: Lens' DescribeSimulationResponse (Maybe Text) Source #
An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.
describeSimulationResponse_schemaS3Location :: Lens' DescribeSimulationResponse (Maybe S3Location) Source #
The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .
describeSimulationResponse_status :: Lens' DescribeSimulationResponse (Maybe SimulationStatus) Source #
The current lifecycle state of the simulation.
describeSimulationResponse_targetStatus :: Lens' DescribeSimulationResponse (Maybe SimulationTargetStatus) Source #
The desired lifecycle state of the simulation.
describeSimulationResponse_httpStatus :: Lens' DescribeSimulationResponse Int Source #
The response's http status code.