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.DeleteTimeSeries

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.

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.

Creating a Request

data DeleteTimeSeries Source #

See: newDeleteTimeSeries smart constructor.

Constructors

DeleteTimeSeries'

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.
clientToken :: Maybe Text
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
propertyId :: Maybe Text
The ID of the asset property.

Instances

Instances details

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

newDeleteTimeSeries :: DeleteTimeSeries Source #

Create a value of DeleteTimeSeries 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:

DeleteTimeSeries, deleteTimeSeries_alias - The alias that identifies the time series.

DeleteTimeSeries, deleteTimeSeries_assetId - The ID of the asset in which the asset property was created.

$sel:clientToken:DeleteTimeSeries', deleteTimeSeries_clientToken - A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

DeleteTimeSeries, deleteTimeSeries_propertyId - The ID of the asset property.

Request Lenses

deleteTimeSeries_alias :: Lens' DeleteTimeSeries (Maybe Text) Source #

The alias that identifies the time series.

deleteTimeSeries_assetId :: Lens' DeleteTimeSeries (Maybe Text) Source #

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

deleteTimeSeries_clientToken :: Lens' DeleteTimeSeries (Maybe Text) Source #

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

deleteTimeSeries_propertyId :: Lens' DeleteTimeSeries (Maybe Text) Source #

The ID of the asset property.

Destructuring the Response

data DeleteTimeSeriesResponse Source #

See: newDeleteTimeSeriesResponse smart constructor.

Constructors

DeleteTimeSeriesResponse'

Instances

Instances details

Generic DeleteTimeSeriesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DeleteTimeSeries Associated Types type Rep DeleteTimeSeriesResponse :: Type -> Type # Methods from :: DeleteTimeSeriesResponse -> Rep DeleteTimeSeriesResponse x # to :: Rep DeleteTimeSeriesResponse x -> DeleteTimeSeriesResponse #
Read DeleteTimeSeriesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DeleteTimeSeries Methods readsPrec :: Int -> ReadS DeleteTimeSeriesResponse # readList :: ReadS [DeleteTimeSeriesResponse] # readPrec :: ReadPrec DeleteTimeSeriesResponse # readListPrec :: ReadPrec [DeleteTimeSeriesResponse] #
Show DeleteTimeSeriesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DeleteTimeSeries Methods showsPrec :: Int -> DeleteTimeSeriesResponse -> ShowS # show :: DeleteTimeSeriesResponse -> String # showList :: [DeleteTimeSeriesResponse] -> ShowS #
NFData DeleteTimeSeriesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DeleteTimeSeries Methods rnf :: DeleteTimeSeriesResponse -> () #
Eq DeleteTimeSeriesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DeleteTimeSeries Methods (==) :: DeleteTimeSeriesResponse -> DeleteTimeSeriesResponse -> Bool # (/=) :: DeleteTimeSeriesResponse -> DeleteTimeSeriesResponse -> Bool #
type Rep DeleteTimeSeriesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DeleteTimeSeries type Rep DeleteTimeSeriesResponse = D1 ('MetaData "DeleteTimeSeriesResponse" "Amazonka.IoTSiteWise.DeleteTimeSeries" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "DeleteTimeSeriesResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteTimeSeriesResponse :: DeleteTimeSeriesResponse Source #

Create a value of DeleteTimeSeriesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.