ListTimeSeriesDataPointsCommand

Suggest an Edit

Lists time series data points.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, ListTimeSeriesDataPointsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListTimeSeriesDataPointsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListTimeSeriesDataPointsInput
  domainIdentifier: "STRING_VALUE", // required
  entityIdentifier: "STRING_VALUE", // required
  entityType: "ASSET" || "LISTING", // required
  formName: "STRING_VALUE", // required
  startedAt: new Date("TIMESTAMP"),
  endedAt: new Date("TIMESTAMP"),
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListTimeSeriesDataPointsCommand(input);
const response = await client.send(command);
// { // ListTimeSeriesDataPointsOutput
//   items: [ // TimeSeriesDataPointSummaryFormOutputList
//     { // TimeSeriesDataPointSummaryFormOutput
//       formName: "STRING_VALUE", // required
//       typeIdentifier: "STRING_VALUE", // required
//       typeRevision: "STRING_VALUE",
//       timestamp: new Date("TIMESTAMP"), // required
//       contentSummary: "STRING_VALUE",
//       id: "STRING_VALUE",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListTimeSeriesDataPointsCommand Input

See ListTimeSeriesDataPointsCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points.

entityIdentifier
Required
string | undefined

The ID of the asset for which you want to list data points.

entityType
Required
TimeSeriesEntityType | undefined

The type of the asset for which you want to list data points.

formName
Required
string | undefined

The name of the time series data points form.

endedAt
Date | undefined

The timestamp at which the data points that you wanted to list ended.

maxResults
number | undefined

The maximum number of data points to return in a single call to ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.

nextToken
string | undefined

When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.

startedAt
Date | undefined

The timestamp at which the data points that you want to list started.

ListTimeSeriesDataPointsCommand Output

See ListTimeSeriesDataPointsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
items
TimeSeriesDataPointSummaryFormOutput[] | undefined

The results of the ListTimeSeriesDataPoints action.

nextToken
string | undefined

When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The specified resource cannot be found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.