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 |
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.
StartSimulation' | |
|
Instances
:: Text | |
-> Text | |
-> S3Location | |
-> 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.
StartSimulationResponse' | |
|
Instances
newStartSimulationResponse Source #
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.