SimSpaceWeaver ************** Client ====== class SimSpaceWeaver.Client A low-level client representing AWS SimSpace Weaver SimSpace Weaver (SimSpace Weaver) is a service that you can use to build and run large-scale spatial simulations in the Amazon Web Services Cloud. For example, you can create crowd simulations, large real-world environments, and immersive and interactive experiences. For more information about SimSpace Weaver, see the 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. This documentation is part of the SimSpace Weaver app SDK distributable package. import boto3 client = boto3.client('simspaceweaver') These are the available methods: * can_paginate * close * create_snapshot * delete_app * delete_simulation * describe_app * describe_simulation * get_paginator * get_waiter * list_apps * list_simulations * list_tags_for_resource * start_app * start_clock * start_simulation * stop_app * stop_clock * stop_simulation * tag_resource * untag_resource SimSpaceWeaver / Client / stop_simulation stop_simulation *************** SimSpaceWeaver.Client.stop_simulation(**kwargs) Stops the given simulation. Warning: You can't restart a simulation after you stop it. If you want to restart a simulation, then you must stop it, delete it, and start a new instance of it. See also: AWS API Documentation **Request Syntax** response = client.stop_simulation( Simulation='string' ) Parameters: **Simulation** (*string*) -- **[REQUIRED]** The name of the simulation. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SimSpaceWeaver.Client.exceptions.ResourceNotFoundException" * "SimSpaceWeaver.Client.exceptions.InternalServerException" * "SimSpaceWeaver.Client.exceptions.AccessDeniedException" * "SimSpaceWeaver.Client.exceptions.ValidationException" * "SimSpaceWeaver.Client.exceptions.ConflictException" SimSpaceWeaver / Client / create_snapshot create_snapshot *************** SimSpaceWeaver.Client.create_snapshot(**kwargs) Creates a snapshot of the specified simulation. A snapshot is a file that contains simulation state data at a specific time. The state data saved in a snapshot includes entity data from the State Fabric, the simulation configuration specified in the schema, and the clock tick number. You can use the snapshot to initialize a new simulation. For more information about snapshots, see Snapshots in the *SimSpace Weaver User Guide*. You specify a "Destination" when you create a snapshot. The "Destination" is the name of an Amazon S3 bucket and an optional "ObjectKeyPrefix". The "ObjectKeyPrefix" is usually the name of a folder in the bucket. SimSpace Weaver creates a "snapshot" folder inside the "Destination" and places the snapshot file there. The snapshot file is an Amazon S3 object. It has an object key with the form: "object-key-prefix/snapshot/simulation-name-YYMMdd-HHmm- ss.zip", where: * "YY" is the 2-digit year * "MM" is the 2-digit month * "dd" is the 2-digit day of the month * "HH" is the 2-digit hour (24-hour clock) * "mm" is the 2-digit minutes * "ss" is the 2-digit seconds See also: AWS API Documentation **Request Syntax** response = client.create_snapshot( Destination={ 'BucketName': 'string', 'ObjectKeyPrefix': 'string' }, Simulation='string' ) Parameters: * **Destination** (*dict*) -- **[REQUIRED]** The Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates the snapshot file. The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation. * **BucketName** *(string) --* **[REQUIRED]** 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*. * **ObjectKeyPrefix** *(string) --* A string prefix for an Amazon S3 object key. It's usually a folder name. For more information about folders in Amazon S3, see Organizing objects in the Amazon S3 console using folders in the *Amazon Simple Storage Service User Guide*. * **Simulation** (*string*) -- **[REQUIRED]** The name of the simulation. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SimSpaceWeaver.Client.exceptions.ResourceNotFoundException" * "SimSpaceWeaver.Client.exceptions.InternalServerException" * "SimSpaceWeaver.Client.exceptions.AccessDeniedException" * "SimSpaceWeaver.Client.exceptions.ValidationException" * "SimSpaceWeaver.Client.exceptions.ConflictException" SimSpaceWeaver / Client / get_paginator get_paginator ************* SimSpaceWeaver.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. SimSpaceWeaver / Client / start_clock start_clock *********** SimSpaceWeaver.Client.start_clock(**kwargs) Starts the simulation clock. See also: AWS API Documentation **Request Syntax** response = client.start_clock( Simulation='string' ) Parameters: **Simulation** (*string*) -- **[REQUIRED]** The name of the simulation. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SimSpaceWeaver.Client.exceptions.ResourceNotFoundException" * "SimSpaceWeaver.Client.exceptions.InternalServerException" * "SimSpaceWeaver.Client.exceptions.AccessDeniedException" * "SimSpaceWeaver.Client.exceptions.ValidationException" * "SimSpaceWeaver.Client.exceptions.ConflictException" SimSpaceWeaver / Client / can_paginate can_paginate ************ SimSpaceWeaver.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. SimSpaceWeaver / Client / start_app start_app ********* SimSpaceWeaver.Client.start_app(**kwargs) Starts a custom app with the configuration specified in the simulation schema. See also: AWS API Documentation **Request Syntax** response = client.start_app( ClientToken='string', Description='string', Domain='string', LaunchOverrides={ 'LaunchCommands': [ 'string', ] }, Name='string', Simulation='string' ) Parameters: * **ClientToken** (*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. * **Description** (*string*) -- The description of the app. * **Domain** (*string*) -- **[REQUIRED]** The name of the domain of the app. * **LaunchOverrides** (*dict*) -- Options that apply when the app starts. These options 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*) -- **[REQUIRED]** The name of the app. * **Simulation** (*string*) -- **[REQUIRED]** The name of the simulation of the app. Return type: dict Returns: **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. **Exceptions** * "SimSpaceWeaver.Client.exceptions.InternalServerException" * "SimSpaceWeaver.Client.exceptions.AccessDeniedException" * "SimSpaceWeaver.Client.exceptions.ValidationException" * "SimSpaceWeaver.Client.exceptions.ServiceQuotaExceededException" * "SimSpaceWeaver.Client.exceptions.ConflictException" SimSpaceWeaver / Client / start_simulation start_simulation **************** SimSpaceWeaver.Client.start_simulation(**kwargs) Starts a simulation with the given name. You must choose to start your simulation from a schema or from a snapshot. For more information about the schema, see the schema reference in the *SimSpace Weaver User Guide*. For more information about snapshots, see Snapshots in the *SimSpace Weaver User Guide*. See also: AWS API Documentation **Request Syntax** response = client.start_simulation( ClientToken='string', Description='string', MaximumDuration='string', Name='string', RoleArn='string', SchemaS3Location={ 'BucketName': 'string', 'ObjectKey': 'string' }, SnapshotS3Location={ 'BucketName': 'string', 'ObjectKey': 'string' }, Tags={ 'string': 'string' } ) Parameters: * **ClientToken** (*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. * **Description** (*string*) -- The description of the simulation. * **MaximumDuration** (*string*) -- The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches this limit. The maximum value is "14D", or its equivalent in the other units. The default value is "14D". A value equivalent to "0" makes the simulation immediately transition to "Stopping" as soon as it reaches "Started". * **Name** (*string*) -- **[REQUIRED]** The name of the simulation. * **RoleArn** (*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*. * **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. Provide a "SchemaS3Location" to start your simulation from a schema. If you provide a "SchemaS3Location" then you can't provide a "SnapshotS3Location". * **BucketName** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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*. * **SnapshotS3Location** (*dict*) -- The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide. Provide a "SnapshotS3Location" to start your simulation from a snapshot. The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation. If you provide a "SnapshotS3Location" then you can't provide a "SchemaS3Location". * **BucketName** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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*. * **Tags** (*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) --* Return type: dict Returns: **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. **Exceptions** * "SimSpaceWeaver.Client.exceptions.InternalServerException" * "SimSpaceWeaver.Client.exceptions.AccessDeniedException" * "SimSpaceWeaver.Client.exceptions.ValidationException" * "SimSpaceWeaver.Client.exceptions.ServiceQuotaExceededException" * "SimSpaceWeaver.Client.exceptions.ConflictException" SimSpaceWeaver / Client / list_tags_for_resource list_tags_for_resource ********************** SimSpaceWeaver.Client.list_tags_for_resource(**kwargs) Lists all tags on a SimSpace Weaver resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*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*. Return type: dict Returns: **Response Syntax** { 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Tags** *(dict) --* The list of tags for the resource. * *(string) --* * *(string) --* **Exceptions** * "SimSpaceWeaver.Client.exceptions.ResourceNotFoundException" * "SimSpaceWeaver.Client.exceptions.ValidationException" SimSpaceWeaver / Client / untag_resource untag_resource ************** SimSpaceWeaver.Client.untag_resource(**kwargs) 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** response = client.untag_resource( ResourceArn='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceArn** (*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*. * **TagKeys** (*list*) -- **[REQUIRED]** A list of tag keys to remove from the resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SimSpaceWeaver.Client.exceptions.ResourceNotFoundException" * "SimSpaceWeaver.Client.exceptions.ValidationException" SimSpaceWeaver / Client / list_simulations list_simulations **************** SimSpaceWeaver.Client.list_simulations(**kwargs) Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call. See also: AWS API Documentation **Request Syntax** response = client.list_simulations( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of simulations to list. * **NextToken** (*string*) -- If SimSpace Weaver returns "nextToken", then 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, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an *HTTP 400 ValidationException* error. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Simulations': [ { 'Arn': 'string', 'CreationTime': datetime(2015, 1, 1), 'Name': 'string', 'Status': 'UNKNOWN'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'FAILED'|'DELETING'|'DELETED'|'SNAPSHOT_IN_PROGRESS', 'TargetStatus': 'UNKNOWN'|'STARTED'|'STOPPED'|'DELETED' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* If SimSpace Weaver returns "nextToken", then 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, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then 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. **Exceptions** * "SimSpaceWeaver.Client.exceptions.InternalServerException" * "SimSpaceWeaver.Client.exceptions.AccessDeniedException" * "SimSpaceWeaver.Client.exceptions.ValidationException" SimSpaceWeaver / Client / get_waiter get_waiter ********** SimSpaceWeaver.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" SimSpaceWeaver / Client / stop_clock stop_clock ********** SimSpaceWeaver.Client.stop_clock(**kwargs) Stops the simulation clock. See also: AWS API Documentation **Request Syntax** response = client.stop_clock( Simulation='string' ) Parameters: **Simulation** (*string*) -- **[REQUIRED]** The name of the simulation. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SimSpaceWeaver.Client.exceptions.ResourceNotFoundException" * "SimSpaceWeaver.Client.exceptions.InternalServerException" * "SimSpaceWeaver.Client.exceptions.AccessDeniedException" * "SimSpaceWeaver.Client.exceptions.ValidationException" * "SimSpaceWeaver.Client.exceptions.ConflictException" SimSpaceWeaver / Client / describe_simulation describe_simulation ******************* SimSpaceWeaver.Client.describe_simulation(**kwargs) Returns the current state of the given simulation. See also: AWS API Documentation **Request Syntax** response = client.describe_simulation( Simulation='string' ) Parameters: **Simulation** (*string*) -- **[REQUIRED]** The name of the simulation. Return type: dict Returns: **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' }, 'SnapshotS3Location': { 'BucketName': 'string', 'ObjectKey': 'string' }, 'StartError': 'string', 'Status': 'UNKNOWN'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'FAILED'|'DELETING'|'DELETED'|'SNAPSHOT_IN_PROGRESS', '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: Domains in the *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: Domains in the *SimSpace Weaver User Guide*. * **Lifecycle** *(string) --* The type of lifecycle management for apps in the domain. 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 one app on each worker. * "BySpatialSubdivision" – Managed: SimSpace Weaver starts one 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. * **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 minutes (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches this limit. The maximum value is "14D", or its equivalent in the other units. The default value is "14D". A value equivalent to "0" makes the simulation immediately transition to "Stopping" as soon as it reaches "Started". * **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. * **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*. * **SnapshotS3Location** *(dict) --* 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. * **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*. * **StartError** *(string) --* An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the "STARTING" state. * **Status** *(string) --* The current lifecycle state of the simulation. * **TargetStatus** *(string) --* The desired lifecycle state of the simulation. **Exceptions** * "SimSpaceWeaver.Client.exceptions.ResourceNotFoundException" * "SimSpaceWeaver.Client.exceptions.InternalServerException" * "SimSpaceWeaver.Client.exceptions.AccessDeniedException" * "SimSpaceWeaver.Client.exceptions.ValidationException" SimSpaceWeaver / Client / describe_app describe_app ************ SimSpaceWeaver.Client.describe_app(**kwargs) Returns the state of the given custom app. See also: AWS API Documentation **Request Syntax** response = client.describe_app( App='string', Domain='string', Simulation='string' ) Parameters: * **App** (*string*) -- **[REQUIRED]** The name of the app. * **Domain** (*string*) -- **[REQUIRED]** The name of the domain of the app. * **Simulation** (*string*) -- **[REQUIRED]** The name of the simulation of the app. Return type: dict Returns: **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 options 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. **Exceptions** * "SimSpaceWeaver.Client.exceptions.ResourceNotFoundException" * "SimSpaceWeaver.Client.exceptions.InternalServerException" * "SimSpaceWeaver.Client.exceptions.AccessDeniedException" * "SimSpaceWeaver.Client.exceptions.ValidationException" SimSpaceWeaver / Client / list_apps list_apps ********* SimSpaceWeaver.Client.list_apps(**kwargs) Lists all custom apps or service apps for the given simulation and domain. See also: AWS API Documentation **Request Syntax** response = client.list_apps( Domain='string', MaxResults=123, NextToken='string', Simulation='string' ) Parameters: * **Domain** (*string*) -- The name of the domain that you want to list apps for. * **MaxResults** (*integer*) -- The maximum number of apps to list. * **NextToken** (*string*) -- If SimSpace Weaver returns "nextToken", then 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, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an *HTTP 400 ValidationException* error. * **Simulation** (*string*) -- **[REQUIRED]** The name of the simulation that you want to list apps for. Return type: dict Returns: **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 the app. * **Domain** *(string) --* The domain of the app. For more information about domains, see Key concepts: Domains in the *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", then 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, then "nextToken" is set to "null". Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an *HTTP 400 ValidationException* error. **Exceptions** * "SimSpaceWeaver.Client.exceptions.ResourceNotFoundException" * "SimSpaceWeaver.Client.exceptions.InternalServerException" * "SimSpaceWeaver.Client.exceptions.AccessDeniedException" * "SimSpaceWeaver.Client.exceptions.ValidationException" SimSpaceWeaver / Client / close close ***** SimSpaceWeaver.Client.close() Closes underlying endpoint connections. SimSpaceWeaver / Client / stop_app stop_app ******** SimSpaceWeaver.Client.stop_app(**kwargs) Stops the given custom app and shuts down all of its allocated compute resources. See also: AWS API Documentation **Request Syntax** response = client.stop_app( App='string', Domain='string', Simulation='string' ) Parameters: * **App** (*string*) -- **[REQUIRED]** The name of the app. * **Domain** (*string*) -- **[REQUIRED]** The name of the domain of the app. * **Simulation** (*string*) -- **[REQUIRED]** The name of the simulation of the app. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SimSpaceWeaver.Client.exceptions.ResourceNotFoundException" * "SimSpaceWeaver.Client.exceptions.InternalServerException" * "SimSpaceWeaver.Client.exceptions.AccessDeniedException" * "SimSpaceWeaver.Client.exceptions.ValidationException" * "SimSpaceWeaver.Client.exceptions.ConflictException" SimSpaceWeaver / Client / tag_resource tag_resource ************ SimSpaceWeaver.Client.tag_resource(**kwargs) 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** response = client.tag_resource( ResourceArn='string', Tags={ 'string': 'string' } ) Parameters: * **ResourceArn** (*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*. * **Tags** (*dict*) -- **[REQUIRED]** A list of tags to apply to the resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SimSpaceWeaver.Client.exceptions.TooManyTagsException" * "SimSpaceWeaver.Client.exceptions.ResourceNotFoundException" * "SimSpaceWeaver.Client.exceptions.ValidationException" SimSpaceWeaver / Client / delete_app delete_app ********** SimSpaceWeaver.Client.delete_app(**kwargs) Deletes the instance of the given custom app. See also: AWS API Documentation **Request Syntax** response = client.delete_app( App='string', Domain='string', Simulation='string' ) Parameters: * **App** (*string*) -- **[REQUIRED]** The name of the app. * **Domain** (*string*) -- **[REQUIRED]** The name of the domain of the app. * **Simulation** (*string*) -- **[REQUIRED]** The name of the simulation of the app. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SimSpaceWeaver.Client.exceptions.ResourceNotFoundException" * "SimSpaceWeaver.Client.exceptions.InternalServerException" * "SimSpaceWeaver.Client.exceptions.AccessDeniedException" * "SimSpaceWeaver.Client.exceptions.ValidationException" * "SimSpaceWeaver.Client.exceptions.ConflictException" SimSpaceWeaver / Client / delete_simulation delete_simulation ***************** SimSpaceWeaver.Client.delete_simulation(**kwargs) Deletes all SimSpace Weaver resources assigned to the given simulation. Note: Your simulation uses resources in other Amazon Web Services. This API operation doesn't delete resources in other Amazon Web Services. See also: AWS API Documentation **Request Syntax** response = client.delete_simulation( Simulation='string' ) Parameters: **Simulation** (*string*) -- **[REQUIRED]** The name of the simulation. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SimSpaceWeaver.Client.exceptions.ResourceNotFoundException" * "SimSpaceWeaver.Client.exceptions.InternalServerException" * "SimSpaceWeaver.Client.exceptions.AccessDeniedException" * "SimSpaceWeaver.Client.exceptions.ValidationException" * "SimSpaceWeaver.Client.exceptions.ConflictException"