1. Packages
  2. AWS Native
  3. API Docs
  4. iotsitewise
  5. getAssetModel

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

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

aws-native.iotsitewise.getAssetModel

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.101.0 published on Thursday, Apr 11, 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:

    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

    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

    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

    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
    Offset string
    Interval string
    Offset string
    interval String
    offset String
    interval string
    offset string
    interval String
    offset String

    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    propertyPath List<Property Map>
    The path of the property that is trying to be referenced

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

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

    AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi