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 |
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- ClockStatus
- ClockTargetStatus
- LifecycleManagementStrategy
- SimulationAppStatus
- SimulationAppTargetStatus
- SimulationStatus
- SimulationTargetStatus
- CloudWatchLogsLogGroup
- Domain
- LaunchOverrides
- LiveSimulationState
- LogDestination
- LoggingConfiguration
- S3Location
- SimulationAppEndpointInfo
- SimulationAppMetadata
- SimulationAppPortMapping
- SimulationClock
- SimulationMetadata
Derived from API version 2022-10-28
of the AWS service descriptions, licensed under Apache 2.0.
Amazon Web Services SimSpace Weaver (SimSpace Weaver) is a managed service that you can use to build and operate large-scale spatial simulations in the Amazon Web Services Cloud. For example, you can create a digital twin of a city, crowd simulations with millions of people and objects, and massilvely-multiplayer games with hundreds of thousands of connected players. For more information about SimSpace Weaver, see the <https:docs.aws.amazon.comsimspaceweaverlatestuserguide Amazon Web Services SimSpace Weaver User Guide> .
This API reference describes the API operations and data types that you can use to communicate directly with SimSpace Weaver.
SimSpace Weaver also provides the SimSpace Weaver app SDK, which you use for app development. The SimSpace Weaver app SDK API reference is included in the SimSpace Weaver app SDK documentation, which is part of the SimSpace Weaver app SDK distributable package.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data DeleteApp = DeleteApp' Text Text Text
- newDeleteApp :: Text -> Text -> Text -> DeleteApp
- data DeleteAppResponse = DeleteAppResponse' Int
- newDeleteAppResponse :: Int -> DeleteAppResponse
- data DeleteSimulation = DeleteSimulation' Text
- newDeleteSimulation :: Text -> DeleteSimulation
- data DeleteSimulationResponse = DeleteSimulationResponse' Int
- newDeleteSimulationResponse :: Int -> DeleteSimulationResponse
- data DescribeApp = DescribeApp' Text Text Text
- newDescribeApp :: Text -> Text -> Text -> DescribeApp
- data DescribeAppResponse = DescribeAppResponse' (Maybe Text) (Maybe Text) (Maybe SimulationAppEndpointInfo) (Maybe LaunchOverrides) (Maybe Text) (Maybe Text) (Maybe SimulationAppStatus) (Maybe SimulationAppTargetStatus) Int
- newDescribeAppResponse :: Int -> DescribeAppResponse
- data DescribeSimulation = DescribeSimulation' Text
- newDescribeSimulation :: Text -> DescribeSimulation
- data DescribeSimulationResponse = DescribeSimulationResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe LiveSimulationState) (Maybe LoggingConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe S3Location) (Maybe SimulationStatus) (Maybe SimulationTargetStatus) Int
- newDescribeSimulationResponse :: Int -> DescribeSimulationResponse
- data ListApps = ListApps' (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newListApps :: Text -> ListApps
- data ListAppsResponse = ListAppsResponse' (Maybe [SimulationAppMetadata]) (Maybe Text) Int
- newListAppsResponse :: Int -> ListAppsResponse
- data ListSimulations = ListSimulations' (Maybe Natural) (Maybe Text)
- newListSimulations :: ListSimulations
- data ListSimulationsResponse = ListSimulationsResponse' (Maybe Text) (Maybe [SimulationMetadata]) Int
- newListSimulationsResponse :: Int -> ListSimulationsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data StartApp = StartApp' (Maybe (Sensitive Text)) (Maybe Text) (Maybe LaunchOverrides) Text Text Text
- newStartApp :: Text -> Text -> Text -> StartApp
- data StartAppResponse = StartAppResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newStartAppResponse :: Int -> StartAppResponse
- data StartClock = StartClock' Text
- newStartClock :: Text -> StartClock
- data StartClockResponse = StartClockResponse' Int
- newStartClockResponse :: Int -> StartClockResponse
- data StartSimulation = StartSimulation' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text Text S3Location
- newStartSimulation :: Text -> Text -> S3Location -> StartSimulation
- data StartSimulationResponse = StartSimulationResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) Int
- newStartSimulationResponse :: Int -> StartSimulationResponse
- data StopApp = StopApp' Text Text Text
- newStopApp :: Text -> Text -> Text -> StopApp
- data StopAppResponse = StopAppResponse' Int
- newStopAppResponse :: Int -> StopAppResponse
- data StopClock = StopClock' Text
- newStopClock :: Text -> StopClock
- data StopClockResponse = StopClockResponse' Int
- newStopClockResponse :: Int -> StopClockResponse
- data StopSimulation = StopSimulation' Text
- newStopSimulation :: Text -> StopSimulation
- data StopSimulationResponse = StopSimulationResponse' Int
- newStopSimulationResponse :: Int -> StopSimulationResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- newtype ClockStatus where
- ClockStatus' { }
- pattern ClockStatus_STARTED :: ClockStatus
- pattern ClockStatus_STARTING :: ClockStatus
- pattern ClockStatus_STOPPED :: ClockStatus
- pattern ClockStatus_STOPPING :: ClockStatus
- pattern ClockStatus_UNKNOWN :: ClockStatus
- newtype ClockTargetStatus where
- ClockTargetStatus' { }
- pattern ClockTargetStatus_STARTED :: ClockTargetStatus
- pattern ClockTargetStatus_STOPPED :: ClockTargetStatus
- pattern ClockTargetStatus_UNKNOWN :: ClockTargetStatus
- newtype LifecycleManagementStrategy where
- LifecycleManagementStrategy' { }
- pattern LifecycleManagementStrategy_ByRequest :: LifecycleManagementStrategy
- pattern LifecycleManagementStrategy_BySpatialSubdivision :: LifecycleManagementStrategy
- pattern LifecycleManagementStrategy_PerWorker :: LifecycleManagementStrategy
- pattern LifecycleManagementStrategy_Unknown :: LifecycleManagementStrategy
- newtype SimulationAppStatus where
- SimulationAppStatus' { }
- pattern SimulationAppStatus_ERROR :: SimulationAppStatus
- pattern SimulationAppStatus_STARTED :: SimulationAppStatus
- pattern SimulationAppStatus_STARTING :: SimulationAppStatus
- pattern SimulationAppStatus_STOPPED :: SimulationAppStatus
- pattern SimulationAppStatus_STOPPING :: SimulationAppStatus
- pattern SimulationAppStatus_UNKNOWN :: SimulationAppStatus
- newtype SimulationAppTargetStatus where
- newtype SimulationStatus where
- SimulationStatus' { }
- pattern SimulationStatus_DELETED :: SimulationStatus
- pattern SimulationStatus_DELETING :: SimulationStatus
- pattern SimulationStatus_FAILED :: SimulationStatus
- pattern SimulationStatus_STARTED :: SimulationStatus
- pattern SimulationStatus_STARTING :: SimulationStatus
- pattern SimulationStatus_STOPPED :: SimulationStatus
- pattern SimulationStatus_STOPPING :: SimulationStatus
- pattern SimulationStatus_UNKNOWN :: SimulationStatus
- newtype SimulationTargetStatus where
- data CloudWatchLogsLogGroup = CloudWatchLogsLogGroup' (Maybe Text)
- newCloudWatchLogsLogGroup :: CloudWatchLogsLogGroup
- data Domain = Domain' (Maybe LifecycleManagementStrategy) (Maybe Text)
- newDomain :: Domain
- data LaunchOverrides = LaunchOverrides' (Maybe [Text])
- newLaunchOverrides :: LaunchOverrides
- data LiveSimulationState = LiveSimulationState' (Maybe [SimulationClock]) (Maybe [Domain])
- newLiveSimulationState :: LiveSimulationState
- data LogDestination = LogDestination' (Maybe CloudWatchLogsLogGroup)
- newLogDestination :: LogDestination
- data LoggingConfiguration = LoggingConfiguration' (Maybe [LogDestination])
- newLoggingConfiguration :: LoggingConfiguration
- data S3Location = S3Location' (Maybe Text) (Maybe Text)
- newS3Location :: S3Location
- data SimulationAppEndpointInfo = SimulationAppEndpointInfo' (Maybe Text) (Maybe [SimulationAppPortMapping])
- newSimulationAppEndpointInfo :: SimulationAppEndpointInfo
- data SimulationAppMetadata = SimulationAppMetadata' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SimulationAppStatus) (Maybe SimulationAppTargetStatus)
- newSimulationAppMetadata :: SimulationAppMetadata
- data SimulationAppPortMapping = SimulationAppPortMapping' (Maybe Natural) (Maybe Natural)
- newSimulationAppPortMapping :: SimulationAppPortMapping
- data SimulationClock = SimulationClock' (Maybe ClockStatus) (Maybe ClockTargetStatus)
- newSimulationClock :: SimulationClock
- data SimulationMetadata = SimulationMetadata' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe SimulationStatus) (Maybe SimulationTargetStatus)
- newSimulationMetadata :: SimulationMetadata
Service Configuration
defaultService :: Service Source #
API version 2022-10-28
of the Amazon SimSpace Weaver SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by SimSpaceWeaver
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
TooManyTagsException
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DeleteApp
See: newDeleteApp
smart constructor.
Instances
Create a value of DeleteApp
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:app:DeleteApp'
, deleteApp_app
- The name of the app.
DeleteApp
, deleteApp_domain
- The name of the domain of the app.
DeleteApp
, deleteApp_simulation
- The name of the simulation of the app.
data DeleteAppResponse Source #
See: newDeleteAppResponse
smart constructor.
Instances
Create a value of DeleteAppResponse
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:httpStatus:DeleteAppResponse'
, deleteAppResponse_httpStatus
- The response's http status code.
DeleteSimulation
data DeleteSimulation Source #
See: newDeleteSimulation
smart constructor.
Instances
Create a value of DeleteSimulation
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:
DeleteSimulation
, deleteSimulation_simulation
- The name of the simulation.
data DeleteSimulationResponse Source #
See: newDeleteSimulationResponse
smart constructor.
Instances
newDeleteSimulationResponse Source #
Create a value of DeleteSimulationResponse
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:httpStatus:DeleteSimulationResponse'
, deleteSimulationResponse_httpStatus
- The response's http status code.
DescribeApp
data DescribeApp Source #
See: newDescribeApp
smart constructor.
Instances
Create a value of DescribeApp
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:app:DescribeApp'
, describeApp_app
- The name of the app.
DescribeApp
, describeApp_domain
- The name of the domain of the app.
DescribeApp
, describeApp_simulation
- The name of the simulation of the app.
data DescribeAppResponse Source #
See: newDescribeAppResponse
smart constructor.
DescribeAppResponse' (Maybe Text) (Maybe Text) (Maybe SimulationAppEndpointInfo) (Maybe LaunchOverrides) (Maybe Text) (Maybe Text) (Maybe SimulationAppStatus) (Maybe SimulationAppTargetStatus) Int |
Instances
newDescribeAppResponse Source #
Create a value of DescribeAppResponse
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:description:DescribeAppResponse'
, describeAppResponse_description
- The description of the app.
DescribeApp
, describeAppResponse_domain
- The name of the domain of the app.
$sel:endpointInfo:DescribeAppResponse'
, describeAppResponse_endpointInfo
- Information about the network endpoint for the custom app. You can use
the endpoint to connect to the custom app.
$sel:launchOverrides:DescribeAppResponse'
, describeAppResponse_launchOverrides
- Undocumented member.
DescribeAppResponse
, describeAppResponse_name
- The name of the app.
DescribeApp
, describeAppResponse_simulation
- The name of the simulation of the app.
DescribeAppResponse
, describeAppResponse_status
- The current lifecycle state of the custom app.
DescribeAppResponse
, describeAppResponse_targetStatus
- The desired lifecycle state of the custom app.
$sel:httpStatus:DescribeAppResponse'
, describeAppResponse_httpStatus
- The response's http status code.
DescribeSimulation
data DescribeSimulation Source #
See: newDescribeSimulation
smart constructor.
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.
data DescribeSimulationResponse Source #
See: newDescribeSimulationResponse
smart constructor.
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.
ListApps
See: newListApps
smart constructor.
Instances
Create a value of ListApps
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:
ListApps
, listApps_domain
- The name of the domain that you want to list apps for.
$sel:maxResults:ListApps'
, listApps_maxResults
- The maximum number of apps to list.
ListApps
, listApps_nextToken
- 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
, listApps_simulation
- The name of the simulation that you want to list apps for.
data ListAppsResponse Source #
See: newListAppsResponse
smart constructor.
Instances
Create a value of ListAppsResponse
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:apps:ListAppsResponse'
, listAppsResponse_apps
- The list of apps for the given simulation and domain.
ListApps
, listAppsResponse_nextToken
- 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.
$sel:httpStatus:ListAppsResponse'
, listAppsResponse_httpStatus
- The response's http status code.
ListSimulations
data ListSimulations Source #
See: newListSimulations
smart constructor.
Instances
newListSimulations :: ListSimulations Source #
Create a value of ListSimulations
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:maxResults:ListSimulations'
, listSimulations_maxResults
- The maximum number of simulations to list.
ListSimulations
, listSimulations_nextToken
- 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.
data ListSimulationsResponse Source #
See: newListSimulationsResponse
smart constructor.
Instances
newListSimulationsResponse Source #
Create a value of ListSimulationsResponse
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:
ListSimulations
, listSimulationsResponse_nextToken
- 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.
$sel:simulations:ListSimulationsResponse'
, listSimulationsResponse_simulations
- The list of simulations.
$sel:httpStatus:ListSimulationsResponse'
, listSimulationsResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- 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.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The list of tags for the resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
StartApp
See: newStartApp
smart constructor.
Instances
Create a value of StartApp
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:StartApp'
, startApp_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:StartApp'
, startApp_description
- The description of the app.
$sel:launchOverrides:StartApp'
, startApp_launchOverrides
- Undocumented member.
StartApp
, startApp_domain
- The name of the domain of the app.
StartApp
, startApp_name
- The name of the app.
StartApp
, startApp_simulation
- The name of the simulation of the app.
data StartAppResponse Source #
See: newStartAppResponse
smart constructor.
Instances
Create a value of StartAppResponse
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:
StartApp
, startAppResponse_domain
- The name of the domain of the app.
StartApp
, startAppResponse_name
- The name of the app.
StartApp
, startAppResponse_simulation
- The name of the simulation of the app.
$sel:httpStatus:StartAppResponse'
, startAppResponse_httpStatus
- The response's http status code.
StartClock
data StartClock Source #
See: newStartClock
smart constructor.
Instances
:: Text | |
-> StartClock |
Create a value of StartClock
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:
StartClock
, startClock_simulation
- The name of the simulation.
data StartClockResponse Source #
See: newStartClockResponse
smart constructor.
Instances
newStartClockResponse Source #
Create a value of StartClockResponse
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:httpStatus:StartClockResponse'
, startClockResponse_httpStatus
- The response's http status code.
StartSimulation
data StartSimulation Source #
See: newStartSimulation
smart constructor.
StartSimulation' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text Text S3Location |
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
.
data StartSimulationResponse Source #
See: newStartSimulationResponse
smart constructor.
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.
StopApp
See: newStopApp
smart constructor.
Instances
Create a value of StopApp
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:app:StopApp'
, stopApp_app
- The name of the app.
StopApp
, stopApp_domain
- The name of the domain of the app.
StopApp
, stopApp_simulation
- The name of the simulation of the app.
data StopAppResponse Source #
See: newStopAppResponse
smart constructor.
Instances
Create a value of StopAppResponse
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:httpStatus:StopAppResponse'
, stopAppResponse_httpStatus
- The response's http status code.
StopClock
See: newStopClock
smart constructor.
Instances
Create a value of StopClock
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:
StopClock
, stopClock_simulation
- The name of the simulation.
data StopClockResponse Source #
See: newStopClockResponse
smart constructor.
Instances
Create a value of StopClockResponse
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:httpStatus:StopClockResponse'
, stopClockResponse_httpStatus
- The response's http status code.
StopSimulation
data StopSimulation Source #
See: newStopSimulation
smart constructor.
Instances
Create a value of StopSimulation
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:
StopSimulation
, stopSimulation_simulation
- The name of the simulation.
data StopSimulationResponse Source #
See: newStopSimulationResponse
smart constructor.
Instances
newStopSimulationResponse Source #
Create a value of StopSimulationResponse
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:httpStatus:StopSimulationResponse'
, stopSimulationResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceArn:TagResource'
, tagResource_resourceArn
- 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.
$sel:tags:TagResource'
, tagResource_tags
- A list of tags to apply to the resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceArn:UntagResource'
, untagResource_resourceArn
- 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.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- A list of tag keys to remove from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
Types
ClockStatus
newtype ClockStatus Source #
pattern ClockStatus_STARTED :: ClockStatus | |
pattern ClockStatus_STARTING :: ClockStatus | |
pattern ClockStatus_STOPPED :: ClockStatus | |
pattern ClockStatus_STOPPING :: ClockStatus | |
pattern ClockStatus_UNKNOWN :: ClockStatus |
Instances
ClockTargetStatus
newtype ClockTargetStatus Source #
pattern ClockTargetStatus_STARTED :: ClockTargetStatus | |
pattern ClockTargetStatus_STOPPED :: ClockTargetStatus | |
pattern ClockTargetStatus_UNKNOWN :: ClockTargetStatus |
Instances
LifecycleManagementStrategy
newtype LifecycleManagementStrategy Source #
Instances
SimulationAppStatus
newtype SimulationAppStatus Source #
pattern SimulationAppStatus_ERROR :: SimulationAppStatus | |
pattern SimulationAppStatus_STARTED :: SimulationAppStatus | |
pattern SimulationAppStatus_STARTING :: SimulationAppStatus | |
pattern SimulationAppStatus_STOPPED :: SimulationAppStatus | |
pattern SimulationAppStatus_STOPPING :: SimulationAppStatus | |
pattern SimulationAppStatus_UNKNOWN :: SimulationAppStatus |
Instances
SimulationAppTargetStatus
newtype SimulationAppTargetStatus Source #
Instances
SimulationStatus
newtype SimulationStatus Source #
pattern SimulationStatus_DELETED :: SimulationStatus | |
pattern SimulationStatus_DELETING :: SimulationStatus | |
pattern SimulationStatus_FAILED :: SimulationStatus | |
pattern SimulationStatus_STARTED :: SimulationStatus | |
pattern SimulationStatus_STARTING :: SimulationStatus | |
pattern SimulationStatus_STOPPED :: SimulationStatus | |
pattern SimulationStatus_STOPPING :: SimulationStatus | |
pattern SimulationStatus_UNKNOWN :: SimulationStatus |
Instances
SimulationTargetStatus
newtype SimulationTargetStatus Source #
Instances
CloudWatchLogsLogGroup
data CloudWatchLogsLogGroup Source #
The Amazon CloudWatch Logs log group for the simulation. For more information about log groups, see Working with log groups and log streams in the Amazon CloudWatch Logs User Guide.
See: newCloudWatchLogsLogGroup
smart constructor.
Instances
newCloudWatchLogsLogGroup :: CloudWatchLogsLogGroup Source #
Create a value of CloudWatchLogsLogGroup
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:logGroupArn:CloudWatchLogsLogGroup'
, cloudWatchLogsLogGroup_logGroupArn
- 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
A collection of app instances that run the same executable app code and have the same launch options and commands.
For more information about domains, see Key concepts in the Amazon Web Services SimSpace Weaver User Guide.
See: newDomain
smart constructor.
Instances
FromJSON Domain Source # | |
Generic Domain Source # | |
Read Domain Source # | |
Show Domain Source # | |
NFData Domain Source # | |
Defined in Amazonka.SimSpaceWeaver.Types.Domain | |
Eq Domain Source # | |
Hashable Domain Source # | |
Defined in Amazonka.SimSpaceWeaver.Types.Domain | |
type Rep Domain Source # | |
Defined in Amazonka.SimSpaceWeaver.Types.Domain type Rep Domain = D1 ('MetaData "Domain" "Amazonka.SimSpaceWeaver.Types.Domain" "amazonka-simspaceweaver-2.0-C619ppqhgbWKEJKYoFCug9" 'False) (C1 ('MetaCons "Domain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lifecycle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LifecycleManagementStrategy)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
Create a value of Domain
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:lifecycle:Domain'
, domain_lifecycle
- 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 workerBySpatialSubdivision
– Managed: SimSpace Weaver starts 1 app for each spatial partitionByRequest
– 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).
$sel:name:Domain'
, domain_name
- The name of the domain.
LaunchOverrides
data LaunchOverrides Source #
Options that apply when the app starts. These optiAons override default behavior.
See: newLaunchOverrides
smart constructor.
Instances
newLaunchOverrides :: LaunchOverrides Source #
Create a value of LaunchOverrides
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:launchCommands:LaunchOverrides'
, launchOverrides_launchCommands
- App launch commands and command line parameters that override the launch
command configured in the simulation schema.
LiveSimulationState
data LiveSimulationState Source #
A collection of additional state information, such as domain and clock configuration.
See: newLiveSimulationState
smart constructor.
Instances
newLiveSimulationState :: LiveSimulationState Source #
Create a value of LiveSimulationState
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:clocks:LiveSimulationState'
, liveSimulationState_clocks
- A list of simulation clocks.
At this time, a simulation has only one clock.
$sel:domains:LiveSimulationState'
, liveSimulationState_domains
- 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
data LogDestination Source #
The location where SimSpace Weaver sends simulation log data.
See: newLogDestination
smart constructor.
Instances
newLogDestination :: LogDestination Source #
Create a value of LogDestination
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:cloudWatchLogsLogGroup:LogDestination'
, logDestination_cloudWatchLogsLogGroup
- 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
data LoggingConfiguration Source #
The logging configuration for a simulation.
See: newLoggingConfiguration
smart constructor.
Instances
newLoggingConfiguration :: LoggingConfiguration Source #
Create a value of LoggingConfiguration
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:destinations:LoggingConfiguration'
, loggingConfiguration_destinations
- A list of the locations where SimSpace Weaver sends simulation log data.
S3Location
data S3Location Source #
A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app zip files and schema file. For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .
See: newS3Location
smart constructor.
S3Location' (Maybe Text) (Maybe Text) |
Instances
newS3Location :: S3Location Source #
Create a value of S3Location
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:bucketName:S3Location'
, s3Location_bucketName
- 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.
$sel:objectKey:S3Location'
, s3Location_objectKey
- 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
data SimulationAppEndpointInfo Source #
Information about the network endpoint that you can use to connect to your custom or service app.
See: newSimulationAppEndpointInfo
smart constructor.
Instances
newSimulationAppEndpointInfo :: SimulationAppEndpointInfo Source #
Create a value of SimulationAppEndpointInfo
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:address:SimulationAppEndpointInfo'
, simulationAppEndpointInfo_address
- The IP address of the app. SimSpace Weaver dynamically assigns this IP
address when the app starts.
$sel:ingressPortMappings:SimulationAppEndpointInfo'
, simulationAppEndpointInfo_ingressPortMappings
- The inbound TCP/UDP port numbers of the app. The combination of an IP
address and a port number form a network endpoint.
SimulationAppMetadata
data SimulationAppMetadata Source #
A collection of metadata about an app.
See: newSimulationAppMetadata
smart constructor.
SimulationAppMetadata' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SimulationAppStatus) (Maybe SimulationAppTargetStatus) |
Instances
newSimulationAppMetadata :: SimulationAppMetadata Source #
Create a value of SimulationAppMetadata
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:domain:SimulationAppMetadata'
, simulationAppMetadata_domain
- The domain of the app. For more information about domains, see
Key concepts
in the Amazon Web Services SimSpace Weaver User Guide.
$sel:name:SimulationAppMetadata'
, simulationAppMetadata_name
- The name of the app.
$sel:simulation:SimulationAppMetadata'
, simulationAppMetadata_simulation
- The name of the simulation of the app.
$sel:status:SimulationAppMetadata'
, simulationAppMetadata_status
- The current status of the app.
$sel:targetStatus:SimulationAppMetadata'
, simulationAppMetadata_targetStatus
- The desired status of the app.
SimulationAppPortMapping
data SimulationAppPortMapping Source #
A collection of TCP/UDP ports for a custom or service app.
See: newSimulationAppPortMapping
smart constructor.
Instances
newSimulationAppPortMapping :: SimulationAppPortMapping Source #
Create a value of SimulationAppPortMapping
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:actual:SimulationAppPortMapping'
, simulationAppPortMapping_actual
- 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.
$sel:declared:SimulationAppPortMapping'
, simulationAppPortMapping_declared
- 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
data SimulationClock Source #
Status information about the simulation clock.
See: newSimulationClock
smart constructor.
Instances
newSimulationClock :: SimulationClock Source #
Create a value of SimulationClock
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:status:SimulationClock'
, simulationClock_status
- The current status of the simulation clock.
$sel:targetStatus:SimulationClock'
, simulationClock_targetStatus
- The desired status of the simulation clock.
SimulationMetadata
data SimulationMetadata Source #
A collection of data about the simulation.
See: newSimulationMetadata
smart constructor.
SimulationMetadata' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe SimulationStatus) (Maybe SimulationTargetStatus) |
Instances
newSimulationMetadata :: SimulationMetadata Source #
Create a value of SimulationMetadata
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:arn:SimulationMetadata'
, simulationMetadata_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.
$sel:creationTime:SimulationMetadata'
, simulationMetadata_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:name:SimulationMetadata'
, simulationMetadata_name
- The name of the simulation.
$sel:status:SimulationMetadata'
, simulationMetadata_status
- The current status of the simulation.
$sel:targetStatus:SimulationMetadata'
, simulationMetadata_targetStatus
- The desired status of the simulation.