Iot Sitewise Describe Time Series Response Structure
DescribeTimeSeriesResponse schema
Type: objectProperties: 9Required: 5
Asset ManagementIndustrial IoTIoTTime Series Data
DescribeTimeSeriesResponse is a JSON Structure definition published by Amazon IoT SiteWise, describing 9 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-sitewise/refs/heads/main/json-structure/iot-sitewise-describe-time-series-response-structure.json",
"name": "DescribeTimeSeriesResponse",
"description": "DescribeTimeSeriesResponse schema",
"type": "object",
"properties": {
"assetId": {
"allOf": [
{
"$ref": "#/components/schemas/ID"
},
{
"description": "The ID of the asset in which the asset property was created."
}
]
},
"propertyId": {
"allOf": [
{
"$ref": "#/components/schemas/ID"
},
{
"description": "The ID of the asset property."
}
]
},
"alias": {
"allOf": [
{
"$ref": "#/components/schemas/PropertyAlias"
},
{
"description": "The alias that identifies the time series."
}
]
},
"timeSeriesId": {
"allOf": [
{
"$ref": "#/components/schemas/TimeSeriesId"
},
{
"description": "The ID of the time series."
}
]
},
"dataType": {
"allOf": [
{
"$ref": "#/components/schemas/PropertyDataType"
},
{
"description": "<p>The data type of the time series.</p> <p>If you specify <code>STRUCT</code>, you must also specify <code>dataTypeSpec</code> to identify the type of the structure for this time series.</p>"
}
]
},
"dataTypeSpec": {
"allOf": [
{
"$ref": "#/components/schemas/Name"
},
{
"description": "<p>The data type of the structure for this time series. This parameter is required for time series that have the <code>STRUCT</code> data type.</p> <p>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 <code>AWS/ALARM_STATE</code> for alarm state in alarm composite models.</p>"
}
]
},
"timeSeriesCreationDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The date that the time series was created, in Unix epoch time."
}
]
},
"timeSeriesLastUpdateDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The date that the time series was last updated, in Unix epoch time."
}
]
},
"timeSeriesArn": {
"allOf": [
{
"$ref": "#/components/schemas/ARN"
},
{
"description": "<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the time series, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}</code> </p>"
}
]
}
},
"required": [
"timeSeriesId",
"dataType",
"timeSeriesCreationDate",
"timeSeriesLastUpdateDate",
"timeSeriesArn"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.