Module Values.DescribeTimeSeriesResponseSource

Retrieves information about a time series (data stream). To identify a time series, do one of the following: If the time series isn't associated with an asset property, specify the alias of the time series. If the time series is associated with an asset property, specify one of the following: The alias of the time series. The assetId and propertyId that identifies the asset property.

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

    The ID of the asset in which the asset property was created.

    *)
  2. propertyId : ID.t option;
    (*

    The ID of the asset property, in UUID format.

    *)
  3. alias : PropertyAlias.t option;
    (*

    The alias that identifies the time series.

    *)
  4. timeSeriesId : TimeSeriesId.t option;
    (*

    The ID of the time series.

    *)
  5. dataType : PropertyDataType.t option;
    (*

    The data type of the time series. If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this time series.

    *)
  6. dataTypeSpec : Name.t option;
    (*

    The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type. The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.

    *)
  7. timeSeriesCreationDate : Timestamp.t option;
    (*

    The date that the time series was created, in Unix epoch time.

    *)
  8. timeSeriesLastUpdateDate : Timestamp.t option;
    (*

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

    *)
  9. timeSeriesArn : ARN.t option;
    (*

    The ARN of the time series, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}

    *)
}
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:??? -> ?propertyId:??? -> ?alias:??? -> ?timeSeriesId:??? -> ?dataType:??? -> ?dataTypeSpec:??? -> ?timeSeriesCreationDate:??? -> ?timeSeriesLastUpdateDate:??? -> ?timeSeriesArn:??? -> 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 * [> `Enum of string | `String of ID.t | `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