aws_sdk_datazone/client/
list_time_series_data_points.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListTimeSeriesDataPoints`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_identifier(impl Into<String>)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::domain_identifier) / [`set_domain_identifier(Option<String>)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::set_domain_identifier):<br>required: **true**<br><p>The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points.</p><br>
    ///   - [`entity_identifier(impl Into<String>)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::entity_identifier) / [`set_entity_identifier(Option<String>)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::set_entity_identifier):<br>required: **true**<br><p>The ID of the asset for which you want to list data points.</p><br>
    ///   - [`entity_type(TimeSeriesEntityType)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::entity_type) / [`set_entity_type(Option<TimeSeriesEntityType>)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::set_entity_type):<br>required: **true**<br><p>The type of the asset for which you want to list data points.</p><br>
    ///   - [`form_name(impl Into<String>)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::form_name) / [`set_form_name(Option<String>)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::set_form_name):<br>required: **true**<br><p>The name of the time series data points form.</p><br>
    ///   - [`started_at(DateTime)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::started_at) / [`set_started_at(Option<DateTime>)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::set_started_at):<br>required: **false**<br><p>The timestamp at which the data points that you want to list started.</p><br>
    ///   - [`ended_at(DateTime)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::ended_at) / [`set_ended_at(Option<DateTime>)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::set_ended_at):<br>required: **false**<br><p>The timestamp at which the data points that you wanted to list ended.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::set_next_token):<br>required: **false**<br><p>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.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::set_max_results):<br>required: **false**<br><p>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.</p><br>
    /// - On success, responds with [`ListTimeSeriesDataPointsOutput`](crate::operation::list_time_series_data_points::ListTimeSeriesDataPointsOutput) with field(s):
    ///   - [`items(Option<Vec::<TimeSeriesDataPointSummaryFormOutput>>)`](crate::operation::list_time_series_data_points::ListTimeSeriesDataPointsOutput::items): <p>The results of the ListTimeSeriesDataPoints action.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_time_series_data_points::ListTimeSeriesDataPointsOutput::next_token): <p>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.</p>
    /// - On failure, responds with [`SdkError<ListTimeSeriesDataPointsError>`](crate::operation::list_time_series_data_points::ListTimeSeriesDataPointsError)
    pub fn list_time_series_data_points(&self) -> crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder {
        crate::operation::list_time_series_data_points::builders::ListTimeSeriesDataPointsFluentBuilder::new(self.handle.clone())
    }
}