create-computation-model¶

Description¶

Create a computation model with a configuration and data binding.

Synopsis¶

  create-computation-model
--computation-model-name <value>
[--computation-model-description <value>]
--computation-model-configuration <value>
--computation-model-data-binding <value>
[--client-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--computation-model-name (string)

The name of the computation model.

--computation-model-description (string)

The description of the computation model.

--computation-model-configuration (structure)

The configuration for the computation model.

anomalyDetection -> (structure)

The configuration for the anomaly detection type of computation model.

inputProperties -> (string)

Define the variable name associated with input properties, with the following format ${VariableName} .

resultProperty -> (string)

Define the variable name associated with the result property, and the following format ${VariableName} .

Shorthand Syntax:

anomalyDetection={inputProperties=string,resultProperty=string}

JSON Syntax:

{
  "anomalyDetection": {
    "inputProperties": "string",
    "resultProperty": "string"
  }
}

--computation-model-data-binding (map)

The data binding for the computation model. Key is a variable name defined in configuration. Value is a ComputationModelDataBindingValue referenced by the variable.

key -> (string)

value -> (structure)

Contains computation model data binding value information, which can be one of assetModelProperty , list .

assetModelProperty -> (structure)

Specifies an asset model property data binding value.

assetModelId -> (string)

The ID of the asset model, in UUID format.

propertyId -> (string)

The ID of the asset model property used in data binding value.

assetProperty -> (structure)

The asset property value used for computation model data binding.

assetId -> (string)

The ID of the asset containing the property. This identifies the specific asset instance’s property value used in the computation model.

propertyId -> (string)

The ID of the property within the asset. This identifies the specific property’s value used in the computation model.

list -> (list)

Specifies a list of data binding value.

(structure)

Contains computation model data binding value information, which can be one of assetModelProperty , list .

assetModelProperty -> (structure)

Specifies an asset model property data binding value.

assetModelId -> (string)

The ID of the asset model, in UUID format.

propertyId -> (string)

The ID of the asset model property used in data binding value.

assetProperty -> (structure)

The asset property value used for computation model data binding.

assetId -> (string)

The ID of the asset containing the property. This identifies the specific asset instance’s property value used in the computation model.

propertyId -> (string)

The ID of the property within the asset. This identifies the specific property’s value used in the computation model.

list -> (list)

Specifies a list of data binding value.

( … recursive … )

JSON Syntax:

{"string": {
      "assetModelProperty": {
        "assetModelId": "string",
        "propertyId": "string"
      },
      "assetProperty": {
        "assetId": "string",
        "propertyId": "string"
      },
      "list": [
        {
          "assetModelProperty": {
            "assetModelId": "string",
            "propertyId": "string"
          },
          "assetProperty": {
            "assetId": "string",
            "propertyId": "string"
          },
          "list": [
            { ... recursive ... }
            ...
          ]
        }
        ...
      ]
    }
  ...}

--client-token (string)

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

--tags (map)

A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide .

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

computationModelId -> (string)

The ID of the computation model.

computationModelArn -> (string)

The ARN of the computation model, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}

computationModelStatus -> (structure)

The status of the computation model, containing a state (CREATING after successfully calling this operation) and any error messages.

state -> (string)

The current state of the computation model.

error -> (structure)

Contains the details of an IoT SiteWise error.

code -> (string)

The error code.

message -> (string)

The error message.

details -> (list)

A list of detailed errors.

(structure)

Contains detailed error information.

code -> (string)

The error code.

message -> (string)

The error message.

Table of Contents

Feedback

User Guide

create-computation-model¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