Own AWS? Customize your docs with AI search, analytics, and more.

GET

/timeseries/describe/

http://iotsitewise.{region}.amazonaws.com/timeseries/describe/

Retrieves information about a time series (data stream). To identify a time series, do one of the following: <ul> <li> If the time series isn't associated with an asset property, specify the <code>alias</code> of the time series. </li> <li> If the time series is associated with an asset property, specify one of the following: <ul> <li> The <code>alias</code> of the time series. </li> <li> The <code>assetId</code> and <code>propertyId</code> that identifies the asset property. </li> </ul> </li> </ul>

Access Token Required: API Key

Query Params

aliasstring

The alias that identifies the time series.

assetIdstring

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

propertyIdstring

The ID of the asset property.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://iotsitewise.{region}.amazonaws.com/timeseries/describe/' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/timeseries/describe/

http://iotsitewise.{region}.amazonaws.com/timeseries/describe/

Retrieves information about a time series (data stream). To identify a time series, do one of the following: <ul> <li> If the time series isn't associated with an asset property, specify the <code>alias</code> of the time series. </li> <li> If the time series is associated with an asset property, specify one of the following: <ul> <li> The <code>alias</code> of the time series. </li> <li> The <code>assetId</code> and <code>propertyId</code> that identifies the asset property. </li> </ul> </li> </ul>

Access Token Required: API Key

Query Params

aliasstring

The alias that identifies the time series.

assetIdstring

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

propertyIdstring

The ID of the asset property.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://iotsitewise.{region}.amazonaws.com/timeseries/describe/' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/timeseries/describe/

http://iotsitewise.{region}.amazonaws.com/timeseries/describe/

Retrieves information about a time series (data stream). To identify a time series, do one of the following: <ul> <li> If the time series isn't associated with an asset property, specify the <code>alias</code> of the time series. </li> <li> If the time series is associated with an asset property, specify one of the following: <ul> <li> The <code>alias</code> of the time series. </li> <li> The <code>assetId</code> and <code>propertyId</code> that identifies the asset property. </li> </ul> </li> </ul>

Access Token Required: API Key

Query Params

aliasstring

The alias that identifies the time series.

assetIdstring

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

propertyIdstring

The ID of the asset property.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://iotsitewise.{region}.amazonaws.com/timeseries/describe/' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/timeseries/describe/

http://iotsitewise.{region}.amazonaws.com/timeseries/describe/

Retrieves information about a time series (data stream). To identify a time series, do one of the following: <ul> <li> If the time series isn't associated with an asset property, specify the <code>alias</code> of the time series. </li> <li> If the time series is associated with an asset property, specify one of the following: <ul> <li> The <code>alias</code> of the time series. </li> <li> The <code>assetId</code> and <code>propertyId</code> that identifies the asset property. </li> </ul> </li> </ul>

Access Token Required: API Key

Query Params

aliasstring

The alias that identifies the time series.

assetIdstring

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

propertyIdstring

The ID of the asset property.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://iotsitewise.{region}.amazonaws.com/timeseries/describe/' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}