time_series_data_points

Creates, updates, deletes, gets or lists a time_series_data_points resource.

Overview

Name	time_series_data_points
Type	Resource
Id	aws.datazone.time_series_data_points

Fields

The following fields are returned by SELECT queries:

get_time_series_data_point

Name	Datatype	Description
domain_id	string	The ID of the Amazon DataZone domain that houses the asset data point that you want to get. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
entity_id	string	The ID of the asset for which you want to get the data point. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
entity_type	string	The type of the asset for which you want to get the data point. (ASSET, LISTING)
form	object	The time series data points form.
form_name	string	The name of the time series form that houses the data point that you want to get.

list_time_series_data_points

Name	Datatype	Description
id	string	The ID of the time series data points summary form. (pattern: <code>[a-zA-Z0-9_-]{0,36}</code>)
content_summary	string	The content of the summary of the time series data points form.
form_name	string	The name of the time series data points summary form.
timestamp	string (date-time)	The timestamp of the time series data points summary form.
type_identifier	string	The type ID of the time series data points summary form. (pattern: <code>(?!.)[\w.]*\w</code>)
type_revision	string	The type revision of the time series data points summary form.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_time_series_data_point	select	domain_identifier, entity_identifier, entity_type, identifier, formName, region		Gets the existing data point for the asset.
list_time_series_data_points	select	domain_identifier, entity_identifier, entity_type, formName, region	startedAt, endedAt, nextToken, maxResults	Lists time series data points.
delete_time_series_data_points	delete	domain_identifier, entity_identifier, entity_type, formName, region	clientToken	Deletes the specified time series form for the specified asset.
post_time_series_data_points	exec	domain_identifier, entity_identifier, entity_type, region, forms		Posts time series data points to Amazon DataZone for the specified asset.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_identifier	string	The ID of the Amazon DataZone domain in which you want to post time series data points.
entity_identifier	string	The ID of the asset for which you want to post time series data points.
entity_type	string	The type of the asset for which you want to post data points.
formName	string	The name of the time series form that you want to delete.
identifier	string	The ID of the data point that you want to get.
region	string	AWS region (default: us-east-1)
clientToken	string	A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.
endedAt	string (date-time)	The timestamp at which the data points that you wanted to list ended.
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	string (date-time)	The timestamp at which the data points that you want to list started.

SELECT examples

get_time_series_data_point

Gets the existing data point for the asset.

SELECT
domain_id,
entity_id,
entity_type,
form,
form_name
FROM aws.datazone.time_series_data_points
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND entity_identifier = '{{ entity_identifier }}' -- required
AND entity_type = '{{ entity_type }}' -- required
AND identifier = '{{ identifier }}' -- required
AND formName = '{{ formName }}' -- required
AND region = '{{ region }}' -- required
;

list_time_series_data_points

Lists time series data points.

SELECT
id,
content_summary,
form_name,
timestamp,
type_identifier,
type_revision
FROM aws.datazone.time_series_data_points
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND entity_identifier = '{{ entity_identifier }}' -- required
AND entity_type = '{{ entity_type }}' -- required
AND formName = '{{ formName }}' -- required
AND region = '{{ region }}' -- required
AND startedAt = '{{ startedAt }}'
AND endedAt = '{{ endedAt }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

DELETE examples

delete_time_series_data_points

Deletes the specified time series form for the specified asset.

DELETE FROM aws.datazone.time_series_data_points
WHERE domain_identifier = '{{ domain_identifier }}' --required
AND entity_identifier = '{{ entity_identifier }}' --required
AND entity_type = '{{ entity_type }}' --required
AND formName = '{{ formName }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;

Lifecycle Methods

post_time_series_data_points

Posts time series data points to Amazon DataZone for the specified asset.

EXEC aws.datazone.time_series_data_points.post_time_series_data_points 
@domain_identifier='{{ domain_identifier }}' --required, 
@entity_identifier='{{ entity_identifier }}' --required, 
@entity_type='{{ entity_type }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"forms": "{{ forms }}", 
"clientToken": "{{ clientToken }}"
}'
;