DataZone / Client / list_time_series_data_points
list_time_series_data_points#
- DataZone.Client.list_time_series_data_points(**kwargs)#
Lists time series data points.
See also: AWS API Documentation
Request Syntax
response = client.list_time_series_data_points( domainIdentifier='string', endedAt=datetime(2015, 1, 1), entityIdentifier='string', entityType='ASSET'|'LISTING', formName='string', maxResults=123, nextToken='string', startedAt=datetime(2015, 1, 1) )
- Parameters:
domainIdentifier (string) –
[REQUIRED]
The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points.
endedAt (datetime) – The timestamp at which the data points that you wanted to list ended.
entityIdentifier (string) –
[REQUIRED]
The ID of the asset for which you want to list data points.
entityType (string) –
[REQUIRED]
The type of the asset for which you want to list data points.
formName (string) –
[REQUIRED]
The name of the time series data points form.
maxResults (integer) – 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) – 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 (datetime) – The timestamp at which the data points that you want to list started.
- Return type:
dict
- Returns:
Response Syntax
{ 'items': [ { 'contentSummary': 'string', 'formName': 'string', 'id': 'string', 'timestamp': datetime(2015, 1, 1), 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], 'nextToken': 'string' }
Response Structure
(dict) –
items (list) –
The results of the ListTimeSeriesDataPoints action.
(dict) –
The summary of the time series data points form.
contentSummary (string) –
The content of the summary of the time series data points form.
formName (string) –
The name of the time series data points summary form.
id (string) –
The ID of the time series data points summary form.
timestamp (datetime) –
The timestamp of the time series data points summary form.
typeIdentifier (string) –
The type ID of the time series data points summary form.
typeRevision (string) –
The type revision of the time series data points summary form.
nextToken (string) –
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.
Exceptions
DataZone.Client.exceptions.InternalServerException
DataZone.Client.exceptions.ResourceNotFoundException
DataZone.Client.exceptions.AccessDeniedException
DataZone.Client.exceptions.ThrottlingException
DataZone.Client.exceptions.ValidationException
DataZone.Client.exceptions.UnauthorizedException