AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Retrieves information about a time series (data stream).

To identify a time series, do one of the following:

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeTimeSeries and EndDescribeTimeSeries.

Namespace: Amazon.IoTSiteWise
Assembly: AWSSDK.IoTSiteWise.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<DescribeTimeSeriesResponse> DescribeTimeSeriesAsync(
         DescribeTimeSeriesRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.IoTSiteWise.Model.DescribeTimeSeriesRequest

Container for the necessary parameters to execute the DescribeTimeSeries service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DescribeTimeSeries service method, as returned by IoTSiteWise.

Exceptions

ExceptionCondition
InternalFailureException IoT SiteWise can't process your request right now. Try again later.
InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
ResourceNotFoundException The requested resource can't be found.
ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also