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

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.iotsitewise.getAsset

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::IoTSiteWise::Asset

    Using getAsset

    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 getAsset(args: GetAssetArgs, opts?: InvokeOptions): Promise<GetAssetResult>
function getAssetOutput(args: GetAssetOutputArgs, opts?: InvokeOptions): Output<GetAssetResult>
    def get_asset(asset_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetAssetResult
def get_asset_output(asset_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAssetResult]
    func LookupAsset(ctx *Context, args *LookupAssetArgs, opts ...InvokeOption) (*LookupAssetResult, error)
func LookupAssetOutput(ctx *Context, args *LookupAssetOutputArgs, opts ...InvokeOption) LookupAssetResultOutput

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

    public static class GetAsset 
{
    public static Task<GetAssetResult> InvokeAsync(GetAssetArgs args, InvokeOptions? opts = null)
    public static Output<GetAssetResult> Invoke(GetAssetInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAssetResult> getAsset(GetAssetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    AssetId string
    The ID of the asset
    AssetId string
    The ID of the asset
    assetId String
    The ID of the asset
    assetId string
    The ID of the asset
    asset_id str
    The ID of the asset
    assetId String
    The ID of the asset

    getAsset Result

    The following output properties are available:

    AssetArn string
    The ARN of the asset
    AssetDescription string
    A description for the asset
    AssetExternalId string
    The External ID of the asset
    AssetHierarchies List<Pulumi.AwsNative.IoTSiteWise.Outputs.AssetHierarchy>
    A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
    AssetId string
    The ID of the asset
    AssetModelId string
    The ID of the asset model from which to create the asset.
    AssetName string
    A unique, friendly name for the asset.
    AssetProperties List<Pulumi.AwsNative.IoTSiteWise.Outputs.AssetProperty>

    The list of asset properties for the asset.

    This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of key-value pairs that contain metadata for the asset.
    AssetArn string
    The ARN of the asset
    AssetDescription string
    A description for the asset
    AssetExternalId string
    The External ID of the asset
    AssetHierarchies []AssetHierarchy
    A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
    AssetId string
    The ID of the asset
    AssetModelId string
    The ID of the asset model from which to create the asset.
    AssetName string
    A unique, friendly name for the asset.
    AssetProperties []AssetProperty

    The list of asset properties for the asset.

    This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

    Tags Tag
    A list of key-value pairs that contain metadata for the asset.
    assetArn String
    The ARN of the asset
    assetDescription String
    A description for the asset
    assetExternalId String
    The External ID of the asset
    assetHierarchies List<AssetHierarchy>
    A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
    assetId String
    The ID of the asset
    assetModelId String
    The ID of the asset model from which to create the asset.
    assetName String
    A unique, friendly name for the asset.
    assetProperties List<AssetProperty>

    The list of asset properties for the asset.

    This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

    tags List<Tag>
    A list of key-value pairs that contain metadata for the asset.
    assetArn string
    The ARN of the asset
    assetDescription string
    A description for the asset
    assetExternalId string
    The External ID of the asset
    assetHierarchies AssetHierarchy[]
    A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
    assetId string
    The ID of the asset
    assetModelId string
    The ID of the asset model from which to create the asset.
    assetName string
    A unique, friendly name for the asset.
    assetProperties AssetProperty[]

    The list of asset properties for the asset.

    This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

    tags Tag[]
    A list of key-value pairs that contain metadata for the asset.
    asset_arn str
    The ARN of the asset
    asset_description str
    A description for the asset
    asset_external_id str
    The External ID of the asset
    asset_hierarchies Sequence[AssetHierarchy]
    A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
    asset_id str
    The ID of the asset
    asset_model_id str
    The ID of the asset model from which to create the asset.
    asset_name str
    A unique, friendly name for the asset.
    asset_properties Sequence[AssetProperty]

    The list of asset properties for the asset.

    This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

    tags Sequence[root_Tag]
    A list of key-value pairs that contain metadata for the asset.
    assetArn String
    The ARN of the asset
    assetDescription String
    A description for the asset
    assetExternalId String
    The External ID of the asset
    assetHierarchies List<Property Map>
    A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.
    assetId String
    The ID of the asset
    assetModelId String
    The ID of the asset model from which to create the asset.
    assetName String
    A unique, friendly name for the asset.
    assetProperties List<Property Map>

    The list of asset properties for the asset.

    This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

    tags List<Property Map>
    A list of key-value pairs that contain metadata for the asset.

    Supporting Types

    AssetHierarchy

    ChildAssetId string
    The ID of the child asset to be associated.
    ExternalId string
    String-friendly customer provided external ID
    Id string
    Customer provided actual UUID for property
    LogicalId string
    The LogicalID of a hierarchy in the parent asset's model.
    ChildAssetId string
    The ID of the child asset to be associated.
    ExternalId string
    String-friendly customer provided external ID
    Id string
    Customer provided actual UUID for property
    LogicalId string
    The LogicalID of a hierarchy in the parent asset's model.
    childAssetId String
    The ID of the child asset to be associated.
    externalId String
    String-friendly customer provided external ID
    id String
    Customer provided actual UUID for property
    logicalId String
    The LogicalID of a hierarchy in the parent asset's model.
    childAssetId string
    The ID of the child asset to be associated.
    externalId string
    String-friendly customer provided external ID
    id string
    Customer provided actual UUID for property
    logicalId string
    The LogicalID of a hierarchy in the parent asset's model.
    child_asset_id str
    The ID of the child asset to be associated.
    external_id str
    String-friendly customer provided external ID
    id str
    Customer provided actual UUID for property
    logical_id str
    The LogicalID of a hierarchy in the parent asset's model.
    childAssetId String
    The ID of the child asset to be associated.
    externalId String
    String-friendly customer provided external ID
    id String
    Customer provided actual UUID for property
    logicalId String
    The LogicalID of a hierarchy in the parent asset's model.

    AssetProperty

    Alias string
    The property alias that identifies the property.
    ExternalId string
    String-friendly customer provided external ID
    Id string
    Customer provided actual UUID for property
    LogicalId string
    Customer provided ID for property.
    NotificationState Pulumi.AwsNative.IoTSiteWise.AssetPropertyNotificationState
    The MQTT notification state (ENABLED or DISABLED) for this asset property.
    Unit string
    The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.
    Alias string
    The property alias that identifies the property.
    ExternalId string
    String-friendly customer provided external ID
    Id string
    Customer provided actual UUID for property
    LogicalId string
    Customer provided ID for property.
    NotificationState AssetPropertyNotificationState
    The MQTT notification state (ENABLED or DISABLED) for this asset property.
    Unit string
    The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.
    alias String
    The property alias that identifies the property.
    externalId String
    String-friendly customer provided external ID
    id String
    Customer provided actual UUID for property
    logicalId String
    Customer provided ID for property.
    notificationState AssetPropertyNotificationState
    The MQTT notification state (ENABLED or DISABLED) for this asset property.
    unit String
    The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.
    alias string
    The property alias that identifies the property.
    externalId string
    String-friendly customer provided external ID
    id string
    Customer provided actual UUID for property
    logicalId string
    Customer provided ID for property.
    notificationState AssetPropertyNotificationState
    The MQTT notification state (ENABLED or DISABLED) for this asset property.
    unit string
    The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.
    alias str
    The property alias that identifies the property.
    external_id str
    String-friendly customer provided external ID
    id str
    Customer provided actual UUID for property
    logical_id str
    Customer provided ID for property.
    notification_state AssetPropertyNotificationState
    The MQTT notification state (ENABLED or DISABLED) for this asset property.
    unit str
    The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.
    alias String
    The property alias that identifies the property.
    externalId String
    String-friendly customer provided external ID
    id String
    Customer provided actual UUID for property
    logicalId String
    Customer provided ID for property.
    notificationState "ENABLED" | "DISABLED"
    The MQTT notification state (ENABLED or DISABLED) for this asset property.
    unit String
    The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.

    AssetPropertyNotificationState

    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.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native