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.SimSpaceWeaver.DescribeSimulation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the current state of the given simulation.

Synopsis

Creating a Request

data DescribeSimulation Source #

See: newDescribeSimulation smart constructor.

Constructors

DescribeSimulation'
Fields simulation :: Text The name of the simulation.

Instances

Instances details

ToHeaders DescribeSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation Methods toHeaders :: DescribeSimulation -> [Header] #
ToPath DescribeSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation Methods toPath :: DescribeSimulation -> ByteString #
ToQuery DescribeSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation Methods toQuery :: DescribeSimulation -> QueryString #
AWSRequest DescribeSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation Associated Types type AWSResponse DescribeSimulation # Methods request :: (Service -> Service) -> DescribeSimulation -> Request DescribeSimulation # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeSimulation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSimulation))) #
Generic DescribeSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation Associated Types type Rep DescribeSimulation :: Type -> Type # Methods from :: DescribeSimulation -> Rep DescribeSimulation x # to :: Rep DescribeSimulation x -> DescribeSimulation #
Read DescribeSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation Methods readsPrec :: Int -> ReadS DescribeSimulation # readList :: ReadS [DescribeSimulation] # readPrec :: ReadPrec DescribeSimulation # readListPrec :: ReadPrec [DescribeSimulation] #
Show DescribeSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation Methods showsPrec :: Int -> DescribeSimulation -> ShowS # show :: DescribeSimulation -> String # showList :: [DescribeSimulation] -> ShowS #
NFData DescribeSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation Methods rnf :: DescribeSimulation -> () #
Eq DescribeSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation Methods (==) :: DescribeSimulation -> DescribeSimulation -> Bool # (/=) :: DescribeSimulation -> DescribeSimulation -> Bool #
Hashable DescribeSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation Methods hashWithSalt :: Int -> DescribeSimulation -> Int # hash :: DescribeSimulation -> Int #
type AWSResponse DescribeSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation type AWSResponse DescribeSimulation = DescribeSimulationResponse
type Rep DescribeSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation type Rep DescribeSimulation = D1 ('MetaData "DescribeSimulation" "Amazonka.SimSpaceWeaver.DescribeSimulation" "amazonka-simspaceweaver-2.0-C619ppqhgbWKEJKYoFCug9" 'False) (C1 ('MetaCons "DescribeSimulation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "simulation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeSimulation Source #

Arguments

:: Text	`DescribeSimulation`
-> DescribeSimulation

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.

Constructors

DescribeSimulationResponse'

Fields

arn :: Maybe Text
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.
creationTime :: Maybe POSIX
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).
description :: Maybe Text
The description of the simulation.
executionId :: Maybe Text
A universally unique identifier (UUID) for this simulation.
liveSimulationState :: Maybe LiveSimulationState
A collection of additional state information, such as domain and clock configuration.
loggingConfiguration :: Maybe LoggingConfiguration
Settings that control how SimSpace Weaver handles your simulation log data.
maximumDuration :: Maybe Text
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.
name :: Maybe Text
The name of the simulation.
roleArn :: Maybe Text
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.
schemaError :: Maybe Text
An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.
schemaS3Location :: Maybe S3Location
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 .
status :: Maybe SimulationStatus
The current lifecycle state of the simulation.
targetStatus :: Maybe SimulationTargetStatus
The desired lifecycle state of the simulation.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeSimulationResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation Associated Types type Rep DescribeSimulationResponse :: Type -> Type # Methods from :: DescribeSimulationResponse -> Rep DescribeSimulationResponse x # to :: Rep DescribeSimulationResponse x -> DescribeSimulationResponse #
Read DescribeSimulationResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation Methods readsPrec :: Int -> ReadS DescribeSimulationResponse # readList :: ReadS [DescribeSimulationResponse] # readPrec :: ReadPrec DescribeSimulationResponse # readListPrec :: ReadPrec [DescribeSimulationResponse] #
Show DescribeSimulationResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation Methods showsPrec :: Int -> DescribeSimulationResponse -> ShowS # show :: DescribeSimulationResponse -> String # showList :: [DescribeSimulationResponse] -> ShowS #
NFData DescribeSimulationResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation Methods rnf :: DescribeSimulationResponse -> () #
Eq DescribeSimulationResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation Methods (==) :: DescribeSimulationResponse -> DescribeSimulationResponse -> Bool # (/=) :: DescribeSimulationResponse -> DescribeSimulationResponse -> Bool #
type Rep DescribeSimulationResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.DescribeSimulation type Rep DescribeSimulationResponse = D1 ('MetaData "DescribeSimulationResponse" "Amazonka.SimSpaceWeaver.DescribeSimulation" "amazonka-simspaceweaver-2.0-C619ppqhgbWKEJKYoFCug9" 'False) (C1 ('MetaCons "DescribeSimulationResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "liveSimulationState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LiveSimulationState))) :: (S1 ('MetaSel ('Just "loggingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfiguration)) :: S1 ('MetaSel ('Just "maximumDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schemaError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "schemaS3Location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Location)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimulationStatus))) :: (S1 ('MetaSel ('Just "targetStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimulationTargetStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeSimulationResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeSimulationResponse'`
-> DescribeSimulationResponse

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.