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

Amazonka.IoTSiteWise.DescribeTimeSeries

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data DescribeTimeSeries Source #

See: newDescribeTimeSeries smart constructor.

Constructors

DescribeTimeSeries'
Fields alias :: Maybe Text The alias that identifies the time series. assetId :: Maybe Text The ID of the asset in which the asset property was created. propertyId :: Maybe Text The ID of the asset property.

Instances

Instances details

ToHeaders DescribeTimeSeries Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries Methods toHeaders :: DescribeTimeSeries -> [Header] #
ToPath DescribeTimeSeries Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries Methods toPath :: DescribeTimeSeries -> ByteString #
ToQuery DescribeTimeSeries Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries Methods toQuery :: DescribeTimeSeries -> QueryString #
AWSRequest DescribeTimeSeries Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries Associated Types type AWSResponse DescribeTimeSeries # Methods request :: (Service -> Service) -> DescribeTimeSeries -> Request DescribeTimeSeries # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeTimeSeries -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTimeSeries))) #
Generic DescribeTimeSeries Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries Associated Types type Rep DescribeTimeSeries :: Type -> Type # Methods from :: DescribeTimeSeries -> Rep DescribeTimeSeries x # to :: Rep DescribeTimeSeries x -> DescribeTimeSeries #
Read DescribeTimeSeries Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries Methods readsPrec :: Int -> ReadS DescribeTimeSeries # readList :: ReadS [DescribeTimeSeries] # readPrec :: ReadPrec DescribeTimeSeries # readListPrec :: ReadPrec [DescribeTimeSeries] #
Show DescribeTimeSeries Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries Methods showsPrec :: Int -> DescribeTimeSeries -> ShowS # show :: DescribeTimeSeries -> String # showList :: [DescribeTimeSeries] -> ShowS #
NFData DescribeTimeSeries Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries Methods rnf :: DescribeTimeSeries -> () #
Eq DescribeTimeSeries Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries Methods (==) :: DescribeTimeSeries -> DescribeTimeSeries -> Bool # (/=) :: DescribeTimeSeries -> DescribeTimeSeries -> Bool #
Hashable DescribeTimeSeries Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries Methods hashWithSalt :: Int -> DescribeTimeSeries -> Int # hash :: DescribeTimeSeries -> Int #
type AWSResponse DescribeTimeSeries Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries type AWSResponse DescribeTimeSeries = DescribeTimeSeriesResponse
type Rep DescribeTimeSeries Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries type Rep DescribeTimeSeries = D1 ('MetaData "DescribeTimeSeries" "Amazonka.IoTSiteWise.DescribeTimeSeries" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "DescribeTimeSeries'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "assetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "propertyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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.

Constructors

DescribeTimeSeriesResponse'

Fields

alias :: Maybe Text
The alias that identifies the time series.
assetId :: Maybe Text
The ID of the asset in which the asset property was created.
dataTypeSpec :: Maybe Text
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.
propertyId :: Maybe Text
The ID of the asset property.
httpStatus :: Int
The response's http status code.
timeSeriesId :: Text
The ID of the time series.
dataType :: PropertyDataType
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.
timeSeriesCreationDate :: POSIX
The date that the time series was created, in Unix epoch time.
timeSeriesLastUpdateDate :: POSIX
The date that the time series was last updated, in Unix epoch time.

Instances

Instances details

Generic DescribeTimeSeriesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries Associated Types type Rep DescribeTimeSeriesResponse :: Type -> Type # Methods from :: DescribeTimeSeriesResponse -> Rep DescribeTimeSeriesResponse x # to :: Rep DescribeTimeSeriesResponse x -> DescribeTimeSeriesResponse #
Read DescribeTimeSeriesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries Methods readsPrec :: Int -> ReadS DescribeTimeSeriesResponse # readList :: ReadS [DescribeTimeSeriesResponse] # readPrec :: ReadPrec DescribeTimeSeriesResponse # readListPrec :: ReadPrec [DescribeTimeSeriesResponse] #
Show DescribeTimeSeriesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries Methods showsPrec :: Int -> DescribeTimeSeriesResponse -> ShowS # show :: DescribeTimeSeriesResponse -> String # showList :: [DescribeTimeSeriesResponse] -> ShowS #
NFData DescribeTimeSeriesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries Methods rnf :: DescribeTimeSeriesResponse -> () #
Eq DescribeTimeSeriesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries Methods (==) :: DescribeTimeSeriesResponse -> DescribeTimeSeriesResponse -> Bool # (/=) :: DescribeTimeSeriesResponse -> DescribeTimeSeriesResponse -> Bool #
type Rep DescribeTimeSeriesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeTimeSeries type Rep DescribeTimeSeriesResponse = D1 ('MetaData "DescribeTimeSeriesResponse" "Amazonka.IoTSiteWise.DescribeTimeSeries" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "DescribeTimeSeriesResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "assetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dataTypeSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "propertyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "timeSeriesId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "dataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PropertyDataType) :: (S1 ('MetaSel ('Just "timeSeriesCreationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "timeSeriesLastUpdateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newDescribeTimeSeriesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeTimeSeriesResponse'`
-> Text	`DescribeTimeSeriesResponse`
-> PropertyDataType	`DescribeTimeSeriesResponse`
-> UTCTime	`DescribeTimeSeriesResponse`
-> UTCTime	`DescribeTimeSeriesResponse`
-> 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.