AWS Native v0.112.0, Jul 24 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.iotsitewise.getAssetModel

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi

pulumi/pulumi-aws-native

Using getAssetModel

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAssetModel(args: GetAssetModelArgs, opts?: InvokeOptions): Promise<GetAssetModelResult>
function getAssetModelOutput(args: GetAssetModelOutputArgs, opts?: InvokeOptions): Output<GetAssetModelResult>

def get_asset_model(asset_model_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAssetModelResult
def get_asset_model_output(asset_model_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetAssetModelResult]

func LookupAssetModel(ctx *Context, args *LookupAssetModelArgs, opts ...InvokeOption) (*LookupAssetModelResult, error)
func LookupAssetModelOutput(ctx *Context, args *LookupAssetModelOutputArgs, opts ...InvokeOption) LookupAssetModelResultOutput

> Note: This function is named LookupAssetModel in the Go SDK.

public static class GetAssetModel 
{
    public static Task<GetAssetModelResult> InvokeAsync(GetAssetModelArgs args, InvokeOptions? opts = null)
    public static Output<GetAssetModelResult> Invoke(GetAssetModelInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAssetModelResult> getAssetModel(GetAssetModelArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:iotsitewise:getAssetModel
  arguments:
    # arguments dictionary

The following arguments are supported:

AssetModelId string: The ID of the asset model.

AssetModelId string: The ID of the asset model.

assetModelId String: The ID of the asset model.

assetModelId string: The ID of the asset model.

asset_model_id str: The ID of the asset model.

assetModelId String: The ID of the asset model.

getAssetModel Result

The following output properties are available:

AssetModelArn string: The ARN of the asset model, which has the following format.
AssetModelCompositeModels List<Pulumi.AwsNative.IoTSiteWise.Outputs.AssetModelCompositeModel>: The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
AssetModelDescription string: A description for the asset model.
AssetModelExternalId string: The external ID of the asset model.
AssetModelHierarchies List<Pulumi.AwsNative.IoTSiteWise.Outputs.AssetModelHierarchy>: 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.
AssetModelId string: The ID of the asset model.
AssetModelName string: A unique, friendly name for the asset model.
AssetModelProperties List<Pulumi.AwsNative.IoTSiteWise.Outputs.AssetModelProperty>: The property definitions of the asset model. You can specify up to 200 properties per asset model.
Tags List<Pulumi.AwsNative.Outputs.Tag>: A list of key-value pairs that contain metadata for the asset model.

AssetModelArn string: The ARN of the asset model, which has the following format.
AssetModelCompositeModels []AssetModelCompositeModel: The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
AssetModelDescription string: A description for the asset model.
AssetModelExternalId string: The external ID of the asset model.
AssetModelHierarchies []AssetModelHierarchy: 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.
AssetModelId string: The ID of the asset model.
AssetModelName string: A unique, friendly name for the asset model.
AssetModelProperties []AssetModelProperty: The property definitions of the asset model. You can specify up to 200 properties per asset model.
Tags Tag: A list of key-value pairs that contain metadata for the asset model.

assetModelArn String: The ARN of the asset model, which has the following format.
assetModelCompositeModels List<AssetModelCompositeModel>: The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
assetModelDescription String: A description for the asset model.
assetModelExternalId String: The external ID of the asset model.
assetModelHierarchies List<AssetModelHierarchy>: 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.
assetModelId String: The ID of the asset model.
assetModelName String: A unique, friendly name for the asset model.
assetModelProperties List<AssetModelProperty>: The property definitions of the asset model. You can specify up to 200 properties per asset model.
tags List<Tag>: A list of key-value pairs that contain metadata for the asset model.

assetModelArn string: The ARN of the asset model, which has the following format.
assetModelCompositeModels AssetModelCompositeModel[]: The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
assetModelDescription string: A description for the asset model.
assetModelExternalId string: The external ID of the asset model.
assetModelHierarchies AssetModelHierarchy[]: 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.
assetModelId string: The ID of the asset model.
assetModelName string: A unique, friendly name for the asset model.
assetModelProperties AssetModelProperty[]: The property definitions of the asset model. You can specify up to 200 properties per asset model.
tags Tag[]: A list of key-value pairs that contain metadata for the asset model.

asset_model_arn str: The ARN of the asset model, which has the following format.
asset_model_composite_models Sequence[AssetModelCompositeModel]: The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
asset_model_description str: A description for the asset model.
asset_model_external_id str: The external ID of the asset model.
asset_model_hierarchies Sequence[AssetModelHierarchy]: 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.
asset_model_id str: The ID of the asset model.
asset_model_name str: A unique, friendly name for the asset model.
asset_model_properties Sequence[AssetModelProperty]: The property definitions of the asset model. You can specify up to 200 properties per asset model.
tags Sequence[root_Tag]: A list of key-value pairs that contain metadata for the asset model.

assetModelArn String: The ARN of the asset model, which has the following format.
assetModelCompositeModels List<Property Map>: The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
assetModelDescription String: A description for the asset model.
assetModelExternalId String: The external ID of the asset model.
assetModelHierarchies List<Property Map>: 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.
assetModelId String: The ID of the asset model.
assetModelName String: A unique, friendly name for the asset model.
assetModelProperties List<Property Map>: The property definitions of the asset model. You can specify up to 200 properties per asset model.
tags List<Property Map>: A list of key-value pairs that contain metadata for the asset model.

Supporting Types

AssetModelAttribute

DefaultValue string: The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .

DefaultValue string: The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .

defaultValue String: The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .

defaultValue string: The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .

default_value str: The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .

defaultValue String: The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .

AssetModelCompositeModel

Name string: A unique, friendly name for the asset composite model.
Type string: The type of the composite model. For alarm composite models, this type is AWS/ALARM
ComposedAssetModelId string: The component model ID for which the composite model is composed of
CompositeModelProperties List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelProperty>: The property definitions of the asset model. You can specify up to 200 properties per asset model.
Description string: A description for the asset composite model.
ExternalId string: The External ID of the composite model
Id string: The Actual ID of the composite model
ParentAssetModelCompositeModelExternalId string: The parent composite model External ID
Path List<string>: The path of the composite model. This is only for derived composite models

Name string: A unique, friendly name for the asset composite model.
Type string: The type of the composite model. For alarm composite models, this type is AWS/ALARM
ComposedAssetModelId string: The component model ID for which the composite model is composed of
CompositeModelProperties []AssetModelProperty: The property definitions of the asset model. You can specify up to 200 properties per asset model.
Description string: A description for the asset composite model.
ExternalId string: The External ID of the composite model
Id string: The Actual ID of the composite model
ParentAssetModelCompositeModelExternalId string: The parent composite model External ID
Path []string: The path of the composite model. This is only for derived composite models

name String: A unique, friendly name for the asset composite model.
type String: The type of the composite model. For alarm composite models, this type is AWS/ALARM
composedAssetModelId String: The component model ID for which the composite model is composed of
compositeModelProperties List<AssetModelProperty>: The property definitions of the asset model. You can specify up to 200 properties per asset model.
description String: A description for the asset composite model.
externalId String: The External ID of the composite model
id String: The Actual ID of the composite model
parentAssetModelCompositeModelExternalId String: The parent composite model External ID
path List<String>: The path of the composite model. This is only for derived composite models

name string: A unique, friendly name for the asset composite model.
type string: The type of the composite model. For alarm composite models, this type is AWS/ALARM
composedAssetModelId string: The component model ID for which the composite model is composed of
compositeModelProperties AssetModelProperty[]: The property definitions of the asset model. You can specify up to 200 properties per asset model.
description string: A description for the asset composite model.
externalId string: The External ID of the composite model
id string: The Actual ID of the composite model
parentAssetModelCompositeModelExternalId string: The parent composite model External ID
path string[]: The path of the composite model. This is only for derived composite models

name str: A unique, friendly name for the asset composite model.
type str: The type of the composite model. For alarm composite models, this type is AWS/ALARM
composed_asset_model_id str: The component model ID for which the composite model is composed of
composite_model_properties Sequence[AssetModelProperty]: The property definitions of the asset model. You can specify up to 200 properties per asset model.
description str: A description for the asset composite model.
external_id str: The External ID of the composite model
id str: The Actual ID of the composite model
parent_asset_model_composite_model_external_id str: The parent composite model External ID
path Sequence[str]: The path of the composite model. This is only for derived composite models

name String: A unique, friendly name for the asset composite model.
type String: The type of the composite model. For alarm composite models, this type is AWS/ALARM
composedAssetModelId String: The component model ID for which the composite model is composed of
compositeModelProperties List<Property Map>: The property definitions of the asset model. You can specify up to 200 properties per asset model.
description String: A description for the asset composite model.
externalId String: The External ID of the composite model
id String: The Actual ID of the composite model
parentAssetModelCompositeModelExternalId String: The parent composite model External ID
path List<String>: The path of the composite model. This is only for derived composite models

AssetModelDataType

AssetModelDataTypeSpec

AssetModelExpressionVariable

Name string: The friendly name of the variable to be used in the expression.
Value Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelVariableValue: The variable that identifies an asset property from which to use values.

Name string: The friendly name of the variable to be used in the expression.
Value AssetModelVariableValue: The variable that identifies an asset property from which to use values.

name String: The friendly name of the variable to be used in the expression.
value AssetModelVariableValue: The variable that identifies an asset property from which to use values.

name string: The friendly name of the variable to be used in the expression.
value AssetModelVariableValue: The variable that identifies an asset property from which to use values.

name str: The friendly name of the variable to be used in the expression.
value AssetModelVariableValue: The variable that identifies an asset property from which to use values.

name String: The friendly name of the variable to be used in the expression.
value Property Map: The variable that identifies an asset property from which to use values.

AssetModelHierarchy

ChildAssetModelId string: The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.
Name string: The name of the asset model hierarchy.
ExternalId string: Customer provided external ID for hierarchy
Id string: Customer provided actual ID for hierarchy
LogicalId string: Customer provided logical ID for hierarchy.

ChildAssetModelId string: The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.
Name string: The name of the asset model hierarchy.
ExternalId string: Customer provided external ID for hierarchy
Id string: Customer provided actual ID for hierarchy
LogicalId string: Customer provided logical ID for hierarchy.

childAssetModelId String: The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.
name String: The name of the asset model hierarchy.
externalId String: Customer provided external ID for hierarchy
id String: Customer provided actual ID for hierarchy
logicalId String: Customer provided logical ID for hierarchy.

childAssetModelId string: The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.
name string: The name of the asset model hierarchy.
externalId string: Customer provided external ID for hierarchy
id string: Customer provided actual ID for hierarchy
logicalId string: Customer provided logical ID for hierarchy.

child_asset_model_id str: The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.
name str: The name of the asset model hierarchy.
external_id str: Customer provided external ID for hierarchy
id str: Customer provided actual ID for hierarchy
logical_id str: Customer provided logical ID for hierarchy.

childAssetModelId String: The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.
name String: The name of the asset model hierarchy.
externalId String: Customer provided external ID for hierarchy
id String: Customer provided actual ID for hierarchy
logicalId String: Customer provided logical ID for hierarchy.

AssetModelMetric

Expression string: The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.
Variables List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelExpressionVariable>: The list of variables used in the expression.
Window Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelMetricWindow: The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression

Expression string: The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.
Variables []AssetModelExpressionVariable: The list of variables used in the expression.
Window AssetModelMetricWindow: The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression

expression String: The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.
variables List<AssetModelExpressionVariable>: The list of variables used in the expression.
window AssetModelMetricWindow: The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression

expression string: The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.
variables AssetModelExpressionVariable[]: The list of variables used in the expression.
window AssetModelMetricWindow: The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression

expression str: The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.
variables Sequence[AssetModelExpressionVariable]: The list of variables used in the expression.
window AssetModelMetricWindow: The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression

expression String: The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.
variables List<Property Map>: The list of variables used in the expression.
window Property Map: The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression

AssetModelMetricWindow

Tumbling Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelTumblingWindow: The tumbling time interval window.

Tumbling AssetModelTumblingWindow: The tumbling time interval window.

tumbling AssetModelTumblingWindow: The tumbling time interval window.

tumbling AssetModelTumblingWindow: The tumbling time interval window.

tumbling AssetModelTumblingWindow: The tumbling time interval window.

tumbling Property Map: The tumbling time interval window.

AssetModelProperty

DataType Pulumi.AwsNative.IoTSiteWise.AssetModelDataType: The data type of the asset model property.
Name string: The name of the asset model property.
Type Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelPropertyType: The property type
DataTypeSpec Pulumi.AwsNative.IoTSiteWise.AssetModelDataTypeSpec: The data type of the structure for this property.
ExternalId string: The External ID of the Asset Model Property
Id string: The ID of the Asset Model Property
LogicalId string: Customer provided Logical ID for property.
Unit string: The unit of the asset model property, such as Newtons or RPM.

DataType AssetModelDataType: The data type of the asset model property.
Name string: The name of the asset model property.
Type AssetModelPropertyType: The property type
DataTypeSpec AssetModelDataTypeSpec: The data type of the structure for this property.
ExternalId string: The External ID of the Asset Model Property
Id string: The ID of the Asset Model Property
LogicalId string: Customer provided Logical ID for property.
Unit string: The unit of the asset model property, such as Newtons or RPM.

dataType AssetModelDataType: The data type of the asset model property.
name String: The name of the asset model property.
type AssetModelPropertyType: The property type
dataTypeSpec AssetModelDataTypeSpec: The data type of the structure for this property.
externalId String: The External ID of the Asset Model Property
id String: The ID of the Asset Model Property
logicalId String: Customer provided Logical ID for property.
unit String: The unit of the asset model property, such as Newtons or RPM.

dataType AssetModelDataType: The data type of the asset model property.
name string: The name of the asset model property.
type AssetModelPropertyType: The property type
dataTypeSpec AssetModelDataTypeSpec: The data type of the structure for this property.
externalId string: The External ID of the Asset Model Property
id string: The ID of the Asset Model Property
logicalId string: Customer provided Logical ID for property.
unit string: The unit of the asset model property, such as Newtons or RPM.

data_type AssetModelDataType: The data type of the asset model property.
name str: The name of the asset model property.
type AssetModelPropertyType: The property type
data_type_spec AssetModelDataTypeSpec: The data type of the structure for this property.
external_id str: The External ID of the Asset Model Property
id str: The ID of the Asset Model Property
logical_id str: Customer provided Logical ID for property.
unit str: The unit of the asset model property, such as Newtons or RPM.

dataType "STRING" | "INTEGER" | "DOUBLE" | "BOOLEAN" | "STRUCT": The data type of the asset model property.
name String: The name of the asset model property.
type Property Map: The property type
dataTypeSpec "AWS/ALARM_STATE": The data type of the structure for this property.
externalId String: The External ID of the Asset Model Property
id String: The ID of the Asset Model Property
logicalId String: Customer provided Logical ID for property.
unit String: The unit of the asset model property, such as Newtons or RPM.

AssetModelPropertyPathDefinition

Name string: The name of the property

Name string: The name of the property

name String: The name of the property

name string: The name of the property

name str: The name of the property

name String: The name of the property

AssetModelPropertyType

TypeName Pulumi.AwsNative.IoTSiteWise.AssetModelTypeName: The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .
Attribute Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelAttribute: Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
Metric Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelMetric: Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
Transform Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelTransform: Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

TypeName AssetModelTypeName: The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .
Attribute AssetModelAttribute: Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
Metric AssetModelMetric: Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
Transform AssetModelTransform: Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

typeName AssetModelTypeName: The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .
attribute AssetModelAttribute: Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
metric AssetModelMetric: Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
transform AssetModelTransform: Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

typeName AssetModelTypeName: The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .
attribute AssetModelAttribute: Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
metric AssetModelMetric: Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
transform AssetModelTransform: Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

type_name AssetModelTypeName: The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .
attribute AssetModelAttribute: Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
metric AssetModelMetric: Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
transform AssetModelTransform: Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

typeName "Measurement" | "Attribute" | "Transform" | "Metric": The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .
attribute Property Map: Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
metric Property Map: Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
transform Property Map: Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

AssetModelTransform

Expression string: The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.
Variables List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelExpressionVariable>: The list of variables used in the expression.

Expression string: The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.
Variables []AssetModelExpressionVariable: The list of variables used in the expression.

expression String: The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.
variables List<AssetModelExpressionVariable>: The list of variables used in the expression.

expression string: The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.
variables AssetModelExpressionVariable[]: The list of variables used in the expression.

expression str: The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.
variables Sequence[AssetModelExpressionVariable]: The list of variables used in the expression.

expression String: The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.
variables List<Property Map>: The list of variables used in the expression.

AssetModelTumblingWindow

Interval string

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

Offset string

The offset for the tumbling window. The offset parameter accepts the following:

The offset time.

For example, if you specify 18h for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format.

For example, if you specify PT18H for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock.

For example, if you specify 00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).

The offset time zone.

For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.

Interval string

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

Offset string

The offset for the tumbling window. The offset parameter accepts the following:

The offset time.

For example, if you specify 18h for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format.

For example, if you specify PT18H for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock.

The offset time zone.

For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.

interval String

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

offset String

The offset for the tumbling window. The offset parameter accepts the following:

The offset time.

For example, if you specify 18h for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format.

For example, if you specify PT18H for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock.

The offset time zone.

For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.

interval string

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

offset string

The offset for the tumbling window. The offset parameter accepts the following:

The offset time.

For example, if you specify 18h for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format.

For example, if you specify PT18H for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock.

The offset time zone.

For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.

interval str

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

offset str

The offset for the tumbling window. The offset parameter accepts the following:

The offset time.

For example, if you specify 18h for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format.

For example, if you specify PT18H for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock.

The offset time zone.

For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.

interval String

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

offset String

The offset for the tumbling window. The offset parameter accepts the following:

The offset time.

For example, if you specify 18h for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format.

For example, if you specify PT18H for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock.

The offset time zone.

For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.

AssetModelTypeName

AssetModelVariableValue

HierarchyExternalId string

The External ID of the hierarchy that is trying to be referenced

HierarchyId string

The ID of the hierarchy that is trying to be referenced

HierarchyLogicalId string

The LogicalID of the hierarchy to query for the PropertyLogicalID .

You use a hierarchyLogicalID instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see Defining relationships between asset models (hierarchies) in the AWS IoT SiteWise User Guide .

PropertyExternalId string

The External ID of the property that is trying to be referenced

PropertyId string

The ID of the property that is trying to be referenced

PropertyLogicalId string

The LogicalID of the property that is being referenced.

PropertyPath List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelPropertyPathDefinition>

The path of the property that is trying to be referenced

HierarchyExternalId string

The External ID of the hierarchy that is trying to be referenced

HierarchyId string

The ID of the hierarchy that is trying to be referenced

HierarchyLogicalId string

The LogicalID of the hierarchy to query for the PropertyLogicalID .

PropertyExternalId string

The External ID of the property that is trying to be referenced

PropertyId string

The ID of the property that is trying to be referenced

PropertyLogicalId string

The LogicalID of the property that is being referenced.

PropertyPath []AssetModelPropertyPathDefinition

The path of the property that is trying to be referenced

hierarchyExternalId String

The External ID of the hierarchy that is trying to be referenced

hierarchyId String

The ID of the hierarchy that is trying to be referenced

hierarchyLogicalId String

The LogicalID of the hierarchy to query for the PropertyLogicalID .

propertyExternalId String

The External ID of the property that is trying to be referenced

propertyId String

The ID of the property that is trying to be referenced

propertyLogicalId String

The LogicalID of the property that is being referenced.

propertyPath List<AssetModelPropertyPathDefinition>

The path of the property that is trying to be referenced

hierarchyExternalId string

The External ID of the hierarchy that is trying to be referenced

hierarchyId string

The ID of the hierarchy that is trying to be referenced

hierarchyLogicalId string

The LogicalID of the hierarchy to query for the PropertyLogicalID .

propertyExternalId string

The External ID of the property that is trying to be referenced

propertyId string

The ID of the property that is trying to be referenced

propertyLogicalId string

The LogicalID of the property that is being referenced.

propertyPath AssetModelPropertyPathDefinition[]

The path of the property that is trying to be referenced

hierarchy_external_id str

The External ID of the hierarchy that is trying to be referenced

hierarchy_id str

The ID of the hierarchy that is trying to be referenced

hierarchy_logical_id str

The LogicalID of the hierarchy to query for the PropertyLogicalID .

property_external_id str

The External ID of the property that is trying to be referenced

property_id str

The ID of the property that is trying to be referenced

property_logical_id str

The LogicalID of the property that is being referenced.

property_path Sequence[AssetModelPropertyPathDefinition]

The path of the property that is trying to be referenced

hierarchyExternalId String

The External ID of the hierarchy that is trying to be referenced

hierarchyId String

The ID of the hierarchy that is trying to be referenced

hierarchyLogicalId String

The LogicalID of the hierarchy to query for the PropertyLogicalID .

propertyExternalId String

The External ID of the property that is trying to be referenced

propertyId String

The ID of the property that is trying to be referenced

propertyLogicalId String

The LogicalID of the property that is being referenced.

propertyPath List<Property Map>

The path of the property that is trying to be referenced

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.iotsitewise.getAssetModel

On this page

On this page

Using getAssetModel

getAssetModel Result

Supporting Types

AssetModelAttribute

AssetModelCompositeModel

AssetModelDataType

AssetModelDataTypeSpec

AssetModelExpressionVariable

AssetModelHierarchy

AssetModelMetric

AssetModelMetricWindow

AssetModelProperty

AssetModelPropertyPathDefinition

AssetModelPropertyType

AssetModelTransform

AssetModelTumblingWindow

AssetModelTypeName

AssetModelVariableValue

Tag

Package Details

On this page

On this page