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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a simulation with the given name and schema.

Synopsis

data StartSimulation = StartSimulation' {
- clientToken :: Maybe (Sensitive Text)
- description :: Maybe Text
- maximumDuration :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- name :: Text
- roleArn :: Text
- schemaS3Location :: S3Location
}
newStartSimulation :: Text -> Text -> S3Location -> StartSimulation
startSimulation_clientToken :: Lens' StartSimulation (Maybe Text)
startSimulation_description :: Lens' StartSimulation (Maybe Text)
startSimulation_maximumDuration :: Lens' StartSimulation (Maybe Text)
startSimulation_tags :: Lens' StartSimulation (Maybe (HashMap Text Text))
startSimulation_name :: Lens' StartSimulation Text
startSimulation_roleArn :: Lens' StartSimulation Text
startSimulation_schemaS3Location :: Lens' StartSimulation S3Location
data StartSimulationResponse = StartSimulationResponse' {
- arn :: Maybe Text
- creationTime :: Maybe POSIX
- executionId :: Maybe Text
- httpStatus :: Int
}
newStartSimulationResponse :: Int -> StartSimulationResponse
startSimulationResponse_arn :: Lens' StartSimulationResponse (Maybe Text)
startSimulationResponse_creationTime :: Lens' StartSimulationResponse (Maybe UTCTime)
startSimulationResponse_executionId :: Lens' StartSimulationResponse (Maybe Text)
startSimulationResponse_httpStatus :: Lens' StartSimulationResponse Int

Creating a Request

data StartSimulation Source #

See: newStartSimulation smart constructor.

Constructors

StartSimulation'

Fields

clientToken :: Maybe (Sensitive Text)
A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A ClientToken is also known as an idempotency token. A ClientToken expires after 24 hours.
description :: Maybe Text
The description of the simulation.
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.
tags :: Maybe (HashMap Text Text)
A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
name :: Text
The name of the simulation.
roleArn :: 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.
schemaS3Location :: 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 .

Instances

Instances details

