SDK for PHP 3.x

AWS SimSpace Weaver 2022-10-28

Client: Aws\SimSpaceWeaver\SimSpaceWeaverClient
Service ID: simspaceweaver
Version: 2022-10-28

This page describes the parameters and results for the operations of the AWS SimSpace Weaver (2022-10-28), and shows how to use the Aws\SimSpaceWeaver\SimSpaceWeaverClient object to call the described operations. This documentation is specific to the 2022-10-28 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateSnapshot ( array $params = [] )
Creates a snapshot of the specified simulation.
DeleteApp ( array $params = [] )
Deletes the instance of the given custom app.
DeleteSimulation ( array $params = [] )
Deletes all SimSpace Weaver resources assigned to the given simulation.
DescribeApp ( array $params = [] )
Returns the state of the given custom app.
DescribeSimulation ( array $params = [] )
Returns the current state of the given simulation.
ListApps ( array $params = [] )
Lists all custom apps or service apps for the given simulation and domain.
ListSimulations ( array $params = [] )
Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.
ListTagsForResource ( array $params = [] )
Lists all tags on a SimSpace Weaver resource.
StartApp ( array $params = [] )
Starts a custom app with the configuration specified in the simulation schema.
StartClock ( array $params = [] )
Starts the simulation clock.
StartSimulation ( array $params = [] )
Starts a simulation with the given name.
StopApp ( array $params = [] )
Stops the given custom app and shuts down all of its allocated compute resources.
StopClock ( array $params = [] )
Stops the simulation clock.
StopSimulation ( array $params = [] )
Stops the given simulation.
TagResource ( array $params = [] )
Adds tags to a SimSpace Weaver resource.
UntagResource ( array $params = [] )
Removes tags from a SimSpace Weaver resource.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListApps
ListSimulations

Operations

CreateSnapshot 

$result = $client->createSnapshot([/* ... */]);
$promise = $client->createSnapshotAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createSnapshot([
    'Destination' => [ // REQUIRED
        'BucketName' => '<string>', // REQUIRED
        'ObjectKeyPrefix' => '<string>',
    ],
    'Simulation' => '<string>', // REQUIRED
]);

Parameter Details

Members
Destination
Required: Yes
Type: S3Destination structure

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.

Simulation
Required: Yes
Type: string

The name of the simulation.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

InternalServerException:

AccessDeniedException:

ValidationException:

ConflictException:

DeleteApp 

$result = $client->deleteApp([/* ... */]);
$promise = $client->deleteAppAsync([/* ... */]);

Deletes the instance of the given custom app.

Parameter Syntax

$result = $client->deleteApp([
    'App' => '<string>', // REQUIRED
    'Domain' => '<string>', // REQUIRED
    'Simulation' => '<string>', // REQUIRED
]);

Parameter Details

Members
App
Required: Yes
Type: string

The name of the app.

Domain
Required: Yes
Type: string

The name of the domain of the app.

Simulation
Required: Yes
Type: string

The name of the simulation of the app.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

InternalServerException:

AccessDeniedException:

ValidationException:

ConflictException:

DeleteSimulation 

$result = $client->deleteSimulation([/* ... */]);
$promise = $client->deleteSimulationAsync([/* ... */]);

Deletes all SimSpace Weaver resources assigned to the given simulation.

Your simulation uses resources in other Amazon Web Services. This API operation doesn't delete resources in other Amazon Web Services.

Parameter Syntax

$result = $client->deleteSimulation([
    'Simulation' => '<string>', // REQUIRED
]);

Parameter Details

Members
Simulation
Required: Yes
Type: string

The name of the simulation.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

InternalServerException:

AccessDeniedException:

ValidationException:

ConflictException:

DescribeApp 

$result = $client->describeApp([/* ... */]);
$promise = $client->describeAppAsync([/* ... */]);

Returns the state of the given custom app.

Parameter Syntax

$result = $client->describeApp([
    'App' => '<string>', // REQUIRED
    'Domain' => '<string>', // REQUIRED
    'Simulation' => '<string>', // REQUIRED
]);

Parameter Details

