AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
aws-native.iotsitewise.getAssetModel
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
Resource schema for AWS::IoTSiteWise::AssetModel
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:
- Asset
Model stringId - The ID of the asset model.
- Asset
Model stringId - The ID of the asset model.
- asset
Model StringId - The ID of the asset model.
- asset
Model stringId - The ID of the asset model.
- asset_
model_ strid - The ID of the asset model.
- asset
Model StringId - The ID of the asset model.
getAssetModel Result
The following output properties are available:
- Asset
Model stringArn - The ARN of the asset model, which has the following format.
- Asset
Model List<Pulumi.Composite Models Aws Native. Io TSite Wise. Outputs. Asset Model Composite Model> - The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
- Asset
Model stringDescription - A description for the asset model.
- Asset
Model stringExternal Id - The external ID of the asset model.
- Asset
Model List<Pulumi.Hierarchies Aws Native. Io TSite Wise. Outputs. Asset Model Hierarchy> - 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 stringId - The ID of the asset model.
- Asset
Model stringName - A unique, friendly name for the asset model.
- Asset
Model List<Pulumi.Properties Aws Native. Io TSite Wise. Outputs. Asset Model Property> - The property definitions of the asset model. You can specify up to 200 properties per asset model.
- List<Pulumi.
Aws Native. Outputs. Tag> - A list of key-value pairs that contain metadata for the asset model.
- Asset
Model stringArn - The ARN of the asset model, which has the following format.
- Asset
Model []AssetComposite Models Model Composite Model - The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
- Asset
Model stringDescription - A description for the asset model.
- Asset
Model stringExternal Id - The external ID of the asset model.
- Asset
Model []AssetHierarchies Model Hierarchy - 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 stringId - The ID of the asset model.
- Asset
Model stringName - A unique, friendly name for the asset model.
- Asset
Model []AssetProperties Model Property - The property definitions of the asset model. You can specify up to 200 properties per asset model.
- Tag
- A list of key-value pairs that contain metadata for the asset model.
- asset
Model StringArn - The ARN of the asset model, which has the following format.
- asset
Model List<AssetComposite Models Model Composite Model> - The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
- asset
Model StringDescription - A description for the asset model.
- asset
Model StringExternal Id - The external ID of the asset model.
- asset
Model List<AssetHierarchies Model Hierarchy> - 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 StringId - The ID of the asset model.
- asset
Model StringName - A unique, friendly name for the asset model.
- asset
Model List<AssetProperties Model Property> - The property definitions of the asset model. You can specify up to 200 properties per asset model.
- List<Tag>
- A list of key-value pairs that contain metadata for the asset model.
- asset
Model stringArn - The ARN of the asset model, which has the following format.
- asset
Model AssetComposite Models Model Composite Model[] - The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
- asset
Model stringDescription - A description for the asset model.
- asset
Model stringExternal Id - The external ID of the asset model.
- asset
Model AssetHierarchies Model Hierarchy[] - 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 stringId - The ID of the asset model.
- asset
Model stringName - A unique, friendly name for the asset model.
- asset
Model AssetProperties Model Property[] - The property definitions of the asset model. You can specify up to 200 properties per asset model.
- Tag[]
- A list of key-value pairs that contain metadata for the asset model.
- asset_
model_ strarn - The ARN of the asset model, which has the following format.
- asset_
model_ Sequence[Assetcomposite_ models Model Composite Model] - The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
- asset_
model_ strdescription - A description for the asset model.
- asset_
model_ strexternal_ id - The external ID of the asset model.
- asset_
model_ Sequence[Assethierarchies Model Hierarchy] - 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_ strid - The ID of the asset model.
- asset_
model_ strname - A unique, friendly name for the asset model.
- asset_
model_ Sequence[Assetproperties Model Property] - The property definitions of the asset model. You can specify up to 200 properties per asset model.
- Sequence[root_Tag]
- A list of key-value pairs that contain metadata for the asset model.
- asset
Model StringArn - The ARN of the asset model, which has the following format.
- asset
Model List<Property Map>Composite Models - The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
- asset
Model StringDescription - A description for the asset model.
- asset
Model StringExternal Id - The external ID of the asset model.
- asset
Model List<Property Map>Hierarchies - 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 StringId - The ID of the asset model.
- asset
Model StringName - A unique, friendly name for the asset model.
- asset
Model List<Property Map>Properties - The property definitions of the asset model. You can specify up to 200 properties per asset model.
- List<Property Map>
- A list of key-value pairs that contain metadata for the asset model.
Supporting Types
AssetModelAttribute
- Default
Value string
- Default
Value string
- default
Value String
- default
Value string
- default_
value str
- default
Value String
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
- Composed
Asset stringModel Id - The component model ID for which the composite model is composed of
- Composite
Model List<Pulumi.Properties Aws Native. Io TSite Wise. Inputs. Asset Model Property> - 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.
- External
Id string - The External ID of the composite model
- Id string
- The Actual ID of the composite model
- Parent
Asset stringModel Composite Model External Id - 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
- Composed
Asset stringModel Id - The component model ID for which the composite model is composed of
- Composite
Model []AssetProperties Model Property - 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.
- External
Id string - The External ID of the composite model
- Id string
- The Actual ID of the composite model
- Parent
Asset stringModel Composite Model External Id - 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
- composed
Asset StringModel Id - The component model ID for which the composite model is composed of
- composite
Model List<AssetProperties Model Property> - 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.
- external
Id String - The External ID of the composite model
- id String
- The Actual ID of the composite model
- parent
Asset StringModel Composite Model External Id - 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
- composed
Asset stringModel Id - The component model ID for which the composite model is composed of
- composite
Model AssetProperties Model Property[] - 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.
- external
Id string - The External ID of the composite model
- id string
- The Actual ID of the composite model
- parent
Asset stringModel Composite Model External Id - 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_ strmodel_ id - The component model ID for which the composite model is composed of
- composite_
model_ Sequence[Assetproperties Model Property] - 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_ strmodel_ composite_ model_ external_ id - 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
- composed
Asset StringModel Id - The component model ID for which the composite model is composed of
- composite
Model List<Property Map>Properties - 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.
- external
Id String - The External ID of the composite model
- id String
- The Actual ID of the composite model
- parent
Asset StringModel Composite Model External Id - 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.
Aws Native. Io TSite Wise. Inputs. Asset Model Variable Value - 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
Asset
Model Variable Value - 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
Asset
Model Variable Value - 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
Asset
Model Variable Value - 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
Asset
Model Variable Value - 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
- Child
Asset stringModel Id - 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.
- External
Id string - Customer provided external ID for hierarchy
- Id string
- Customer provided actual ID for hierarchy
- Logical
Id string - Customer provided logical ID for hierarchy.
- Child
Asset stringModel Id - 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.
- External
Id string - Customer provided external ID for hierarchy
- Id string
- Customer provided actual ID for hierarchy
- Logical
Id string - Customer provided logical ID for hierarchy.
- child
Asset StringModel Id - 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.
- external
Id String - Customer provided external ID for hierarchy
- id String
- Customer provided actual ID for hierarchy
- logical
Id String - Customer provided logical ID for hierarchy.
- child
Asset stringModel Id - 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.
- external
Id string - Customer provided external ID for hierarchy
- id string
- Customer provided actual ID for hierarchy
- logical
Id string - Customer provided logical ID for hierarchy.
- child_
asset_ strmodel_ id - 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.
- child
Asset StringModel Id - 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.
- external
Id String - Customer provided external ID for hierarchy
- id String
- Customer provided actual ID for hierarchy
- logical
Id 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.
Aws Native. Io TSite Wise. Inputs. Asset Model Expression Variable> - The list of variables used in the expression.
- Window
Pulumi.
Aws Native. Io TSite Wise. Inputs. Asset Model Metric Window - 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
[]Asset
Model Expression Variable - The list of variables used in the expression.
- Window
Asset
Model Metric Window - 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<Asset
Model Expression Variable> - The list of variables used in the expression.
- window
Asset
Model Metric Window - 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
Asset
Model Expression Variable[] - The list of variables used in the expression.
- window
Asset
Model Metric Window - 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[Asset
Model Expression Variable] - The list of variables used in the expression.
- window
Asset
Model Metric Window - 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
AssetModelProperty
- Data
Type Pulumi.Aws Native. Io TSite Wise. Asset Model Data Type - The data type of the asset model property.
- Name string
- The name of the asset model property.
- Type
Pulumi.
Aws Native. Io TSite Wise. Inputs. Asset Model Property Type - The property type
- Data
Type Pulumi.Spec Aws Native. Io TSite Wise. Asset Model Data Type Spec - The data type of the structure for this property.
- External
Id string - The External ID of the Asset Model Property
- Id string
- The ID of the Asset Model Property
- Logical
Id string - Customer provided Logical ID for property.
- Unit string
- The unit of the asset model property, such as Newtons or RPM.
- Data
Type AssetModel Data Type - The data type of the asset model property.
- Name string
- The name of the asset model property.
- Type
Asset
Model Property Type - The property type
- Data
Type AssetSpec Model Data Type Spec - The data type of the structure for this property.
- External
Id string - The External ID of the Asset Model Property
- Id string
- The ID of the Asset Model Property
- Logical
Id string - Customer provided Logical ID for property.
- Unit string
- The unit of the asset model property, such as Newtons or RPM.
- data
Type AssetModel Data Type - The data type of the asset model property.
- name String
- The name of the asset model property.
- type
Asset
Model Property Type - The property type
- data
Type AssetSpec Model Data Type Spec - The data type of the structure for this property.
- external
Id String - The External ID of the Asset Model Property
- id String
- The ID of the Asset Model Property
- logical
Id String - Customer provided Logical ID for property.
- unit String
- The unit of the asset model property, such as Newtons or RPM.
- data
Type AssetModel Data Type - The data type of the asset model property.
- name string
- The name of the asset model property.
- type
Asset
Model Property Type - The property type
- data
Type AssetSpec Model Data Type Spec - The data type of the structure for this property.
- external
Id string - The External ID of the Asset Model Property
- id string
- The ID of the Asset Model Property
- logical
Id string - Customer provided Logical ID for property.
- unit string
- The unit of the asset model property, such as Newtons or RPM.
- data_
type AssetModel Data Type - The data type of the asset model property.
- name str
- The name of the asset model property.
- type
Asset
Model Property Type - The property type
- data_
type_ Assetspec Model Data Type Spec - 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.
- data
Type "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
- data
Type "AWS/ALARM_STATE"Spec - The data type of the structure for this property.
- external
Id String - The External ID of the Asset Model Property
- id String
- The ID of the Asset Model Property
- logical
Id 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
AssetModelTransform
- Expression string
- The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.
- Variables
List<Pulumi.
Aws Native. Io TSite Wise. Inputs. Asset Model Expression Variable> - 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
[]Asset
Model Expression Variable - 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<Asset
Model Expression Variable> - 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
Asset
Model Expression Variable[] - 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[Asset
Model Expression Variable] - 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
AssetModelTypeName
AssetModelVariableValue
- Hierarchy
External stringId - The External ID of the hierarchy that is trying to be referenced
- Hierarchy
Id string - The ID of the hierarchy that is trying to be referenced
- Hierarchy
Logical stringId - Property
External stringId - The External ID of the property that is trying to be referenced
- Property
Id string - The ID of the property that is trying to be referenced
- Property
Logical stringId - Property
Path List<Pulumi.Aws Native. Io TSite Wise. Inputs. Asset Model Property Path Definition> - The path of the property that is trying to be referenced
- Hierarchy
External stringId - The External ID of the hierarchy that is trying to be referenced
- Hierarchy
Id string - The ID of the hierarchy that is trying to be referenced
- Hierarchy
Logical stringId - Property
External stringId - The External ID of the property that is trying to be referenced
- Property
Id string - The ID of the property that is trying to be referenced
- Property
Logical stringId - Property
Path []AssetModel Property Path Definition - The path of the property that is trying to be referenced
- hierarchy
External StringId - The External ID of the hierarchy that is trying to be referenced
- hierarchy
Id String - The ID of the hierarchy that is trying to be referenced
- hierarchy
Logical StringId - property
External StringId - The External ID of the property that is trying to be referenced
- property
Id String - The ID of the property that is trying to be referenced
- property
Logical StringId - property
Path List<AssetModel Property Path Definition> - The path of the property that is trying to be referenced
- hierarchy
External stringId - The External ID of the hierarchy that is trying to be referenced
- hierarchy
Id string - The ID of the hierarchy that is trying to be referenced
- hierarchy
Logical stringId - property
External stringId - The External ID of the property that is trying to be referenced
- property
Id string - The ID of the property that is trying to be referenced
- property
Logical stringId - property
Path AssetModel Property Path Definition[] - The path of the property that is trying to be referenced
- hierarchy_
external_ strid - 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_ strid - property_
external_ strid - 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_ strid - property_
path Sequence[AssetModel Property Path Definition] - The path of the property that is trying to be referenced
- hierarchy
External StringId - The External ID of the hierarchy that is trying to be referenced
- hierarchy
Id String - The ID of the hierarchy that is trying to be referenced
- hierarchy
Logical StringId - property
External StringId - The External ID of the property that is trying to be referenced
- property
Id String - The ID of the property that is trying to be referenced
- property
Logical StringId - property
Path List<Property Map> - The path of the property that is trying to be referenced
Tag
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.102.0 published on Tuesday, Apr 16, 2024 by Pulumi