Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeTimeSeries

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.

Request Syntax


GET /timeseries/describe/?alias=alias&assetId=assetId&propertyId=propertyId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

alias

The alias that identifies 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. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the Amazon IoT SiteWise User Guide.

Length Constraints: Minimum length of 13. Maximum length of 139.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+

propertyId

The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the Amazon IoT SiteWise User Guide.

Length Constraints: Minimum length of 13. Maximum length of 139.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "alias": "string",
   "assetId": "string",
   "dataType": "string",
   "dataTypeSpec": "string",
   "propertyId": "string",
   "timeSeriesArn": "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.

alias

The alias that identifies the time series.

Type: String

Length Constraints: Minimum length of 1.

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

assetId

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

Type: String

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}$

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.

Type: String

Valid Values: STRING | INTEGER | DOUBLE | BOOLEAN | STRUCT

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.

Type: String

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

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

propertyId

The ID of the asset property, in UUID format.

Type: String

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}$

timeSeriesArn

The ARN of the time series, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}

Type: String

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

Pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$

timeSeriesCreationDate

The date that the time series was created, in Unix epoch time.

Type: Timestamp

timeSeriesId

The ID of the time series.

Type: String

Length Constraints: Minimum length of 36. Maximum length of 73.

timeSeriesLastUpdateDate

The date that the time series was last updated, in Unix epoch time.

Type: Timestamp

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