ToJSON StartSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation Methods toJSON :: StartSimulation -> Value # toEncoding :: StartSimulation -> Encoding # toJSONList :: [StartSimulation] -> Value # toEncodingList :: [StartSimulation] -> Encoding #
ToHeaders StartSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation Methods toHeaders :: StartSimulation -> [Header] #
ToPath StartSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation Methods toPath :: StartSimulation -> ByteString #
ToQuery StartSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation Methods toQuery :: StartSimulation -> QueryString #
AWSRequest StartSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation Associated Types type AWSResponse StartSimulation # Methods request :: (Service -> Service) -> StartSimulation -> Request StartSimulation # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartSimulation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartSimulation))) #
Generic StartSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation Associated Types type Rep StartSimulation :: Type -> Type # Methods from :: StartSimulation -> Rep StartSimulation x # to :: Rep StartSimulation x -> StartSimulation #
Show StartSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation Methods showsPrec :: Int -> StartSimulation -> ShowS # show :: StartSimulation -> String # showList :: [StartSimulation] -> ShowS #
NFData StartSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation Methods rnf :: StartSimulation -> () #
Eq StartSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation Methods (==) :: StartSimulation -> StartSimulation -> Bool # (/=) :: StartSimulation -> StartSimulation -> Bool #
Hashable StartSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation Methods hashWithSalt :: Int -> StartSimulation -> Int # hash :: StartSimulation -> Int #
type AWSResponse StartSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation type AWSResponse StartSimulation = StartSimulationResponse
type Rep StartSimulation Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation type Rep StartSimulation = D1 ('MetaData "StartSimulation" "Amazonka.SimSpaceWeaver.StartSimulation" "amazonka-simspaceweaver-2.0-C619ppqhgbWKEJKYoFCug9" 'False) (C1 ('MetaCons "StartSimulation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maximumDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "schemaS3Location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3Location)))))

newStartSimulation Source #

Arguments

:: Text	`StartSimulation`
-> Text	`$sel:roleArn:StartSimulation'`
-> S3Location	`$sel:schemaS3Location:StartSimulation'`
-> StartSimulation

Create a value of StartSimulation 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:clientToken:StartSimulation', startSimulation_clientToken - A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A ClientToken is also known as an idempotency token. A ClientToken expires after 24 hours.

$sel:description:StartSimulation', startSimulation_description - The description of the simulation.

$sel:maximumDuration:StartSimulation', startSimulation_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.

$sel:tags:StartSimulation', startSimulation_tags - A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

StartSimulation, startSimulation_name - The name of the simulation.

$sel:roleArn:StartSimulation', startSimulation_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:schemaS3Location:StartSimulation', startSimulation_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 .

Request Lenses

startSimulation_clientToken :: Lens' StartSimulation (Maybe Text) Source #

A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A ClientToken is also known as an idempotency token. A ClientToken expires after 24 hours.

startSimulation_description :: Lens' StartSimulation (Maybe Text) Source #

The description of the simulation.

startSimulation_maximumDuration :: Lens' StartSimulation (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.

startSimulation_tags :: Lens' StartSimulation (Maybe (HashMap Text Text)) Source #

A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

startSimulation_name :: Lens' StartSimulation Text Source #

The name of the simulation.

startSimulation_roleArn :: Lens' StartSimulation 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.

startSimulation_schemaS3Location :: Lens' StartSimulation 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 .

Destructuring the Response

data StartSimulationResponse Source #

See: newStartSimulationResponse smart constructor.

Constructors

StartSimulationResponse'

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).
executionId :: Maybe Text
A universally unique identifier (UUID) for this simulation.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic StartSimulationResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation Associated Types type Rep StartSimulationResponse :: Type -> Type # Methods from :: StartSimulationResponse -> Rep StartSimulationResponse x # to :: Rep StartSimulationResponse x -> StartSimulationResponse #
Read StartSimulationResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation Methods readsPrec :: Int -> ReadS StartSimulationResponse # readList :: ReadS [StartSimulationResponse] # readPrec :: ReadPrec StartSimulationResponse # readListPrec :: ReadPrec [StartSimulationResponse] #
Show StartSimulationResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation Methods showsPrec :: Int -> StartSimulationResponse -> ShowS # show :: StartSimulationResponse -> String # showList :: [StartSimulationResponse] -> ShowS #
NFData StartSimulationResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation Methods rnf :: StartSimulationResponse -> () #
Eq StartSimulationResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation Methods (==) :: StartSimulationResponse -> StartSimulationResponse -> Bool # (/=) :: StartSimulationResponse -> StartSimulationResponse -> Bool #
type Rep StartSimulationResponse Source #
Instance details Defined in Amazonka.SimSpaceWeaver.StartSimulation type Rep StartSimulationResponse = D1 ('MetaData "StartSimulationResponse" "Amazonka.SimSpaceWeaver.StartSimulation" "amazonka-simspaceweaver-2.0-C619ppqhgbWKEJKYoFCug9" 'False) (C1 ('MetaCons "StartSimulationResponse'" '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 "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartSimulationResponse Source #

Arguments

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

Create a value of StartSimulationResponse 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:

StartSimulationResponse, startSimulationResponse_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.

StartSimulationResponse, startSimulationResponse_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:executionId:StartSimulationResponse', startSimulationResponse_executionId - A universally unique identifier (UUID) for this simulation.

$sel:httpStatus:StartSimulationResponse', startSimulationResponse_httpStatus - The response's http status code.

Response Lenses

startSimulationResponse_arn :: Lens' StartSimulationResponse (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.

startSimulationResponse_creationTime :: Lens' StartSimulationResponse (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).

startSimulationResponse_executionId :: Lens' StartSimulationResponse (Maybe Text) Source #

A universally unique identifier (UUID) for this simulation.

startSimulationResponse_httpStatus :: Lens' StartSimulationResponse Int Source #

The response's http status code.