Class: AWS.SimSpaceWeaver

var params = {
  App: 'STRING_VALUE', /* required */
  Domain: 'STRING_VALUE', /* required */
  Simulation: 'STRING_VALUE' /* required */
};
simspaceweaver.deleteApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • App — (String)

    The name of the app.

  • Domain — (String)

    The name of the domain of the app.

  • Simulation — (String)

    The name of the simulation of the app.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Simulation: 'STRING_VALUE' /* required */
};
simspaceweaver.deleteSimulation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Simulation — (String)

    The name of the simulation.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  App: 'STRING_VALUE', /* required */
  Domain: 'STRING_VALUE', /* required */
  Simulation: 'STRING_VALUE' /* required */
};
simspaceweaver.describeApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • App — (String)

    The name of the app.

  • Domain — (String)

    The name of the domain of the app.

  • Simulation — (String)

    The name of the simulation of the app.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Description — (String)

      The description of the app.

    • Domain — (String)

      The name of the domain of the app.

    • EndpointInfo — (map)

      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 — (Array<map>)

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

        • 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 — (map)

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

      • LaunchCommands — (Array<String>)

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

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

      Possible values include:
      • "STARTING"
      • "STARTED"
      • "STOPPING"
      • "STOPPED"
      • "ERROR"
      • "UNKNOWN"
    • TargetStatus — (String)

      The desired lifecycle state of the custom app.

      Possible values include:
      • "UNKNOWN"
      • "STARTED"
      • "STOPPED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Simulation: 'STRING_VALUE' /* required */
};
simspaceweaver.describeSimulation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Simulation — (String)

    The name of the simulation.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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 — (Date)

      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 — (map)

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

      • Clocks — (Array<map>)

        A list of simulation clocks.

        Note: At this time, a simulation has only one clock.
        • Status — (String)

          The current status of the simulation clock.

          Possible values include:
          • "UNKNOWN"
          • "STARTING"
          • "STARTED"
          • "STOPPING"
          • "STOPPED"
        • TargetStatus — (String)

          The desired status of the simulation clock.

          Possible values include:
          • "UNKNOWN"
          • "STARTED"
          • "STOPPED"
      • Domains — (Array<map>)

        A list of domains for the simulation. 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.

          Possible values include:
          • "Unknown"
          • "PerWorker"
          • "BySpatialSubdivision"
          • "ByRequest"
        • Name — (String)

          The name of the domain.

    • LoggingConfiguration — (map)

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

      • Destinations — (Array<map>)

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

        • CloudWatchLogsLogGroup — (map)

          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 — (map)

      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 — required — (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 — (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 — (map)

      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 — required — (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 — (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.

      Possible values include:
      • "UNKNOWN"
      • "STARTING"
      • "STARTED"
      • "STOPPING"
      • "STOPPED"
      • "FAILED"
      • "DELETING"
      • "DELETED"
      • "SNAPSHOT_IN_PROGRESS"
    • TargetStatus — (String)

      The desired lifecycle state of the simulation.

      Possible values include:
      • "UNKNOWN"
      • "STARTED"
      • "STOPPED"
      • "DELETED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Simulation: 'STRING_VALUE', /* required */
  Domain: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
simspaceweaver.listApps(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • 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)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Apps — (Array<map>)

      The list of apps for the given simulation and domain.

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

        Possible values include:
        • "STARTING"
        • "STARTED"
        • "STOPPING"
        • "STOPPED"
        • "ERROR"
        • "UNKNOWN"
      • TargetStatus — (String)

        The desired status of the app.

        Possible values include:
        • "UNKNOWN"
        • "STARTED"
        • "STOPPED"
    • 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
simspaceweaver.listSimulations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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 — (Array<map>)

      The list of simulations.

      • 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 — (Date)

        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.

        Possible values include:
        • "UNKNOWN"
        • "STARTING"
        • "STARTED"
        • "STOPPING"
        • "STOPPED"
        • "FAILED"
        • "DELETING"
        • "DELETED"
        • "SNAPSHOT_IN_PROGRESS"
      • TargetStatus — (String)

        The desired status of the simulation.

        Possible values include:
        • "UNKNOWN"
        • "STARTED"
        • "STOPPED"
        • "DELETED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
simspaceweaver.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (map<String>)

      The list of tags for the resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Domain: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Simulation: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  LaunchOverrides: {
    LaunchCommands: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
simspaceweaver.startApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • 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.

    If a token is not provided, the SDK will use a version 4 UUID.
  • Description — (String)

    The description of the app.

  • Domain — (String)

    The name of the domain of the app.

  • LaunchOverrides — (map)

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

    • LaunchCommands — (Array<String>)

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

  • Name — (String)

    The name of the app.

  • Simulation — (String)

    The name of the simulation of the app.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Simulation: 'STRING_VALUE' /* required */
};
simspaceweaver.startClock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Simulation — (String)

    The name of the simulation.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  MaximumDuration: 'STRING_VALUE',
  SchemaS3Location: {
    BucketName: 'STRING_VALUE', /* required */
    ObjectKey: 'STRING_VALUE' /* required */
  },
  SnapshotS3Location: {
    BucketName: 'STRING_VALUE', /* required */
    ObjectKey: 'STRING_VALUE' /* required */
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
simspaceweaver.startSimulation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • 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.

    If a token is not provided, the SDK will use a version 4 UUID.
  • 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)

    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.

  • SchemaS3Location — (map)

    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 — required — (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 — (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 — (map)

    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 — required — (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 — (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.

  • Tags — (map<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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 — (Date)

      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:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  App: 'STRING_VALUE', /* required */
  Domain: 'STRING_VALUE', /* required */
  Simulation: 'STRING_VALUE' /* required */
};
simspaceweaver.stopApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • App — (String)

    The name of the app.

  • Domain — (String)

    The name of the domain of the app.

  • Simulation — (String)

    The name of the simulation of the app.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Simulation: 'STRING_VALUE' /* required */
};
simspaceweaver.stopClock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Simulation — (String)

    The name of the simulation.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Simulation: 'STRING_VALUE' /* required */
};
simspaceweaver.stopSimulation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Simulation — (String)

    The name of the simulation.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
simspaceweaver.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (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 — (map<String>)

    A list of tags to apply to the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
simspaceweaver.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (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 — (Array<String>)

    A list of tag keys to remove from the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.