amazonka-simspaceweaver-2.0: Amazon SimSpace Weaver SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SimSpaceWeaver.Lens

Description

 
Synopsis

Operations

DeleteApp

deleteApp_app :: Lens' DeleteApp Text Source #

The name of the app.

deleteApp_domain :: Lens' DeleteApp Text Source #

The name of the domain of the app.

deleteApp_simulation :: Lens' DeleteApp Text Source #

The name of the simulation of the app.

deleteAppResponse_httpStatus :: Lens' DeleteAppResponse Int Source #

The response's http status code.

DeleteSimulation

DescribeApp

describeApp_app :: Lens' DescribeApp Text Source #

The name of the app.

describeApp_domain :: Lens' DescribeApp Text Source #

The name of the domain of the app.

describeApp_simulation :: Lens' DescribeApp Text Source #

The name of the simulation of the app.

describeAppResponse_domain :: Lens' DescribeAppResponse (Maybe Text) Source #

The name of the domain of the app.

describeAppResponse_endpointInfo :: Lens' DescribeAppResponse (Maybe SimulationAppEndpointInfo) Source #

Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.

describeAppResponse_simulation :: Lens' DescribeAppResponse (Maybe Text) Source #

The name of the simulation of the app.

describeAppResponse_status :: Lens' DescribeAppResponse (Maybe SimulationAppStatus) Source #

The current lifecycle state of the custom app.

DescribeSimulation

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

ListApps

listApps_domain :: Lens' ListApps (Maybe Text) Source #

The name of the domain that you want to list apps for.

listApps_maxResults :: Lens' ListApps (Maybe Natural) Source #

The maximum number of apps to list.

listApps_nextToken :: Lens' ListApps (Maybe Text) Source #

If SimSpace Weaver returns nextToken, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, you receive an HTTP 400 ValidationException error.

listApps_simulation :: Lens' ListApps Text Source #

The name of the simulation that you want to list apps for.

listAppsResponse_apps :: Lens' ListAppsResponse (Maybe [SimulationAppMetadata]) Source #

The list of apps for the given simulation and domain.

listAppsResponse_nextToken :: Lens' ListAppsResponse (Maybe Text) Source #

If SimSpace Weaver returns nextToken, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, you receive an HTTP 400 ValidationException error.

listAppsResponse_httpStatus :: Lens' ListAppsResponse Int Source #

The response's http status code.

ListSimulations

listSimulations_maxResults :: Lens' ListSimulations (Maybe Natural) Source #

The maximum number of simulations to list.

listSimulations_nextToken :: Lens' ListSimulations (Maybe Text) Source #

If SimSpace Weaver returns nextToken, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, you receive an HTTP 400 ValidationException error.

listSimulationsResponse_nextToken :: Lens' ListSimulationsResponse (Maybe Text) Source #

If SimSpace Weaver returns nextToken, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, you receive an HTTP 400 ValidationException error.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

StartApp

startApp_clientToken :: Lens' StartApp (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.

startApp_description :: Lens' StartApp (Maybe Text) Source #

The description of the app.

startApp_domain :: Lens' StartApp Text Source #

The name of the domain of the app.

startApp_name :: Lens' StartApp Text Source #

The name of the app.

startApp_simulation :: Lens' StartApp Text Source #

The name of the simulation of the app.

startAppResponse_domain :: Lens' StartAppResponse (Maybe Text) Source #

The name of the domain of the app.

startAppResponse_simulation :: Lens' StartAppResponse (Maybe Text) Source #

The name of the simulation of the app.

startAppResponse_httpStatus :: Lens' StartAppResponse Int Source #

The response's http status code.

StartClock

startClock_simulation :: Lens' StartClock Text Source #

The name of the simulation.

StartSimulation

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 .

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.

StopApp

stopApp_app :: Lens' StopApp Text Source #

The name of the app.

stopApp_domain :: Lens' StopApp Text Source #

The name of the domain of the app.

stopApp_simulation :: Lens' StopApp Text Source #

The name of the simulation of the app.

stopAppResponse_httpStatus :: Lens' StopAppResponse Int Source #

The response's http status code.

StopClock

stopClock_simulation :: Lens' StopClock Text Source #

The name of the simulation.

stopClockResponse_httpStatus :: Lens' StopClockResponse Int Source #

The response's http status code.

StopSimulation

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource that you want to add tags to. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

