Module Values.DescribeAssetResponseSource

Retrieves information about an asset.

Sourcetype nonrec t = {
  1. assetId : ID.t option;
    (*

    The ID of the asset, in UUID format.

    *)
  2. assetExternalId : ExternalId.t option;
    (*

    The external ID of the asset, if any.

    *)
  3. assetArn : ARN.t option;
    (*

    The ARN of the asset, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

    *)
  4. assetName : Name.t option;
    (*

    The name of the asset.

    *)
  5. assetModelId : ID.t option;
    (*

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

    *)
  6. assetProperties : AssetProperties.t option;
    (*

    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.

    *)
  7. assetHierarchies : AssetHierarchies.t option;
    (*

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

    *)
  8. assetCompositeModels : AssetCompositeModels.t option;
    (*

    The composite models for the asset.

    *)
  9. assetCreationDate : Timestamp.t option;
    (*

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

    *)
  10. assetLastUpdateDate : Timestamp.t option;
    (*

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

    *)
  11. assetStatus : AssetStatus.t option;
    (*

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

    *)
  12. assetDescription : Description.t option;
    (*

    A description for the asset.

    *)
  13. assetCompositeModelSummaries : AssetCompositeModelSummaries.t option;
    (*

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

    *)
}
Sourcetype nonrec error = [
  1. | `InternalFailureException of InternalFailureException.t
  2. | `InvalidRequestException of InvalidRequestException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `ThrottlingException of ThrottlingException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?assetId:??? -> ?assetExternalId:??? -> ?assetArn:??? -> ?assetName:??? -> ?assetModelId:??? -> ?assetProperties:??? -> ?assetHierarchies:??? -> ?assetCompositeModels:??? -> ?assetCreationDate:??? -> ?assetLastUpdateDate:??? -> ?assetStatus:??? -> ?assetDescription:??? -> ?assetCompositeModelSummaries:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalFailureException of InternalFailureException.t | `InvalidRequestException of InvalidRequestException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalFailureException of InternalFailureException.t | `InvalidRequestException of InvalidRequestException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of ID.t ]) list ] list | `String of ID.t | `Structure of (string * [> `Enum of string | `String of PropertyNotificationTopic.t ]) list ]) list ] list | `String of ID.t | `Structure of (string * [> `Enum of string | `String of PropertyNotificationTopic.t ]) list ]) list ] list | `String of ID.t | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `String of DetailedErrorMessage.t ]) list ] list | `String of ErrorMessage.t ]) list ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t