awscc.iotsitewise_assetmodel¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - iotsitewise:DescribeAssetModel, iotsitewise:DeleteAssetModel
update¶
Parent base class for filters and actions.
definitions:
AssetModelCompositeModel:
additionalProperties: false
description: Contains a composite model definition in an asset model. This composite
model definition is applied to all assets created from the asset model.
properties:
CompositeModelProperties:
description: The property definitions of the asset model. You can specify
up to 200 properties per asset model.
insertionOrder: false
items:
additionalProperties: false
description: Contains information about an asset model property.
properties:
DataType:
enum:
- STRING
- INTEGER
- DOUBLE
- BOOLEAN
- STRUCT
type: string
DataTypeSpec:
enum:
- AWS/ALARM_STATE
type: string
LogicalId:
description: Customer provided ID for property.
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
Name:
description: The name of the asset model property.
type: string
Type:
additionalProperties: false
description: Contains a property type, which can be one of attribute,
measurement, metric, or transform.
properties:
Attribute:
additionalProperties: false
properties:
DefaultValue:
type: string
type: object
Metric:
additionalProperties: false
properties:
Expression:
description: The mathematical expression that defines the metric
aggregation function. You can specify up to 10 functions per
expression.
type: string
Variables:
description: The list of variables used in the expression.
insertionOrder: false
items:
additionalProperties: false
properties:
Name:
description: The friendly name of the variable to be used
in the expression.
type: string
Value:
additionalProperties: false
properties:
HierarchyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
PropertyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
required:
- PropertyLogicalId
type: object
required:
- Name
- Value
type: object
type: array
Window:
additionalProperties: false
description: Contains a time interval window used for data aggregate
computations (for example, average, sum, count, and so on).
properties:
Tumbling:
additionalProperties: false
description: Contains a tumbling window, which is a repeating
fixed-sized, non-overlapping, and contiguous time interval.
This window is used in metric and aggregation computations.
properties:
Interval:
description: The time interval for the tumbling window.
type: string
Offset:
description: The shift or reference point on timeline
for the contiguous time intervals.
type: string
required:
- Interval
type: object
type: object
required:
- Expression
- Variables
- Window
type: object
Transform:
additionalProperties: false
properties:
Expression:
description: The mathematical expression that defines the transformation
function. You can specify up to 10 functions per expression.
type: string
Variables:
description: The list of variables used in the expression.
insertionOrder: false
items:
additionalProperties: false
properties:
Name:
description: The friendly name of the variable to be used
in the expression.
type: string
Value:
additionalProperties: false
properties:
HierarchyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
PropertyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
required:
- PropertyLogicalId
type: object
required:
- Name
- Value
type: object
type: array
required:
- Expression
- Variables
type: object
TypeName:
enum:
- Measurement
- Attribute
- Transform
- Metric
type: string
required:
- TypeName
type: object
Unit:
description: The unit of the asset model property, such as Newtons or
RPM.
type: string
required:
- LogicalId
- Name
- DataType
- Type
type: object
type: array
Description:
description: A description for the asset composite model.
type: string
Name:
description: A unique, friendly name for the asset composite model.
type: string
Type:
description: The type of the composite model. For alarm composite models,
this type is AWS/ALARM
type: string
required:
- Name
- Type
type: object
AssetModelHierarchy:
additionalProperties: false
description: Contains information about an asset model hierarchy.
properties:
ChildAssetModelId:
description: The ID of the asset model. All assets in this hierarchy must
be instances of the child AssetModelId asset model.
type: string
LogicalId:
description: Customer provided ID for hierarchy.
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
Name:
description: The name of the asset model hierarchy.
type: string
required:
- LogicalId
- Name
- ChildAssetModelId
type: object
AssetModelProperty:
additionalProperties: false
description: Contains information about an asset model property.
properties:
DataType:
enum:
- STRING
- INTEGER
- DOUBLE
- BOOLEAN
- STRUCT
type: string
DataTypeSpec:
enum:
- AWS/ALARM_STATE
type: string
LogicalId:
description: Customer provided ID for property.
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
Name:
description: The name of the asset model property.
type: string
Type:
additionalProperties: false
description: Contains a property type, which can be one of attribute, measurement,
metric, or transform.
properties:
Attribute:
additionalProperties: false
properties:
DefaultValue:
type: string
type: object
Metric:
additionalProperties: false
properties:
Expression:
description: The mathematical expression that defines the metric aggregation
function. You can specify up to 10 functions per expression.
type: string
Variables:
description: The list of variables used in the expression.
insertionOrder: false
items:
additionalProperties: false
properties:
Name:
description: The friendly name of the variable to be used in
the expression.
type: string
Value:
additionalProperties: false
properties:
HierarchyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
PropertyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
required:
- PropertyLogicalId
type: object
required:
- Name
- Value
type: object
type: array
Window:
additionalProperties: false
description: Contains a time interval window used for data aggregate
computations (for example, average, sum, count, and so on).
properties:
Tumbling:
additionalProperties: false
description: Contains a tumbling window, which is a repeating
fixed-sized, non-overlapping, and contiguous time interval.
This window is used in metric and aggregation computations.
properties:
Interval:
description: The time interval for the tumbling window.
type: string
Offset:
description: The shift or reference point on timeline for
the contiguous time intervals.
type: string
required:
- Interval
type: object
type: object
required:
- Expression
- Variables
- Window
type: object
Transform:
additionalProperties: false
properties:
Expression:
description: The mathematical expression that defines the transformation
function. You can specify up to 10 functions per expression.
type: string
Variables:
description: The list of variables used in the expression.
insertionOrder: false
items:
additionalProperties: false
properties:
Name:
description: The friendly name of the variable to be used in
the expression.
type: string
Value:
additionalProperties: false
properties:
HierarchyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
PropertyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
required:
- PropertyLogicalId
type: object
required:
- Name
- Value
type: object
type: array
required:
- Expression
- Variables
type: object
TypeName:
enum:
- Measurement
- Attribute
- Transform
- Metric
type: string
required:
- TypeName
type: object
Unit:
description: The unit of the asset model property, such as Newtons or RPM.
type: string
required:
- LogicalId
- Name
- DataType
- Type
type: object
Attribute:
additionalProperties: false
properties:
DefaultValue:
type: string
type: object
DataType:
enum:
- STRING
- INTEGER
- DOUBLE
- BOOLEAN
- STRUCT
type: string
DataTypeSpec:
enum:
- AWS/ALARM_STATE
type: string
ExpressionVariable:
additionalProperties: false
properties:
Name:
description: The friendly name of the variable to be used in the expression.
type: string
Value:
additionalProperties: false
properties:
HierarchyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
PropertyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
required:
- PropertyLogicalId
type: object
required:
- Name
- Value
type: object
Interval:
description: The time interval for the tumbling window.
type: string
Metric:
additionalProperties: false
properties:
Expression:
description: The mathematical expression that defines the metric aggregation
function. You can specify up to 10 functions per expression.
type: string
Variables:
description: The list of variables used in the expression.
insertionOrder: false
items:
additionalProperties: false
properties:
Name:
description: The friendly name of the variable to be used in the expression.
type: string
Value:
additionalProperties: false
properties:
HierarchyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
PropertyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
required:
- PropertyLogicalId
type: object
required:
- Name
- Value
type: object
type: array
Window:
additionalProperties: false
description: Contains a time interval window used for data aggregate computations
(for example, average, sum, count, and so on).
properties:
Tumbling:
additionalProperties: false
description: Contains a tumbling window, which is a repeating fixed-sized,
non-overlapping, and contiguous time interval. This window is used in
metric and aggregation computations.
properties:
Interval:
description: The time interval for the tumbling window.
type: string
Offset:
description: The shift or reference point on timeline for the contiguous
time intervals.
type: string
required:
- Interval
type: object
type: object
required:
- Expression
- Variables
- Window
type: object
MetricWindow:
additionalProperties: false
description: Contains a time interval window used for data aggregate computations
(for example, average, sum, count, and so on).
properties:
Tumbling:
additionalProperties: false
description: Contains a tumbling window, which is a repeating fixed-sized,
non-overlapping, and contiguous time interval. This window is used in metric
and aggregation computations.
properties:
Interval:
description: The time interval for the tumbling window.
type: string
Offset:
description: The shift or reference point on timeline for the contiguous
time intervals.
type: string
required:
- Interval
type: object
type: object
Offset:
description: The shift or reference point on timeline for the contiguous time
intervals.
type: string
PropertyType:
additionalProperties: false
description: Contains a property type, which can be one of attribute, measurement,
metric, or transform.
properties:
Attribute:
additionalProperties: false
properties:
DefaultValue:
type: string
type: object
Metric:
additionalProperties: false
properties:
Expression:
description: The mathematical expression that defines the metric aggregation
function. You can specify up to 10 functions per expression.
type: string
Variables:
description: The list of variables used in the expression.
insertionOrder: false
items:
additionalProperties: false
properties:
Name:
description: The friendly name of the variable to be used in the
expression.
type: string
Value:
additionalProperties: false
properties:
HierarchyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
PropertyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
required:
- PropertyLogicalId
type: object
required:
- Name
- Value
type: object
type: array
Window:
additionalProperties: false
description: Contains a time interval window used for data aggregate computations
(for example, average, sum, count, and so on).
properties:
Tumbling:
additionalProperties: false
description: Contains a tumbling window, which is a repeating fixed-sized,
non-overlapping, and contiguous time interval. This window is used
in metric and aggregation computations.
properties:
Interval:
description: The time interval for the tumbling window.
type: string
Offset:
description: The shift or reference point on timeline for the
contiguous time intervals.
type: string
required:
- Interval
type: object
type: object
required:
- Expression
- Variables
- Window
type: object
Transform:
additionalProperties: false
properties:
Expression:
description: The mathematical expression that defines the transformation
function. You can specify up to 10 functions per expression.
type: string
Variables:
description: The list of variables used in the expression.
insertionOrder: false
items:
additionalProperties: false
properties:
Name:
description: The friendly name of the variable to be used in the
expression.
type: string
Value:
additionalProperties: false
properties:
HierarchyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
PropertyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
required:
- PropertyLogicalId
type: object
required:
- Name
- Value
type: object
type: array
required:
- Expression
- Variables
type: object
TypeName:
enum:
- Measurement
- Attribute
- Transform
- Metric
type: string
required:
- TypeName
type: object
Tag:
additionalProperties: false
properties:
Key:
type: string
Value:
type: string
required:
- Value
- Key
type: object
Transform:
additionalProperties: false
properties:
Expression:
description: The mathematical expression that defines the transformation function.
You can specify up to 10 functions per expression.
type: string
Variables:
description: The list of variables used in the expression.
insertionOrder: false
items:
additionalProperties: false
properties:
Name:
description: The friendly name of the variable to be used in the expression.
type: string
Value:
additionalProperties: false
properties:
HierarchyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
PropertyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
required:
- PropertyLogicalId
type: object
required:
- Name
- Value
type: object
type: array
required:
- Expression
- Variables
type: object
TumblingWindow:
additionalProperties: false
description: Contains a tumbling window, which is a repeating fixed-sized, non-overlapping,
and contiguous time interval. This window is used in metric and aggregation
computations.
properties:
Interval:
description: The time interval for the tumbling window.
type: string
Offset:
description: The shift or reference point on timeline for the contiguous time
intervals.
type: string
required:
- Interval
type: object
TypeName:
enum:
- Measurement
- Attribute
- Transform
- Metric
type: string
VariableValue:
additionalProperties: false
properties:
HierarchyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
PropertyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
required:
- PropertyLogicalId
type: object
properties:
AssetModelCompositeModels:
description: The composite asset models that are part of this asset model. Composite
asset models are asset models that contain specific properties.
insertionOrder: false
items:
additionalProperties: false
description: Contains a composite model definition in an asset model. This composite
model definition is applied to all assets created from the asset model.
properties:
CompositeModelProperties:
description: The property definitions of the asset model. You can specify
up to 200 properties per asset model.
insertionOrder: false
items:
additionalProperties: false
description: Contains information about an asset model property.
properties:
DataType:
enum:
- STRING
- INTEGER
- DOUBLE
- BOOLEAN
- STRUCT
type: string
DataTypeSpec:
enum:
- AWS/ALARM_STATE
type: string
LogicalId:
description: Customer provided ID for property.
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
Name:
description: The name of the asset model property.
type: string
Type:
additionalProperties: false
description: Contains a property type, which can be one of attribute,
measurement, metric, or transform.
properties:
Attribute:
additionalProperties: false
properties:
DefaultValue:
type: string
type: object
Metric:
additionalProperties: false
properties:
Expression:
description: The mathematical expression that defines the
metric aggregation function. You can specify up to 10 functions
per expression.
type: string
Variables:
description: The list of variables used in the expression.
insertionOrder: false
items:
additionalProperties: false
properties:
Name:
description: The friendly name of the variable to be
used in the expression.
type: string
Value:
additionalProperties: false
properties:
HierarchyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
PropertyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
required:
- PropertyLogicalId
type: object
required:
- Name
- Value
type: object
type: array
Window:
additionalProperties: false
description: Contains a time interval window used for data
aggregate computations (for example, average, sum, count,
and so on).
properties:
Tumbling:
additionalProperties: false
description: Contains a tumbling window, which is a repeating
fixed-sized, non-overlapping, and contiguous time interval.
This window is used in metric and aggregation computations.
properties:
Interval:
description: The time interval for the tumbling window.
type: string
Offset:
description: The shift or reference point on timeline
for the contiguous time intervals.
type: string
required:
- Interval
type: object
type: object
required:
- Expression
- Variables
- Window
type: object
Transform:
additionalProperties: false
properties:
Expression:
description: The mathematical expression that defines the
transformation function. You can specify up to 10 functions
per expression.
type: string
Variables:
description: The list of variables used in the expression.
insertionOrder: false
items:
additionalProperties: false
properties:
Name:
description: The friendly name of the variable to be
used in the expression.
type: string
Value:
additionalProperties: false
properties:
HierarchyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
PropertyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
required:
- PropertyLogicalId
type: object
required:
- Name
- Value
type: object
type: array
required:
- Expression
- Variables
type: object
TypeName:
enum:
- Measurement
- Attribute
- Transform
- Metric
type: string
required:
- TypeName
type: object
Unit:
description: The unit of the asset model property, such as Newtons
or RPM.
type: string
required:
- LogicalId
- Name
- DataType
- Type
type: object
type: array
Description:
description: A description for the asset composite model.
type: string
Name:
description: A unique, friendly name for the asset composite model.
type: string
Type:
description: The type of the composite model. For alarm composite models,
this type is AWS/ALARM
type: string
required:
- Name
- Type
type: object
type: array
AssetModelDescription:
description: A description for the asset model.
type: string
AssetModelHierarchies:
description: The hierarchy definitions of the asset model. Each hierarchy specifies
an asset model whose assets can be children of any other assets created from
this asset model. You can specify up to 10 hierarchies per asset model.
insertionOrder: false
items:
additionalProperties: false
description: Contains information about an asset model hierarchy.
properties:
ChildAssetModelId:
description: The ID of the asset model. All assets in this hierarchy must
be instances of the child AssetModelId asset model.
type: string
LogicalId:
description: Customer provided ID for hierarchy.
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
Name:
description: The name of the asset model hierarchy.
type: string
required:
- LogicalId
- Name
- ChildAssetModelId
type: object
type: array
AssetModelName:
description: A unique, friendly name for the asset model.
type: string
AssetModelProperties:
description: The property definitions of the asset model. You can specify up to
200 properties per asset model.
insertionOrder: false
items:
additionalProperties: false
description: Contains information about an asset model property.
properties:
DataType:
enum:
- STRING
- INTEGER
- DOUBLE
- BOOLEAN
- STRUCT
type: string
DataTypeSpec:
enum:
- AWS/ALARM_STATE
type: string
LogicalId:
description: Customer provided ID for property.
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
Name:
description: The name of the asset model property.
type: string
Type:
additionalProperties: false
description: Contains a property type, which can be one of attribute, measurement,
metric, or transform.
properties:
Attribute:
additionalProperties: false
properties:
DefaultValue:
type: string
type: object
Metric:
additionalProperties: false
properties:
Expression:
description: The mathematical expression that defines the metric
aggregation function. You can specify up to 10 functions per expression.
type: string
Variables:
description: The list of variables used in the expression.
insertionOrder: false
items:
additionalProperties: false
properties:
Name:
description: The friendly name of the variable to be used
in the expression.
type: string
Value:
additionalProperties: false
properties:
HierarchyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
PropertyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
required:
- PropertyLogicalId
type: object
required:
- Name
- Value
type: object
type: array
Window:
additionalProperties: false
description: Contains a time interval window used for data aggregate
computations (for example, average, sum, count, and so on).
properties:
Tumbling:
additionalProperties: false
description: Contains a tumbling window, which is a repeating
fixed-sized, non-overlapping, and contiguous time interval.
This window is used in metric and aggregation computations.
properties:
Interval:
description: The time interval for the tumbling window.
type: string
Offset:
description: The shift or reference point on timeline for
the contiguous time intervals.
type: string
required:
- Interval
type: object
type: object
required:
- Expression
- Variables
- Window
type: object
Transform:
additionalProperties: false
properties:
Expression:
description: The mathematical expression that defines the transformation
function. You can specify up to 10 functions per expression.
type: string
Variables:
description: The list of variables used in the expression.
insertionOrder: false
items:
additionalProperties: false
properties:
Name:
description: The friendly name of the variable to be used
in the expression.
type: string
Value:
additionalProperties: false
properties:
HierarchyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
PropertyLogicalId:
maxLength: 256
minLength: 1
pattern: '[^\u0000-\u001F\u007F]+'
type: string
required:
- PropertyLogicalId
type: object
required:
- Name
- Value
type: object
type: array
required:
- Expression
- Variables
type: object
TypeName:
enum:
- Measurement
- Attribute
- Transform
- Metric
type: string
required:
- TypeName
type: object
Unit:
description: The unit of the asset model property, such as Newtons or RPM.
type: string
required:
- LogicalId
- Name
- DataType
- Type
type: object
type: array
Tags:
description: A list of key-value pairs that contain metadata for the asset model.
insertionOrder: false
items:
additionalProperties: false
properties:
Key:
type: string
Value:
type: string
required:
- Value
- Key
type: object
type: array
type:
enum:
- update
Permissions - iotsitewise:DescribeAssetModel, iotsitewise:ListTagsForResource, iotsitewise:TagResource, iotsitewise:UntagResource, iotsitewise:UpdateAssetModel