Lists time series data points.
Request Syntax
GET /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/time-series-data-points?endedAt=endedAt&formName=formName&maxResults=maxResults&nextToken=nextToken&startedAt=startedAt HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points.
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$Required: Yes
- endedAt
-
The timestamp at which the data points that you wanted to list ended.
- entityIdentifier
-
The ID of the asset for which you want to list data points.
Pattern:
^[a-zA-Z0-9_-]{1,36}$Required: Yes
- entityType
-
The type of the asset for which you want to list data points.
Valid Values:
ASSET | LISTINGRequired: Yes
- formName
-
The name of the time series data points form.
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
- maxResults
-
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.
Valid Range: Minimum value of 1. Maximum value of 50.
- nextToken
-
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.
Length Constraints: Minimum length of 1. Maximum length of 8192.
- startedAt
-
The timestamp at which the data points that you want to list started.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"items": [
{
"contentSummary": "string",
"formName": "string",
"id": "string",
"timestamp": number,
"typeIdentifier": "string",
"typeRevision": "string"
}
],
"nextToken": "string"
}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.
- items
-
The results of the ListTimeSeriesDataPoints action.
Type: Array of TimeSeriesDataPointSummaryFormOutput objects
- nextToken
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 8192.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
The request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource cannot be found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- UnauthorizedException
-
You do not have permission to perform this action.
HTTP Status Code: 401
- ValidationException
-
The input fails to satisfy the constraints specified by the AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
