Class: Aws::IoTSiteWise::Types::DescribeAssetResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::DescribeAssetResponse

Defined in:

gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #asset_arn ⇒ String

  The [ARN][1] of the asset, which has the following format.

• #asset_composite_model_summaries ⇒ Array<Types::AssetCompositeModelSummary>

  The list of the immediate child custom composite model summaries for the asset.

• #asset_composite_models ⇒ Array<Types::AssetCompositeModel>

  The composite models for the asset.

• #asset_creation_date ⇒ Time

  The date the asset was created, in Unix epoch time.

• #asset_description ⇒ String

  A description for the asset.

• #asset_external_id ⇒ String

  The external ID of the asset, if any.

• #asset_hierarchies ⇒ Array<Types::AssetHierarchy>

  A list of asset hierarchies that each contain a hierarchyId.

• #asset_id ⇒ String

  The ID of the asset, in UUID format.

• #asset_last_update_date ⇒ Time

  The date the asset was last updated, in Unix epoch time.

• #asset_model_id ⇒ String

  The ID of the asset model that was used to create the asset.

• #asset_name ⇒ String

  The name of the asset.

• #asset_properties ⇒ Array<Types::AssetProperty>

  The list of asset properties for the asset.

• #asset_status ⇒ Types::AssetStatus

  The current status of the asset, which contains a state and any error message.

Instance Attribute Details

#asset_arn ⇒ String

The ARN of the asset, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4677

class DescribeAssetResponse < Struct.new(
  :asset_id,
  :asset_arn,
  :asset_name,
  :asset_model_id,
  :asset_properties,
  :asset_hierarchies,
  :asset_composite_models,
  :asset_creation_date,
  :asset_last_update_date,
  :asset_status,
  :asset_description,
  :asset_composite_model_summaries,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_composite_model_summaries ⇒ Array<Types::AssetCompositeModelSummary>

The list of the immediate child custom composite model summaries for the asset.

Returns:

• (Array<Types::AssetCompositeModelSummary>)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4677

class DescribeAssetResponse < Struct.new(
  :asset_id,
  :asset_arn,
  :asset_name,
  :asset_model_id,
  :asset_properties,
  :asset_hierarchies,
  :asset_composite_models,
  :asset_creation_date,
  :asset_last_update_date,
  :asset_status,
  :asset_description,
  :asset_composite_model_summaries,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_composite_models ⇒ Array<Types::AssetCompositeModel>

The composite models for the asset.

Returns:

• (Array<Types::AssetCompositeModel>)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4677

class DescribeAssetResponse < Struct.new(
  :asset_id,
  :asset_arn,
  :asset_name,
  :asset_model_id,
  :asset_properties,
  :asset_hierarchies,
  :asset_composite_models,
  :asset_creation_date,
  :asset_last_update_date,
  :asset_status,
  :asset_description,
  :asset_composite_model_summaries,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_creation_date ⇒ Time

The date the asset was created, in Unix epoch time.

Returns:

• (Time)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4677

class DescribeAssetResponse < Struct.new(
  :asset_id,
  :asset_arn,
  :asset_name,
  :asset_model_id,
  :asset_properties,
  :asset_hierarchies,
  :asset_composite_models,
  :asset_creation_date,
  :asset_last_update_date,
  :asset_status,
  :asset_description,
  :asset_composite_model_summaries,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_description ⇒ String

A description for the asset.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4677

class DescribeAssetResponse < Struct.new(
  :asset_id,
  :asset_arn,
  :asset_name,
  :asset_model_id,
  :asset_properties,
  :asset_hierarchies,
  :asset_composite_models,
  :asset_creation_date,
  :asset_last_update_date,
  :asset_status,
  :asset_description,
  :asset_composite_model_summaries,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_external_id ⇒ String

The external ID of the asset, if any.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4677

class DescribeAssetResponse < Struct.new(
  :asset_id,
  :asset_arn,
  :asset_name,
  :asset_model_id,
  :asset_properties,
  :asset_hierarchies,
  :asset_composite_models,
  :asset_creation_date,
  :asset_last_update_date,
  :asset_status,
  :asset_description,
  :asset_composite_model_summaries,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_hierarchies ⇒ Array<Types::AssetHierarchy>

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

Returns:

• (Array<Types::AssetHierarchy>)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4677

class DescribeAssetResponse < Struct.new(
  :asset_id,
  :asset_arn,
  :asset_name,
  :asset_model_id,
  :asset_properties,
  :asset_hierarchies,
  :asset_composite_models,
  :asset_creation_date,
  :asset_last_update_date,
  :asset_status,
  :asset_description,
  :asset_composite_model_summaries,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_id ⇒ String

The ID of the asset, in UUID format.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4677

class DescribeAssetResponse < Struct.new(
  :asset_id,
  :asset_arn,
  :asset_name,
  :asset_model_id,
  :asset_properties,
  :asset_hierarchies,
  :asset_composite_models,
  :asset_creation_date,
  :asset_last_update_date,
  :asset_status,
  :asset_description,
  :asset_composite_model_summaries,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_last_update_date ⇒ Time

The date the asset was last updated, in Unix epoch time.

Returns:

• (Time)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4677

class DescribeAssetResponse < Struct.new(
  :asset_id,
  :asset_arn,
  :asset_name,
  :asset_model_id,
  :asset_properties,
  :asset_hierarchies,
  :asset_composite_models,
  :asset_creation_date,
  :asset_last_update_date,
  :asset_status,
  :asset_description,
  :asset_composite_model_summaries,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_id ⇒ String

The ID of the asset model that was used to create the asset.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4677

class DescribeAssetResponse < Struct.new(
  :asset_id,
  :asset_arn,
  :asset_name,
  :asset_model_id,
  :asset_properties,
  :asset_hierarchies,
  :asset_composite_models,
  :asset_creation_date,
  :asset_last_update_date,
  :asset_status,
  :asset_description,
  :asset_composite_model_summaries,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_name ⇒ String

The name of the asset.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4677

class DescribeAssetResponse < Struct.new(
  :asset_id,
  :asset_arn,
  :asset_name,
  :asset_model_id,
  :asset_properties,
  :asset_hierarchies,
  :asset_composite_models,
  :asset_creation_date,
  :asset_last_update_date,
  :asset_status,
  :asset_description,
  :asset_composite_model_summaries,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_properties ⇒ Array<Types::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.

Returns:

• (Array<Types::AssetProperty>)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4677

class DescribeAssetResponse < Struct.new(
  :asset_id,
  :asset_arn,
  :asset_name,
  :asset_model_id,
  :asset_properties,
  :asset_hierarchies,
  :asset_composite_models,
  :asset_creation_date,
  :asset_last_update_date,
  :asset_status,
  :asset_description,
  :asset_composite_model_summaries,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_status ⇒ Types::AssetStatus

The current status of the asset, which contains a state and any error message.

Returns:

• (Types::AssetStatus)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4677

class DescribeAssetResponse < Struct.new(
  :asset_id,
  :asset_arn,
  :asset_name,
  :asset_model_id,
  :asset_properties,
  :asset_hierarchies,
  :asset_composite_models,
  :asset_creation_date,
  :asset_last_update_date,
  :asset_status,
  :asset_description,
  :asset_composite_model_summaries,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end