ListTimeSeries - Amazon IoT SiteWise
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

ListTimeSeries

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

Request Syntax

GET /timeseries/?aliasPrefix=aliasPrefix&assetId=assetId&maxResults=maxResults&nextToken=nextToken&timeSeriesType=timeSeriesType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

aliasPrefix

The alias prefix of the time series.

Length Constraints: Minimum length of 1.

Pattern: [^\u0000-\u001F\u007F]+

assetId

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

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

maxResults

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

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

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

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: [A-Za-z0-9+/=]+

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.

Valid Values: ASSOCIATED | DISASSOCIATED

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "TimeSeriesSummaries": [ { "alias": "string", "assetId": "string", "dataType": "string", "dataTypeSpec": "string", "propertyId": "string", "timeSeriesCreationDate": number, "timeSeriesId": "string", "timeSeriesLastUpdateDate": number } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: [A-Za-z0-9+/=]+

TimeSeriesSummaries

One or more time series summaries to list.

Type: Array of TimeSeriesSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

Amazon IoT SiteWise can't process your request right now. Try again later.

HTTP Status Code: 500

InvalidRequestException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of Amazon IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the Amazon IoT SiteWise User Guide.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: