Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iottwinmaker ]

create-entity

Description

Creates an entity.

See also: AWS API Documentation

Synopsis

  create-entity
--workspace-id <value>
[--entity-id <value>]
--entity-name <value>
[--description <value>]
[--components <value>]
[--composite-components <value>]
[--parent-entity-id <value>]
[--tags <value>]
[--cli-input-json <value>]
[--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>]

Options

--workspace-id (string)

The ID of the workspace that contains the entity.

--entity-id (string)

The ID of the entity.

--entity-name (string)

The name of the entity.

--description (string)

The description of the entity.

--components (map)

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

key -> (string)

value -> (structure)

An object that sets information about a component type create or update request.

description -> (string)

The description of the component request.

componentTypeId -> (string)

The ID of the component type.

properties -> (map)

An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.

key -> (string)

value -> (structure)

An object that sets information about a property.

definition -> (structure)

An object that specifies information about a property.

dataType -> (structure)

An object that contains information about the data type.

type -> (string)

The underlying type of the data type.

nestedType -> (structure)

The nested type in the data type.

type -> (string)

The underlying type of the data type.

( ... recursive ... )allowedValues -> (list)

The allowed values for this data type.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

value -> (structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

unitOfMeasure -> (string)

The unit of measure used in this data type.

relationship -> (structure)

A relationship that associates a component with another component.

targetComponentTypeId -> (string)

The ID of the target component type associated with this relationship.

relationshipType -> (string)

The type of the relationship.

allowedValues -> (list)

The allowed values for this data type.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

value -> (structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

unitOfMeasure -> (string)

The unit of measure used in this data type.

relationship -> (structure)

A relationship that associates a component with another component.

targetComponentTypeId -> (string)

The ID of the target component type associated with this relationship.

relationshipType -> (string)

The type of the relationship.

isRequiredInEntity -> (boolean)

A Boolean value that specifies whether the property is required.

isExternalId -> (boolean)

A Boolean value that specifies whether the property ID comes from an external data store.

isStoredExternally -> (boolean)

A Boolean value that specifies whether the property is stored externally.

isTimeSeries -> (boolean)

A Boolean value that specifies whether the property consists of time series data.

defaultValue -> (structure)

An object that contains the default value.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

value -> (structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

configuration -> (map)

A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.

key -> (string)

value -> (string)

displayName -> (string)

A friendly name for the property.

value -> (structure)

The value of the property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

value -> (structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

updateType -> (string)

The update type of the update property request.

propertyGroups -> (map)

The property groups.

key -> (string)

value -> (structure)

The component property group request.

groupType -> (string)

The group type.

propertyNames -> (list)

The property names.

(string)

updateType -> (string)

The update type.

JSON Syntax:

{"string": {
      "description": "string",
      "componentTypeId": "string",
      "properties": {"string": {
            "definition": {
              "dataType": {
                "type": "RELATIONSHIP"|"STRING"|"LONG"|"BOOLEAN"|"INTEGER"|"DOUBLE"|"LIST"|"MAP",
                "nestedType": {
                  "type": "RELATIONSHIP"|"STRING"|"LONG"|"BOOLEAN"|"INTEGER"|"DOUBLE"|"LIST"|"MAP",
                  "nestedType": { ... recursive ... },
                  "allowedValues": [
                    {
                      "booleanValue": true|false,
                      "doubleValue": double,
                      "integerValue": integer,
                      "longValue": long,
                      "stringValue": "string",
                      "listValue": [
                        {
                          "booleanValue": true|false,
                          "doubleValue": double,
                          "integerValue": integer,
                          "longValue": long,
                          "stringValue": "string",
                          "listValue": ,
                          "mapValue": {"string": { ... recursive ... }
                            ...},
                          "relationshipValue": {
                            "targetEntityId": "string",
                            "targetComponentName": "string"
                          },
                          "expression": "string"
                        }
                        ...
                      ],
                      "mapValue": {"string": {
                            "booleanValue": true|false,
                            "doubleValue": double,
                            "integerValue": integer,
                            "longValue": long,
                            "stringValue": "string",
                            "listValue": [
                              { ... recursive ... }
                              ...
                            ],
                            "mapValue": {"string": { ... recursive ... }
                              ...},
                            "relationshipValue": {
                              "targetEntityId": "string",
                              "targetComponentName": "string"
                            },
                            "expression": "string"
                          }
                        ...},
                      "relationshipValue": {
                        "targetEntityId": "string",
                        "targetComponentName": "string"
                      },
                      "expression": "string"
                    }
                    ...
                  ],
                  "unitOfMeasure": "string",
                  "relationship": {
                    "targetComponentTypeId": "string",
                    "relationshipType": "string"
                  }
                },
                "allowedValues": [
                  {
                    "booleanValue": true|false,
                    "doubleValue": double,
                    "integerValue": integer,
                    "longValue": long,
                    "stringValue": "string",
                    "listValue": [
                      {
                        "booleanValue": true|false,
                        "doubleValue": double,
                        "integerValue": integer,
                        "longValue": long,
                        "stringValue": "string",
                        "listValue": ,
                        "mapValue": {"string": { ... recursive ... }
                          ...},
                        "relationshipValue": {
                          "targetEntityId": "string",
                          "targetComponentName": "string"
                        },
                        "expression": "string"
                      }
                      ...
                    ],
                    "mapValue": {"string": {
                          "booleanValue": true|false,
                          "doubleValue": double,
                          "integerValue": integer,
                          "longValue": long,
                          "stringValue": "string",
                          "listValue": [
                            { ... recursive ... }
                            ...
                          ],
                          "mapValue": {"string": { ... recursive ... }
                            ...},
                          "relationshipValue": {
                            "targetEntityId": "string",
                            "targetComponentName": "string"
                          },
                          "expression": "string"
                        }
                      ...},
                    "relationshipValue": {
                      "targetEntityId": "string",
                      "targetComponentName": "string"
                    },
                    "expression": "string"
                  }
                  ...
                ],
                "unitOfMeasure": "string",
                "relationship": {
                  "targetComponentTypeId": "string",
                  "relationshipType": "string"
                }
              },
              "isRequiredInEntity": true|false,
              "isExternalId": true|false,
              "isStoredExternally": true|false,
              "isTimeSeries": true|false,
              "defaultValue": {
                "booleanValue": true|false,
                "doubleValue": double,
                "integerValue": integer,
                "longValue": long,
                "stringValue": "string",
                "listValue": [
                  {
                    "booleanValue": true|false,
                    "doubleValue": double,
                    "integerValue": integer,
                    "longValue": long,
                    "stringValue": "string",
                    "listValue": [
                      { ... recursive ... }
                      ...
                    ],
                    "mapValue": {"string": { ... recursive ... }
                      ...},
                    "relationshipValue": {
                      "targetEntityId": "string",
                      "targetComponentName": "string"
                    },
                    "expression": "string"
                  }
                  ...
                ],
                "mapValue": {"string": {
                      "booleanValue": true|false,
                      "doubleValue": double,
                      "integerValue": integer,
                      "longValue": long,
                      "stringValue": "string",
                      "listValue": [
                        { ... recursive ... }
                        ...
                      ],
                      "mapValue": {"string": { ... recursive ... }
                        ...},
                      "relationshipValue": {
                        "targetEntityId": "string",
                        "targetComponentName": "string"
                      },
                      "expression": "string"
                    }
                  ...},
                "relationshipValue": {
                  "targetEntityId": "string",
                  "targetComponentName": "string"
                },
                "expression": "string"
              },
              "configuration": {"string": "string"
                ...},
              "displayName": "string"
            },
            "value": {
              "booleanValue": true|false,
              "doubleValue": double,
              "integerValue": integer,
              "longValue": long,
              "stringValue": "string",
              "listValue": [
                {
                  "booleanValue": true|false,
                  "doubleValue": double,
                  "integerValue": integer,
                  "longValue": long,
                  "stringValue": "string",
                  "listValue": [
                    { ... recursive ... }
                    ...
                  ],
                  "mapValue": {"string": { ... recursive ... }
                    ...},
                  "relationshipValue": {
                    "targetEntityId": "string",
                    "targetComponentName": "string"
                  },
                  "expression": "string"
                }
                ...
              ],
              "mapValue": {"string": {
                    "booleanValue": true|false,
                    "doubleValue": double,
                    "integerValue": integer,
                    "longValue": long,
                    "stringValue": "string",
                    "listValue": [
                      { ... recursive ... }
                      ...
                    ],
                    "mapValue": {"string": { ... recursive ... }
                      ...},
                    "relationshipValue": {
                      "targetEntityId": "string",
                      "targetComponentName": "string"
                    },
                    "expression": "string"
                  }
                ...},
              "relationshipValue": {
                "targetEntityId": "string",
                "targetComponentName": "string"
              },
              "expression": "string"
            },
            "updateType": "UPDATE"|"DELETE"|"CREATE"|"RESET_VALUE"
          }
        ...},
      "propertyGroups": {"string": {
            "groupType": "TABULAR",
            "propertyNames": ["string", ...],
            "updateType": "UPDATE"|"DELETE"|"CREATE"
          }
        ...}
    }
  ...}

--composite-components (map)

This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent .

key -> (string)

value -> (structure)

An object that sets information about the composite component update request.

description -> (string)

The description of the component type.

properties -> (map)

This is an object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.

key -> (string)

value -> (structure)

An object that sets information about a property.

definition -> (structure)

An object that specifies information about a property.

dataType -> (structure)

An object that contains information about the data type.

type -> (string)

The underlying type of the data type.

nestedType -> (structure)

The nested type in the data type.

type -> (string)

The underlying type of the data type.

( ... recursive ... )allowedValues -> (list)

The allowed values for this data type.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

value -> (structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

unitOfMeasure -> (string)

The unit of measure used in this data type.

relationship -> (structure)

A relationship that associates a component with another component.

targetComponentTypeId -> (string)

The ID of the target component type associated with this relationship.

relationshipType -> (string)

The type of the relationship.

allowedValues -> (list)

The allowed values for this data type.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

value -> (structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

unitOfMeasure -> (string)

The unit of measure used in this data type.

relationship -> (structure)

A relationship that associates a component with another component.

targetComponentTypeId -> (string)

The ID of the target component type associated with this relationship.

relationshipType -> (string)

The type of the relationship.

isRequiredInEntity -> (boolean)

A Boolean value that specifies whether the property is required.

isExternalId -> (boolean)

A Boolean value that specifies whether the property ID comes from an external data store.

isStoredExternally -> (boolean)

A Boolean value that specifies whether the property is stored externally.

isTimeSeries -> (boolean)

A Boolean value that specifies whether the property consists of time series data.

defaultValue -> (structure)

An object that contains the default value.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

value -> (structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

configuration -> (map)

A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.

key -> (string)

value -> (string)

displayName -> (string)

A friendly name for the property.

value -> (structure)

The value of the property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

value -> (structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

updateType -> (string)

The update type of the update property request.

propertyGroups -> (map)

The property groups.

key -> (string)

value -> (structure)

The component property group request.

groupType -> (string)

The group type.

propertyNames -> (list)

The property names.

(string)

updateType -> (string)

The update type.

JSON Syntax:

{"string": {
      "description": "string",
      "properties": {"string": {
            "definition": {
              "dataType": {
                "type": "RELATIONSHIP"|"STRING"|"LONG"|"BOOLEAN"|"INTEGER"|"DOUBLE"|"LIST"|"MAP",
                "nestedType": {
                  "type": "RELATIONSHIP"|"STRING"|"LONG"|"BOOLEAN"|"INTEGER"|"DOUBLE"|"LIST"|"MAP",
                  "nestedType": { ... recursive ... },
                  "allowedValues": [
                    {
                      "booleanValue": true|false,
                      "doubleValue": double,
                      "integerValue": integer,
                      "longValue": long,
                      "stringValue": "string",
                      "listValue": [
                        {
                          "booleanValue": true|false,
                          "doubleValue": double,
                          "integerValue": integer,
                          "longValue": long,
                          "stringValue": "string",
                          "listValue": ,
                          "mapValue": {"string": { ... recursive ... }
                            ...},
                          "relationshipValue": {
                            "targetEntityId": "string",
                            "targetComponentName": "string"
                          },
                          "expression": "string"
                        }
                        ...
                      ],
                      "mapValue": {"string": {
                            "booleanValue": true|false,
                            "doubleValue": double,
                            "integerValue": integer,
                            "longValue": long,
                            "stringValue": "string",
                            "listValue": [
                              { ... recursive ... }
                              ...
                            ],
                            "mapValue": {"string": { ... recursive ... }
                              ...},
                            "relationshipValue": {
                              "targetEntityId": "string",
                              "targetComponentName": "string"
                            },
                            "expression": "string"
                          }
                        ...},
                      "relationshipValue": {
                        "targetEntityId": "string",
                        "targetComponentName": "string"
                      },
                      "expression": "string"
                    }
                    ...
                  ],
                  "unitOfMeasure": "string",
                  "relationship": {
                    "targetComponentTypeId": "string",
                    "relationshipType": "string"
                  }
                },
                "allowedValues": [
                  {
                    "booleanValue": true|false,
                    "doubleValue": double,
                    "integerValue": integer,
                    "longValue": long,
                    "stringValue": "string",
                    "listValue": [
                      {
                        "booleanValue": true|false,
                        "doubleValue": double,
                        "integerValue": integer,
                        "longValue": long,
                        "stringValue": "string",
                        "listValue": ,
                        "mapValue": {"string": { ... recursive ... }
                          ...},
                        "relationshipValue": {
                          "targetEntityId": "string",
                          "targetComponentName": "string"
                        },
                        "expression": "string"
                      }
                      ...
                    ],
                    "mapValue": {"string": {
                          "booleanValue": true|false,
                          "doubleValue": double,
                          "integerValue": integer,
                          "longValue": long,
                          "stringValue": "string",
                          "listValue": [
                            { ... recursive ... }
                            ...
                          ],
                          "mapValue": {"string": { ... recursive ... }
                            ...},
                          "relationshipValue": {
                            "targetEntityId": "string",
                            "targetComponentName": "string"
                          },
                          "expression": "string"
                        }
                      ...},
                    "relationshipValue": {
                      "targetEntityId": "string",
                      "targetComponentName": "string"
                    },
                    "expression": "string"
                  }
                  ...
                ],
                "unitOfMeasure": "string",
                "relationship": {
                  "targetComponentTypeId": "string",
                  "relationshipType": "string"
                }
              },
              "isRequiredInEntity": true|false,
              "isExternalId": true|false,
              "isStoredExternally": true|false,
              "isTimeSeries": true|false,
              "defaultValue": {
                "booleanValue": true|false,
                "doubleValue": double,
                "integerValue": integer,
                "longValue": long,
                "stringValue": "string",
                "listValue": [
                  {
                    "booleanValue": true|false,
                    "doubleValue": double,
                    "integerValue": integer,
                    "longValue": long,
                    "stringValue": "string",
                    "listValue": [
                      { ... recursive ... }
                      ...
                    ],
                    "mapValue": {"string": { ... recursive ... }
                      ...},
                    "relationshipValue": {
                      "targetEntityId": "string",
                      "targetComponentName": "string"
                    },
                    "expression": "string"
                  }
                  ...
                ],
                "mapValue": {"string": {
                      "booleanValue": true|false,
                      "doubleValue": double,
                      "integerValue": integer,
                      "longValue": long,
                      "stringValue": "string",
                      "listValue": [
                        { ... recursive ... }
                        ...
                      ],
                      "mapValue": {"string": { ... recursive ... }
                        ...},
                      "relationshipValue": {
                        "targetEntityId": "string",
                        "targetComponentName": "string"
                      },
                      "expression": "string"
                    }
                  ...},
                "relationshipValue": {
                  "targetEntityId": "string",
                  "targetComponentName": "string"
                },
                "expression": "string"
              },
              "configuration": {"string": "string"
                ...},
              "displayName": "string"
            },
            "value": {
              "booleanValue": true|false,
              "doubleValue": double,
              "integerValue": integer,
              "longValue": long,
              "stringValue": "string",
              "listValue": [
                {
                  "booleanValue": true|false,
                  "doubleValue": double,
                  "integerValue": integer,
                  "longValue": long,
                  "stringValue": "string",
                  "listValue": [
                    { ... recursive ... }
                    ...
                  ],
                  "mapValue": {"string": { ... recursive ... }
                    ...},
                  "relationshipValue": {
                    "targetEntityId": "string",
                    "targetComponentName": "string"
                  },
                  "expression": "string"
                }
                ...
              ],
              "mapValue": {"string": {
                    "booleanValue": true|false,
                    "doubleValue": double,
                    "integerValue": integer,
                    "longValue": long,
                    "stringValue": "string",
                    "listValue": [
                      { ... recursive ... }
                      ...
                    ],
                    "mapValue": {"string": { ... recursive ... }
                      ...},
                    "relationshipValue": {
                      "targetEntityId": "string",
                      "targetComponentName": "string"
                    },
                    "expression": "string"
                  }
                ...},
              "relationshipValue": {
                "targetEntityId": "string",
                "targetComponentName": "string"
              },
              "expression": "string"
            },
            "updateType": "UPDATE"|"DELETE"|"CREATE"|"RESET_VALUE"
          }
        ...},
      "propertyGroups": {"string": {
            "groupType": "TABULAR",
            "propertyNames": ["string", ...],
            "updateType": "UPDATE"|"DELETE"|"CREATE"
          }
        ...}
    }
  ...}

--parent-entity-id (string)

The ID of the entity's parent entity.

--tags (map)

Metadata that you can use to manage the entity.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

Output

entityId -> (string)

The ID of the entity.

arn -> (string)

The ARN of the entity.

creationDateTime -> (timestamp)

The date and time when the entity was created.

state -> (string)

The current state of the entity.