amazonka-iotsitewise-2.0: Amazon IoT SiteWise SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoTSiteWise.ListTimeSeries

Description

Retrieves a paginated list of time series (data streams).

This operation returns paginated results.

Synopsis

Creating a Request

data ListTimeSeries Source #

See: newListTimeSeries smart constructor.

Constructors

ListTimeSeries' 

Fields

  • aliasPrefix :: Maybe Text

    The alias prefix of the time series.

  • assetId :: Maybe Text

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

  • maxResults :: Maybe Natural

    The maximum number of results to return for each paginated request.

  • nextToken :: Maybe Text

    The token to be used for the next set of paginated results.

  • timeSeriesType :: Maybe ListTimeSeriesType

    The type of the time series. The time series type can be one of the following values:

    • ASSOCIATED – The time series is associated with an asset property.
    • DISASSOCIATED – The time series isn't associated with any asset property.

Instances

Instances details
ToHeaders ListTimeSeries Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Methods

toHeaders :: ListTimeSeries -> [Header] #

ToPath ListTimeSeries Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Methods

toPath :: ListTimeSeries -> ByteString #

ToQuery ListTimeSeries Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Methods

toQuery :: ListTimeSeries -> QueryString #

AWSPager ListTimeSeries Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Methods

page :: ListTimeSeries -> AWSResponse ListTimeSeries -> Maybe ListTimeSeries #

AWSRequest ListTimeSeries Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Associated Types

type AWSResponse ListTimeSeries #

Methods

request :: (Service -> Service) -> ListTimeSeries -> Request ListTimeSeries #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListTimeSeries -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTimeSeries))) #

Generic ListTimeSeries Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Associated Types

type Rep ListTimeSeries :: Type -> Type #

Methods

from :: ListTimeSeries -> Rep ListTimeSeries x #

to :: Rep ListTimeSeries x -> ListTimeSeries #

Read ListTimeSeries Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Methods

readsPrec :: Int -> ReadS ListTimeSeries #

readList :: ReadS [ListTimeSeries] #

readPrec :: ReadPrec ListTimeSeries #

readListPrec :: ReadPrec [ListTimeSeries] #

Show ListTimeSeries Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Methods

showsPrec :: Int -> ListTimeSeries -> ShowS #

show :: ListTimeSeries -> String #

showList :: [ListTimeSeries] -> ShowS #

NFData ListTimeSeries Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Methods

rnf :: ListTimeSeries -> () #

Eq ListTimeSeries Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Methods

(==) :: ListTimeSeries -> ListTimeSeries -> Bool #

(/=) :: ListTimeSeries -> ListTimeSeries -> Bool #

Hashable ListTimeSeries Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Methods

hashWithSalt :: Int -> ListTimeSeries -> Int #

hash :: ListTimeSeries -> Int #

type AWSResponse ListTimeSeries Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

type AWSResponse ListTimeSeries = ListTimeSeriesResponse
type Rep ListTimeSeries Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

type Rep ListTimeSeries = D1 ('MetaData "ListTimeSeries" "Amazonka.IoTSiteWise.ListTimeSeries" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "ListTimeSeries'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aliasPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "assetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "timeSeriesType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ListTimeSeriesType))))))

newListTimeSeries :: ListTimeSeries Source #

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

$sel:aliasPrefix:ListTimeSeries', listTimeSeries_aliasPrefix - The alias prefix of the time series.

ListTimeSeries, listTimeSeries_assetId - The ID of the asset in which the asset property was created.

$sel:maxResults:ListTimeSeries', listTimeSeries_maxResults - The maximum number of results to return for each paginated request.

ListTimeSeries, listTimeSeries_nextToken - The token to be used for the next set of paginated results.

$sel:timeSeriesType:ListTimeSeries', listTimeSeries_timeSeriesType - The type of the time series. The time series type can be one of the following values:

  • ASSOCIATED – The time series is associated with an asset property.
  • DISASSOCIATED – The time series isn't associated with any asset property.

Request Lenses

listTimeSeries_aliasPrefix :: Lens' ListTimeSeries (Maybe Text) Source #

The alias prefix of the time series.

listTimeSeries_assetId :: Lens' ListTimeSeries (Maybe Text) Source #

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

listTimeSeries_maxResults :: Lens' ListTimeSeries (Maybe Natural) Source #

The maximum number of results to return for each paginated request.

listTimeSeries_nextToken :: Lens' ListTimeSeries (Maybe Text) Source #

The token to be used for the next set of paginated results.

listTimeSeries_timeSeriesType :: Lens' ListTimeSeries (Maybe ListTimeSeriesType) Source #

The type of the time series. The time series type can be one of the following values:

  • ASSOCIATED – The time series is associated with an asset property.
  • DISASSOCIATED – The time series isn't associated with any asset property.

Destructuring the Response

data ListTimeSeriesResponse Source #

See: newListTimeSeriesResponse smart constructor.

Constructors

ListTimeSeriesResponse' 

Fields

Instances

Instances details
Generic ListTimeSeriesResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Associated Types

type Rep ListTimeSeriesResponse :: Type -> Type #

Methods

from :: ListTimeSeriesResponse -> Rep ListTimeSeriesResponse x #

to :: Rep ListTimeSeriesResponse x -> ListTimeSeriesResponse #

Read ListTimeSeriesResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Methods

readsPrec :: Int -> ReadS ListTimeSeriesResponse #

readList :: ReadS [ListTimeSeriesResponse] #

readPrec :: ReadPrec ListTimeSeriesResponse #

readListPrec :: ReadPrec [ListTimeSeriesResponse] #

Show ListTimeSeriesResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Methods

showsPrec :: Int -> ListTimeSeriesResponse -> ShowS #

show :: ListTimeSeriesResponse -> String #

showList :: [ListTimeSeriesResponse] -> ShowS #

NFData ListTimeSeriesResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Methods

rnf :: ListTimeSeriesResponse -> () #

Eq ListTimeSeriesResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

Methods

(==) :: ListTimeSeriesResponse -> ListTimeSeriesResponse -> Bool #

(/=) :: ListTimeSeriesResponse -> ListTimeSeriesResponse -> Bool #

type Rep ListTimeSeriesResponse Source # 
Instance details

Defined in Amazonka.IoTSiteWise.ListTimeSeries

type Rep ListTimeSeriesResponse = D1 ('MetaData "ListTimeSeriesResponse" "Amazonka.IoTSiteWise.ListTimeSeries" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "ListTimeSeriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "timeSeriesSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TimeSeriesSummary]))))

newListTimeSeriesResponse Source #

Arguments

:: Int

$sel:httpStatus:ListTimeSeriesResponse'

-> ListTimeSeriesResponse 

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

ListTimeSeries, listTimeSeriesResponse_nextToken - The token for the next set of results, or null if there are no additional results.

$sel:httpStatus:ListTimeSeriesResponse', listTimeSeriesResponse_httpStatus - The response's http status code.

$sel:timeSeriesSummaries:ListTimeSeriesResponse', listTimeSeriesResponse_timeSeriesSummaries - One or more time series summaries to list.

Response Lenses

listTimeSeriesResponse_nextToken :: Lens' ListTimeSeriesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no additional results.

listTimeSeriesResponse_httpStatus :: Lens' ListTimeSeriesResponse Int Source #

The response's http status code.

listTimeSeriesResponse_timeSeriesSummaries :: Lens' ListTimeSeriesResponse [TimeSeriesSummary] Source #

One or more time series summaries to list.