aws_sdk_iottwinmaker/client/

get_property_value_history.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetPropertyValueHistory`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`workspace_id(impl Into<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::set_workspace_id):<br>required: **true**<br><p>The ID of the workspace.</p><br>
    ///   - [`entity_id(impl Into<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::entity_id) / [`set_entity_id(Option<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::set_entity_id):<br>required: **false**<br><p>The ID of the entity.</p><br>
    ///   - [`component_name(impl Into<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::component_name) / [`set_component_name(Option<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::set_component_name):<br>required: **false**<br><p>The name of the component.</p><br>
    ///   - [`component_path(impl Into<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::component_path) / [`set_component_path(Option<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::set_component_path):<br>required: **false**<br><p>This string specifies the path to the composite component, starting from the top-level component.</p><br>
    ///   - [`component_type_id(impl Into<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::component_type_id) / [`set_component_type_id(Option<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::set_component_type_id):<br>required: **false**<br><p>The ID of the component type.</p><br>
    ///   - [`selected_properties(impl Into<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::selected_properties) / [`set_selected_properties(Option<Vec::<String>>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::set_selected_properties):<br>required: **true**<br><p>A list of properties whose value histories the request retrieves.</p><br>
    ///   - [`property_filters(PropertyFilter)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::property_filters) / [`set_property_filters(Option<Vec::<PropertyFilter>>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::set_property_filters):<br>required: **false**<br><p>A list of objects that filter the property value history request.</p><br>
    ///   - [`start_date_time(DateTime)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::start_date_time) / [`set_start_date_time(Option<DateTime>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::set_start_date_time):<br>required: **false**<br><p>The date and time of the earliest property value to return.</p><br>
    ///   - [`end_date_time(DateTime)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::end_date_time) / [`set_end_date_time(Option<DateTime>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::set_end_date_time):<br>required: **false**<br><p>The date and time of the latest property value to return.</p><br>
    ///   - [`interpolation(InterpolationParameters)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::interpolation) / [`set_interpolation(Option<InterpolationParameters>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::set_interpolation):<br>required: **false**<br><p>An object that specifies the interpolation type and the interval over which to interpolate data.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::set_next_token):<br>required: **false**<br><p>The string that specifies the next page of results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p><br>
    ///   - [`order_by_time(OrderByTime)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::order_by_time) / [`set_order_by_time(Option<OrderByTime>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::set_order_by_time):<br>required: **false**<br><p>The time direction to use in the result order.</p><br>
    ///   - [`start_time(impl Into<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::start_time) / [`set_start_time(Option<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::set_start_time):<br>required: **false**<br><p>The ISO8601 DateTime of the earliest property value to return.</p> <p>For more information about the ISO8601 DateTime format, see the data type <a href="https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html">PropertyValue</a>.</p><br>
    ///   - [`end_time(impl Into<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::end_time) / [`set_end_time(Option<String>)`](crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::set_end_time):<br>required: **false**<br><p>The ISO8601 DateTime of the latest property value to return.</p> <p>For more information about the ISO8601 DateTime format, see the data type <a href="https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html">PropertyValue</a>.</p><br>
    /// - On success, responds with [`GetPropertyValueHistoryOutput`](crate::operation::get_property_value_history::GetPropertyValueHistoryOutput) with field(s):
    ///   - [`property_values(Vec::<PropertyValueHistory>)`](crate::operation::get_property_value_history::GetPropertyValueHistoryOutput::property_values): <p>An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_property_value_history::GetPropertyValueHistoryOutput::next_token): <p>The string that specifies the next page of results.</p>
    /// - On failure, responds with [`SdkError<GetPropertyValueHistoryError>`](crate::operation::get_property_value_history::GetPropertyValueHistoryError)
    pub fn get_property_value_history(&self) -> crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder {
        crate::operation::get_property_value_history::builders::GetPropertyValueHistoryFluentBuilder::new(self.handle.clone())
    }
}