Members
App
Required: Yes
Type: string

The name of the app.

Domain
Required: Yes
Type: string

The name of the domain of the app.

Simulation
Required: Yes
Type: string

The name of the simulation of the app.

Result Syntax

[
    'Description' => '<string>',
    'Domain' => '<string>',
    'EndpointInfo' => [
        'Address' => '<string>',
        'IngressPortMappings' => [
            [
                'Actual' => <integer>,
                'Declared' => <integer>,
            ],
            // ...
        ],
    ],
    'LaunchOverrides' => [
        'LaunchCommands' => ['<string>', ...],
    ],
    'Name' => '<string>',
    'Simulation' => '<string>',
    'Status' => 'STARTING|STARTED|STOPPING|STOPPED|ERROR|UNKNOWN',
    'TargetStatus' => 'UNKNOWN|STARTED|STOPPED',
]

Result Details

Members
Description
Type: string

The description of the app.

Domain
Type: string

The name of the domain of the app.

EndpointInfo
Type: SimulationAppEndpointInfo structure

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

LaunchOverrides
Type: LaunchOverrides structure

Options that apply when the app starts. These options override default behavior.

Name
Type: string

The name of the app.

Simulation
Type: string

The name of the simulation of the app.

Status
Type: string

The current lifecycle state of the custom app.

TargetStatus
Type: string

The desired lifecycle state of the custom app.

Errors

ResourceNotFoundException:

InternalServerException:

AccessDeniedException:

ValidationException:

DescribeSimulation 

$result = $client->describeSimulation([/* ... */]);
$promise = $client->describeSimulationAsync([/* ... */]);

Returns the current state of the given simulation.

Parameter Syntax

$result = $client->describeSimulation([
    'Simulation' => '<string>', // REQUIRED
]);

Parameter Details

Members
Simulation
Required: Yes
Type: string

The name of the simulation.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    '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',
]

Result Details

Members
Arn
Type: 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
Type: timestamp (string|DateTime or anything parsable by strtotime)

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
Type: string

The description of the simulation.

ExecutionId
Type: string

A universally unique identifier (UUID) for this simulation.

LiveSimulationState
Type: LiveSimulationState structure

A collection of additional state information, such as domain and clock configuration.

LoggingConfiguration
Type: LoggingConfiguration structure

Settings that control how SimSpace Weaver handles your simulation log data.

MaximumDuration
Type: 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
Type: string

The name of the simulation.

RoleArn
Type: 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
Type: string

An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.

SchemaS3Location
Type: S3Location structure

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 .

SnapshotS3Location
Type: S3Location structure

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 .

StartError
Type: string

An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the STARTING state.

Status
Type: string

The current lifecycle state of the simulation.

TargetStatus
Type: string

The desired lifecycle state of the simulation.

Errors

ResourceNotFoundException:

InternalServerException:

AccessDeniedException:

ValidationException:

ListApps 

$result = $client->listApps([/* ... */]);
$promise = $client->listAppsAsync([/* ... */]);

Lists all custom apps or service apps for the given simulation and domain.

Parameter Syntax

$result = $client->listApps([
    'Domain' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Simulation' => '<string>', // REQUIRED
]);

Parameter Details

Members
Domain
Type: string

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

MaxResults
Type: int

The maximum number of apps to list.

NextToken
Type: 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
Required: Yes
Type: string

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

Result Syntax