A list of tags to apply to the resource.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource that you want to remove tags from. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

A list of tag keys to remove from the resource.

Types

CloudWatchLogsLogGroup

cloudWatchLogsLogGroup_logGroupArn :: Lens' CloudWatchLogsLogGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group for the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For more information about log groups, see Working with log groups and log streams in the Amazon CloudWatch Logs User Guide.

Domain

domain_lifecycle :: Lens' Domain (Maybe LifecycleManagementStrategy) Source #

The type of lifecycle management for apps in the domain. This value indicates whether apps in this domain are managed (SimSpace Weaver starts and stops the apps) or unmanaged (you must start and stop the apps).

Lifecycle types

  • PerWorker – Managed: SimSpace Weaver starts 1 app on each worker
  • BySpatialSubdivision – Managed: SimSpace Weaver starts 1 app for each spatial partition
  • ByRequest – Unmanaged: You use the StartApp API to start the apps and use the StopApp API to stop the apps.

The lifecycle types will change when the service is released for general availability (GA).

domain_name :: Lens' Domain (Maybe Text) Source #

The name of the domain.

LaunchOverrides

launchOverrides_launchCommands :: Lens' LaunchOverrides (Maybe [Text]) Source #

App launch commands and command line parameters that override the launch command configured in the simulation schema.

LiveSimulationState

liveSimulationState_clocks :: Lens' LiveSimulationState (Maybe [SimulationClock]) Source #

A list of simulation clocks.

At this time, a simulation has only one clock.

liveSimulationState_domains :: Lens' LiveSimulationState (Maybe [Domain]) Source #

A list of domains for the simulation. For more information about domains, see Key concepts in the Amazon Web Services SimSpace Weaver User Guide.

LogDestination

logDestination_cloudWatchLogsLogGroup :: Lens' LogDestination (Maybe CloudWatchLogsLogGroup) Source #

An Amazon CloudWatch Logs log group that stores simulation log data. For more information about log groups, see Working with log groups and log streams in the Amazon CloudWatch Logs User Guide.

LoggingConfiguration

loggingConfiguration_destinations :: Lens' LoggingConfiguration (Maybe [LogDestination]) Source #

A list of the locations where SimSpace Weaver sends simulation log data.

S3Location

s3Location_bucketName :: Lens' S3Location (Maybe Text) Source #

The name of an Amazon S3 bucket. For more information about buckets, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide.

s3Location_objectKey :: Lens' S3Location (Maybe Text) Source #

The key name of an object in Amazon S3. For more information about Amazon S3 objects and object keys, see Uploading, downloading, and working with objects in Amazon S3 in the Amazon Simple Storage Service User Guide.

SimulationAppEndpointInfo

simulationAppEndpointInfo_address :: Lens' SimulationAppEndpointInfo (Maybe Text) Source #

The IP address of the app. SimSpace Weaver dynamically assigns this IP address when the app starts.

simulationAppEndpointInfo_ingressPortMappings :: Lens' SimulationAppEndpointInfo (Maybe [SimulationAppPortMapping]) Source #

The inbound TCP/UDP port numbers of the app. The combination of an IP address and a port number form a network endpoint.

SimulationAppMetadata

simulationAppMetadata_domain :: Lens' SimulationAppMetadata (Maybe Text) Source #

The domain of the app. For more information about domains, see Key concepts in the Amazon Web Services SimSpace Weaver User Guide.

SimulationAppPortMapping

simulationAppPortMapping_actual :: Lens' SimulationAppPortMapping (Maybe Natural) Source #

The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port number when the app starts. SimSpace Weaver maps the Declared port to the Actual port. Clients connect to the app using the app's IP address and the Actual port number.

simulationAppPortMapping_declared :: Lens' SimulationAppPortMapping (Maybe Natural) Source #

The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps the Declared port to the Actual port. The source code for the app should bind to the Declared port.

SimulationClock

simulationClock_status :: Lens' SimulationClock (Maybe ClockStatus) Source #

The current status of the simulation clock.

simulationClock_targetStatus :: Lens' SimulationClock (Maybe ClockTargetStatus) Source #

The desired status of the simulation clock.

SimulationMetadata

simulationMetadata_arn :: Lens' SimulationMetadata (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.

simulationMetadata_creationTime :: Lens' SimulationMetadata (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).