aws_sdk_iottwinmaker/client/
get_property_value.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetPropertyValue`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`component_name(impl Into<String>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::component_name) / [`set_component_name(Option<String>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::set_component_name):<br>required: **false**<br><p>The name of the component whose property values the operation returns.</p><br>
8    ///   - [`component_path(impl Into<String>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::component_path) / [`set_component_path(Option<String>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::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>
9    ///   - [`component_type_id(impl Into<String>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::component_type_id) / [`set_component_type_id(Option<String>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::set_component_type_id):<br>required: **false**<br><p>The ID of the component type whose property values the operation returns.</p><br>
10    ///   - [`entity_id(impl Into<String>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::entity_id) / [`set_entity_id(Option<String>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::set_entity_id):<br>required: **false**<br><p>The ID of the entity whose property values the operation returns.</p><br>
11    ///   - [`selected_properties(impl Into<String>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::selected_properties) / [`set_selected_properties(Option<Vec::<String>>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::set_selected_properties):<br>required: **true**<br><p>The properties whose values the operation returns.</p><br>
12    ///   - [`workspace_id(impl Into<String>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::set_workspace_id):<br>required: **true**<br><p>The ID of the workspace whose values the operation returns.</p><br>
13    ///   - [`max_results(i32)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::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>
14    ///   - [`next_token(impl Into<String>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::set_next_token):<br>required: **false**<br><p>The string that specifies the next page of results.</p><br>
15    ///   - [`property_group_name(impl Into<String>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::property_group_name) / [`set_property_group_name(Option<String>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::set_property_group_name):<br>required: **false**<br><p>The property group name.</p><br>
16    ///   - [`tabular_conditions(TabularConditions)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::tabular_conditions) / [`set_tabular_conditions(Option<TabularConditions>)`](crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::set_tabular_conditions):<br>required: **false**<br><p>The tabular conditions.</p><br>
17    /// - On success, responds with [`GetPropertyValueOutput`](crate::operation::get_property_value::GetPropertyValueOutput) with field(s):
18    ///   - [`property_values(Option<HashMap::<String, PropertyLatestValue>>)`](crate::operation::get_property_value::GetPropertyValueOutput::property_values): <p>An object that maps strings to the properties and latest property values in the response. Each string in the mapping must be unique to this object.</p>
19    ///   - [`next_token(Option<String>)`](crate::operation::get_property_value::GetPropertyValueOutput::next_token): <p>The string that specifies the next page of results.</p>
20    ///   - [`tabular_property_values(Option<Vec::<Vec::<HashMap::<String, DataValue>>>>)`](crate::operation::get_property_value::GetPropertyValueOutput::tabular_property_values): <p>A table of property values.</p>
21    /// - On failure, responds with [`SdkError<GetPropertyValueError>`](crate::operation::get_property_value::GetPropertyValueError)
22    pub fn get_property_value(&self) -> crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder {
23        crate::operation::get_property_value::builders::GetPropertyValueFluentBuilder::new(self.handle.clone())
24    }
25}
aws_sdk_iottwinmaker/client/get_property_value.rs

aws_sdk_iottwinmaker/client/
get_property_value.rs
