2022/11/29 - AWS SimSpace Weaver - 15 new api methods
Changes AWS SimSpace Weaver is a new service that helps customers build spatial simulations at new levels of scale - resulting in virtual worlds with millions of dynamic entities. See the AWS SimSpace Weaver developer guide for more details on how to get started. https://docs.aws.amazon.com/simspaceweaver
Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.
See also: AWS API Documentation
Request Syntax
client.list_simulations(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of simulations to list.
string
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.
dict
Response Syntax
{
'NextToken': 'string',
'Simulations': [
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'Name': 'string',
'Status': 'UNKNOWN'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
'TargetStatus': 'UNKNOWN'|'STARTED'|'STOPPED'|'DELETED'
},
]
}
Response Structure
(dict) --
NextToken (string) --
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.
Simulations (list) --
The list of simulations.
(dict) --
A collection of data about the simulation.
Arn (string) --
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 (datetime) --
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).
Name (string) --
The name of the simulation.
Status (string) --
The current status of the simulation.
TargetStatus (string) --
The desired status of the simulation.
Starts a custom app with the configuration specified in the simulation schema.
See also: AWS API Documentation
Request Syntax
client.start_app(
ClientToken='string',
Description='string',
Domain='string',
LaunchOverrides={
'LaunchCommands': [
'string',
]
},
Name='string',
Simulation='string'
)
string
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.
This field is autopopulated if not provided.
string
The description of the app.
string
[REQUIRED]
The name of the domain of the app.
dict
Options that apply when the app starts. These optiAons override default behavior.
LaunchCommands (list) --
App launch commands and command line parameters that override the launch command configured in the simulation schema.
(string) --
string
[REQUIRED]
The name of the app.
string
[REQUIRED]
The name of the simulation of the app.
dict
Response Syntax
{
'Domain': 'string',
'Name': 'string',
'Simulation': 'string'
}
Response Structure
(dict) --
Domain (string) --
The name of the domain of the app.
Name (string) --
The name of the app.
Simulation (string) --
The name of the simulation of the app.
Deletes the instance of the given custom app.
See also: AWS API Documentation
Request Syntax
client.delete_app(
App='string',
Domain='string',
Simulation='string'
)
string
[REQUIRED]
The name of the app.
string
[REQUIRED]
The name of the domain of the app.
string
[REQUIRED]
The name of the simulation of the app.
dict
Response Syntax
{}
Response Structure
(dict) --
Starts the simulation clock.
See also: AWS API Documentation
Request Syntax
client.start_clock(
Simulation='string'
)
string
[REQUIRED]
The name of the simulation.
dict
Response Syntax
{}
Response Structure
(dict) --
Stops the given custom app and shuts down all of its allocated compute resources.
See also: AWS API Documentation
Request Syntax
client.stop_app(
App='string',
Domain='string',
Simulation='string'
)
string
[REQUIRED]
The name of the app.
string
[REQUIRED]
The name of the domain of the app.
string
[REQUIRED]
The name of the simulation of the app.
dict
Response Syntax
{}
Response Structure
(dict) --
Adds tags to a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference .
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
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 .
dict
[REQUIRED]
A list of tags to apply to the resource.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes all SimSpace Weaver resources assigned to the given simulation.
Note
Your simulation uses resources in other Amazon Web Services services. This API operation doesn't delete resources in other Amazon Web Services services.
See also: AWS API Documentation
Request Syntax
client.delete_simulation(
Simulation='string'
)
string
[REQUIRED]
The name of the simulation.
dict
Response Syntax
{}
Response Structure
(dict) --
Stops the simulation clock.
See also: AWS API Documentation
Request Syntax
client.stop_clock(
Simulation='string'
)
string
[REQUIRED]
The name of the simulation.
dict
Response Syntax
{}
Response Structure
(dict) --
Stops the given simulation.
Warning
You can't restart a simulation after you stop it. If you need to restart a simulation, you must stop it, delete it, and start a new instance of it.
See also: AWS API Documentation
Request Syntax
client.stop_simulation(
Simulation='string'
)
string
[REQUIRED]
The name of the simulation.
dict
Response Syntax
{}
Response Structure
(dict) --
Removes tags from a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference .
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
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 .
list
[REQUIRED]
A list of tag keys to remove from the resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Starts a simulation with the given name and schema.
See also: AWS API Documentation
Request Syntax
client.start_simulation(
ClientToken='string',
Description='string',
MaximumDuration='string',
Name='string',
RoleArn='string',
SchemaS3Location={
'BucketName': 'string',
'ObjectKey': 'string'
},
Tags={
'string': 'string'
}
)
string
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.
This field is autopopulated if not provided.
string
The description of the simulation.
string
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.
string
[REQUIRED]
The name of the simulation.
string
[REQUIRED]
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 .
dict
[REQUIRED]
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 https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html`__ .
BucketName (string) --
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 .
ObjectKey (string) --
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 .
dict
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 .
(string) --
(string) --
dict
Response Syntax
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'ExecutionId': 'string'
}
Response Structure
(dict) --
Arn (string) --
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 (datetime) --
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 (string) --
A universally unique identifier (UUID) for this simulation.
Returns the state of the given custom app.
See also: AWS API Documentation
Request Syntax
client.describe_app(
App='string',
Domain='string',
Simulation='string'
)
string
[REQUIRED]
The name of the app.
string
[REQUIRED]
The name of the domain of the app.
string
[REQUIRED]
The name of the simulation of the app.
dict
Response Syntax
{
'Description': 'string',
'Domain': 'string',
'EndpointInfo': {
'Address': 'string',
'IngressPortMappings': [
{
'Actual': 123,
'Declared': 123
},
]
},
'LaunchOverrides': {
'LaunchCommands': [
'string',
]
},
'Name': 'string',
'Simulation': 'string',
'Status': 'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'ERROR'|'UNKNOWN',
'TargetStatus': 'UNKNOWN'|'STARTED'|'STOPPED'
}
Response Structure
(dict) --
Description (string) --
The description of the app.
Domain (string) --
The name of the domain of the app.
EndpointInfo (dict) --
Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.
Address (string) --
The IP address of the app. SimSpace Weaver dynamically assigns this IP address when the app starts.
IngressPortMappings (list) --
The inbound TCP/UDP port numbers of the app. The combination of an IP address and a port number form a network endpoint.
(dict) --
A collection of TCP/UDP ports for a custom or service app.
Actual (integer) --
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.
Declared (integer) --
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.
LaunchOverrides (dict) --
Options that apply when the app starts. These optiAons override default behavior.
LaunchCommands (list) --
App launch commands and command line parameters that override the launch command configured in the simulation schema.
(string) --
Name (string) --
The name of the app.
Simulation (string) --
The name of the simulation of the app.
Status (string) --
The current lifecycle state of the custom app.
TargetStatus (string) --
The desired lifecycle state of the custom app.
Lists all tags on a SimSpace Weaver resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
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 .
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Tags (dict) --
The list of tags for the resource.
(string) --
(string) --
Returns the current state of the given simulation.
See also: AWS API Documentation
Request Syntax
client.describe_simulation(
Simulation='string'
)
string
[REQUIRED]
The name of the simulation.
dict
Response Syntax
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'Description': 'string',
'ExecutionId': 'string',
'LiveSimulationState': {
'Clocks': [
{
'Status': 'UNKNOWN'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED',
'TargetStatus': 'UNKNOWN'|'STARTED'|'STOPPED'
},
],
'Domains': [
{
'Lifecycle': 'Unknown'|'PerWorker'|'BySpatialSubdivision'|'ByRequest',
'Name': 'string'
},
]
},
'LoggingConfiguration': {
'Destinations': [
{
'CloudWatchLogsLogGroup': {
'LogGroupArn': 'string'
}
},
]
},
'MaximumDuration': 'string',
'Name': 'string',
'RoleArn': 'string',
'SchemaError': 'string',
'SchemaS3Location': {
'BucketName': 'string',
'ObjectKey': 'string'
},
'Status': 'UNKNOWN'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
'TargetStatus': 'UNKNOWN'|'STARTED'|'STOPPED'|'DELETED'
}
Response Structure
(dict) --
Arn (string) --
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 (datetime) --
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 (string) --
The description of the simulation.
ExecutionId (string) --
A universally unique identifier (UUID) for this simulation.
LiveSimulationState (dict) --
A collection of additional state information, such as domain and clock configuration.
Clocks (list) --
A list of simulation clocks.
Note
At this time, a simulation has only one clock.
(dict) --
Status information about the simulation clock.
Status (string) --
The current status of the simulation clock.
TargetStatus (string) --
The desired status of the simulation clock.
Domains (list) --
A list of domains for the simulation. For more information about domains, see Key concepts in the Amazon Web Services SimSpace Weaver User Guide .
(dict) --
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 .
Lifecycle (string) --
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.
Note
The lifecycle types will change when the service is released for general availability (GA).
Name (string) --
The name of the domain.
LoggingConfiguration (dict) --
Settings that control how SimSpace Weaver handles your simulation log data.
Destinations (list) --
A list of the locations where SimSpace Weaver sends simulation log data.
(dict) --
The location where SimSpace Weaver sends simulation log data.
CloudWatchLogsLogGroup (dict) --
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 .
LogGroupArn (string) --
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 .
MaximumDuration (string) --
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 (string) --
The name of the simulation.
RoleArn (string) --
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 (string) --
An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.
SchemaS3Location (dict) --
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 https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html`__ .
BucketName (string) --
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 .
ObjectKey (string) --
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 .
Status (string) --
The current lifecycle state of the simulation.
TargetStatus (string) --
The desired lifecycle state of the simulation.
Lists all custom apps or service apps for the given simulation and domain.
See also: AWS API Documentation
Request Syntax
client.list_apps(
Domain='string',
MaxResults=123,
NextToken='string',
Simulation='string'
)
string
The name of the domain that you want to list apps for.
integer
The maximum number of apps to list.
string
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.
string
[REQUIRED]
The name of the simulation that you want to list apps for.
dict
Response Syntax
{
'Apps': [
{
'Domain': 'string',
'Name': 'string',
'Simulation': 'string',
'Status': 'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'ERROR'|'UNKNOWN',
'TargetStatus': 'UNKNOWN'|'STARTED'|'STOPPED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Apps (list) --
The list of apps for the given simulation and domain.
(dict) --
A collection of metadata about an app.
Domain (string) --
The domain of the app. For more information about domains, see Key concepts in the Amazon Web Services SimSpace Weaver User Guide .
Name (string) --
The name of the app.
Simulation (string) --
The name of the simulation of the app.
Status (string) --
The current status of the app.
TargetStatus (string) --
The desired status of the app.
NextToken (string) --
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.