Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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
andpropertyId
that identifies the asset property.
- The
Synopsis
- data DescribeTimeSeries = DescribeTimeSeries' {}
- newDescribeTimeSeries :: DescribeTimeSeries
- describeTimeSeries_alias :: Lens' DescribeTimeSeries (Maybe Text)
- describeTimeSeries_assetId :: Lens' DescribeTimeSeries (Maybe Text)
- describeTimeSeries_propertyId :: Lens' DescribeTimeSeries (Maybe Text)
- data DescribeTimeSeriesResponse = DescribeTimeSeriesResponse' {}
- newDescribeTimeSeriesResponse :: Int -> Text -> PropertyDataType -> UTCTime -> UTCTime -> DescribeTimeSeriesResponse
- describeTimeSeriesResponse_alias :: Lens' DescribeTimeSeriesResponse (Maybe Text)
- describeTimeSeriesResponse_assetId :: Lens' DescribeTimeSeriesResponse (Maybe Text)
- describeTimeSeriesResponse_dataTypeSpec :: Lens' DescribeTimeSeriesResponse (Maybe Text)
- describeTimeSeriesResponse_propertyId :: Lens' DescribeTimeSeriesResponse (Maybe Text)
- describeTimeSeriesResponse_httpStatus :: Lens' DescribeTimeSeriesResponse Int
- describeTimeSeriesResponse_timeSeriesId :: Lens' DescribeTimeSeriesResponse Text
- describeTimeSeriesResponse_dataType :: Lens' DescribeTimeSeriesResponse PropertyDataType
- describeTimeSeriesResponse_timeSeriesCreationDate :: Lens' DescribeTimeSeriesResponse UTCTime
- describeTimeSeriesResponse_timeSeriesLastUpdateDate :: Lens' DescribeTimeSeriesResponse UTCTime
Creating a Request
data DescribeTimeSeries Source #
See: newDescribeTimeSeries
smart constructor.
Instances
newDescribeTimeSeries :: DescribeTimeSeries Source #
Create a value of DescribeTimeSeries
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTimeSeries
, describeTimeSeries_alias
- The alias that identifies the time series.
DescribeTimeSeries
, describeTimeSeries_assetId
- The ID of the asset in which the asset property was created.
DescribeTimeSeries
, describeTimeSeries_propertyId
- The ID of the asset property.
Request Lenses
describeTimeSeries_alias :: Lens' DescribeTimeSeries (Maybe Text) Source #
The alias that identifies the time series.
describeTimeSeries_assetId :: Lens' DescribeTimeSeries (Maybe Text) Source #
The ID of the asset in which the asset property was created.
describeTimeSeries_propertyId :: Lens' DescribeTimeSeries (Maybe Text) Source #
The ID of the asset property.
Destructuring the Response
data DescribeTimeSeriesResponse Source #
See: newDescribeTimeSeriesResponse
smart constructor.
DescribeTimeSeriesResponse' | |
|
Instances
newDescribeTimeSeriesResponse Source #
:: Int | |
-> Text | |
-> PropertyDataType | |
-> UTCTime | |
-> UTCTime | |
-> DescribeTimeSeriesResponse |
Create a value of DescribeTimeSeriesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTimeSeries
, describeTimeSeriesResponse_alias
- The alias that identifies the time series.
DescribeTimeSeries
, describeTimeSeriesResponse_assetId
- The ID of the asset in which the asset property was created.
DescribeTimeSeriesResponse
, describeTimeSeriesResponse_dataTypeSpec
- 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.
DescribeTimeSeries
, describeTimeSeriesResponse_propertyId
- The ID of the asset property.
$sel:httpStatus:DescribeTimeSeriesResponse'
, describeTimeSeriesResponse_httpStatus
- The response's http status code.
DescribeTimeSeriesResponse
, describeTimeSeriesResponse_timeSeriesId
- The ID of the time series.
DescribeTimeSeriesResponse
, describeTimeSeriesResponse_dataType
- 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.
DescribeTimeSeriesResponse
, describeTimeSeriesResponse_timeSeriesCreationDate
- The date that the time series was created, in Unix epoch time.
DescribeTimeSeriesResponse
, describeTimeSeriesResponse_timeSeriesLastUpdateDate
- The date that the time series was last updated, in Unix epoch time.
Response Lenses
describeTimeSeriesResponse_alias :: Lens' DescribeTimeSeriesResponse (Maybe Text) Source #
The alias that identifies the time series.
describeTimeSeriesResponse_assetId :: Lens' DescribeTimeSeriesResponse (Maybe Text) Source #
The ID of the asset in which the asset property was created.
describeTimeSeriesResponse_dataTypeSpec :: Lens' DescribeTimeSeriesResponse (Maybe Text) Source #
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.
describeTimeSeriesResponse_propertyId :: Lens' DescribeTimeSeriesResponse (Maybe Text) Source #
The ID of the asset property.
describeTimeSeriesResponse_httpStatus :: Lens' DescribeTimeSeriesResponse Int Source #
The response's http status code.
describeTimeSeriesResponse_timeSeriesId :: Lens' DescribeTimeSeriesResponse Text Source #
The ID of the time series.
describeTimeSeriesResponse_dataType :: Lens' DescribeTimeSeriesResponse PropertyDataType Source #
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.
describeTimeSeriesResponse_timeSeriesCreationDate :: Lens' DescribeTimeSeriesResponse UTCTime Source #
The date that the time series was created, in Unix epoch time.
describeTimeSeriesResponse_timeSeriesLastUpdateDate :: Lens' DescribeTimeSeriesResponse UTCTime Source #
The date that the time series was last updated, in Unix epoch time.