[
    'Apps' => [
        [
            'Domain' => '<string>',
            'Name' => '<string>',
            'Simulation' => '<string>',
            'Status' => 'STARTING|STARTED|STOPPING|STOPPED|ERROR|UNKNOWN',
            'TargetStatus' => 'UNKNOWN|STARTED|STOPPED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Apps
Type: Array of SimulationAppMetadata structures

The list of apps for the given simulation and domain.

NextToken
Type: 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.

Errors

ResourceNotFoundException:

InternalServerException:

AccessDeniedException:

ValidationException:

ListSimulations 

$result = $client->listSimulations([/* ... */]);
$promise = $client->listSimulationsAsync([/* ... */]);

Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.

Parameter Syntax

$result = $client->listSimulations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of simulations to list.

NextToken
Type: 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.

Result Syntax

[
    'NextToken' => '<string>',
    'Simulations' => [
        [
            'Arn' => '<string>',
            'CreationTime' => <DateTime>,
            'Name' => '<string>',
            'Status' => 'UNKNOWN|STARTING|STARTED|STOPPING|STOPPED|FAILED|DELETING|DELETED|SNAPSHOT_IN_PROGRESS',
            'TargetStatus' => 'UNKNOWN|STARTED|STOPPED|DELETED',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: 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
Type: Array of SimulationMetadata structures

The list of simulations.

Errors

InternalServerException:

AccessDeniedException:

ValidationException:

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all tags on a SimSpace Weaver resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

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.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members
Tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tags for the resource.

Errors

ResourceNotFoundException:

ValidationException:

StartApp 

$result = $client->startApp([/* ... */]);
$promise = $client->startAppAsync([/* ... */]);

Starts a custom app with the configuration specified in the simulation schema.

Parameter Syntax

$result = $client->startApp([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'Domain' => '<string>', // REQUIRED
    'LaunchOverrides' => [
        'LaunchCommands' => ['<string>', ...],
    ],
    'Name' => '<string>', // REQUIRED
    'Simulation' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientToken
Type: 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.

Description
Type: string

The description of the app.

Domain
Required: Yes
Type: string

The name of the domain of the app.

LaunchOverrides
Type: LaunchOverrides structure

Options that apply when the app starts. These options override default behavior.

Name
Required: Yes
Type: string

The name of the app.

Simulation
Required: Yes
Type: string

The name of the simulation of the app.

Result Syntax

[
    'Domain' => '<string>',
    'Name' => '<string>',
    'Simulation' => '<string>',
]

Result Details

Members
Domain
Type: string

The name of the domain of the app.

Name
Type: string

The name of the app.

Simulation
Type: string

The name of the simulation of the app.

Errors

InternalServerException:

AccessDeniedException:

ValidationException:

ServiceQuotaExceededException:

ConflictException:

StartClock 

$result = $client->startClock([/* ... */]);
$promise = $client->startClockAsync([/* ... */]);

Starts the simulation clock.

Parameter Syntax

$result = $client->startClock([
    'Simulation' => '<string>', // REQUIRED
]);

Parameter Details

Members
Simulation
Required: Yes
Type: string

The name of the simulation.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

InternalServerException:

AccessDeniedException:

ValidationException:

ConflictException:

StartSimulation 

$result = $client->startSimulation([/* ... */]);
$promise = $client->startSimulationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startSimulation([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'MaximumDuration' => '<string>',
    'Name' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'SchemaS3Location' => [
        'BucketName' => '<string>', // REQUIRED
        'ObjectKey' => '<string>', // REQUIRED
    ],
    'SnapshotS3Location' => [
        'BucketName' => '<string>', // REQUIRED
        'ObjectKey' => '<string>', // REQUIRED
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
ClientToken
Type: 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.

Description
Type: string

The description of the simulation.

MaximumDuration
Type: 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
Required: Yes
Type: string

The name of the simulation.

RoleArn
Required: Yes
Type: 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.

SchemaS3Location
Type: S3Location structure

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.

SnapshotS3Location
Type: S3Location structure

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.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'ExecutionId' => '<string>',
]

Result Details

Members
Arn
Type: 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
Type: timestamp (string|DateTime or anything parsable by strtotime)

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
Type: string

A universally unique identifier (UUID) for this simulation.

Errors

InternalServerException:

AccessDeniedException:

ValidationException:

ServiceQuotaExceededException:

ConflictException:

StopApp 

$result = $client->stopApp([/* ... */]);
$promise = $client->stopAppAsync([/* ... */]);

Stops the given custom app and shuts down all of its allocated compute resources.

Parameter Syntax

$result = $client->stopApp([
    'App' => '<string>', // REQUIRED
    'Domain' => '<string>', // REQUIRED
    'Simulation' => '<string>', // REQUIRED
]);

Parameter Details

Members
App
Required: Yes
Type: string

The name of the app.

Domain
Required: Yes
Type: string

The name of the domain of the app.

Simulation
Required: Yes
Type: string

The name of the simulation of the app.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

InternalServerException:

AccessDeniedException:

ValidationException:

ConflictException:

StopClock 

$result = $client->stopClock([/* ... */]);
$promise = $client->stopClockAsync([/* ... */]);

Stops the simulation clock.

Parameter Syntax

$result = $client->stopClock([
    'Simulation' => '<string>', // REQUIRED
]);

Parameter Details

Members
Simulation
Required: Yes
Type: string

The name of the simulation.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

InternalServerException:

AccessDeniedException:

ValidationException:

ConflictException:

StopSimulation 

$result = $client->stopSimulation([/* ... */]);
$promise = $client->stopSimulationAsync([/* ... */]);

Stops the given simulation.

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.

Parameter Syntax

$result = $client->stopSimulation([
    'Simulation' => '<string>', // REQUIRED
]);

Parameter Details

Members
Simulation
Required: Yes
Type: string

The name of the simulation.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

InternalServerException:

AccessDeniedException:

ValidationException:

ConflictException:

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

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
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

A list of tags to apply to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TooManyTagsException:

ResourceNotFoundException:

ValidationException:

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

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
Required: Yes
Type: Array of strings

A list of tag keys to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

ValidationException:

Shapes

AccessDeniedException

Description

Members
Message
Type: string

CloudWatchLogsLogGroup

Description

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.

Members
LogGroupArn
Type: 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.

ConflictException

Description

Members
Message
Type: string

Domain

Description

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.

Members
Lifecycle
Type: 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
Type: string

The name of the domain.

InternalServerException

Description

Members
Message
Type: string

LaunchOverrides

Description

Options that apply when the app starts. These options override default behavior.

Members
LaunchCommands
Type: Array of strings

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

LiveSimulationState

Description

A collection of additional state information, such as domain and clock configuration.

Members
Clocks
Type: Array of SimulationClock structures

A list of simulation clocks.

At this time, a simulation has only one clock.

Domains
Type: Array of Domain structures

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

LogDestination

Description

The location where SimSpace Weaver sends simulation log data.

Members
CloudWatchLogsLogGroup
Type: CloudWatchLogsLogGroup structure

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

Description

The logging configuration for a simulation.

Members
Destinations
Type: Array of LogDestination structures

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

ResourceNotFoundException

Description

Members
Message
Type: string

S3Destination

Description

An Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates a file.

Members
BucketName
Required: Yes
Type: 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.

ObjectKeyPrefix
Type: 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.

S3Location

Description

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 .

Members
BucketName
Required: Yes
Type: 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
Required: Yes
Type: 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.

ServiceQuotaExceededException

Description

Members
Message
Type: string

SimulationAppEndpointInfo

Description

Information about the network endpoint that you can use to connect to your custom or service app. For more information about SimSpace Weaver apps, see Key concepts: Apps in the SimSpace Weaver User Guide..

Members
Address
Type: string

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

IngressPortMappings
Type: Array of SimulationAppPortMapping structures

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

SimulationAppMetadata

Description

A collection of metadata about the app.

Members
Domain
Type: string

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

Name
Type: string

The name of the app.

Simulation
Type: string

The name of the simulation of the app.

Status
Type: string

The current status of the app.

TargetStatus
Type: string

The desired status of the app.

SimulationAppPortMapping

Description

A collection of TCP/UDP ports for a custom or service app.

Members
Actual
Type: int

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
Type: int

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

Description

Status information about the simulation clock.

Members
Status
Type: string

The current status of the simulation clock.

TargetStatus
Type: string

The desired status of the simulation clock.

SimulationMetadata

Description

A collection of data about the simulation.

Members
Arn
Type: 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
Type: timestamp (string|DateTime or anything parsable by strtotime)

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
Type: string

The name of the simulation.

Status
Type: string

The current status of the simulation.

TargetStatus
Type: string

The desired status of the simulation.

TooManyTagsException

Description

Members
Message
Type: string

ValidationException

Description

Members
Message
Type: string