aws_sdk_iottwinmaker/client/
list_properties.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 [`ListProperties`](crate::operation::list_properties::builders::ListPropertiesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_properties::builders::ListPropertiesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`workspace_id(impl Into<String>)`](crate::operation::list_properties::builders::ListPropertiesFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::list_properties::builders::ListPropertiesFluentBuilder::set_workspace_id):<br>required: **true**<br><p>The workspace ID.</p><br>
8    ///   - [`component_name(impl Into<String>)`](crate::operation::list_properties::builders::ListPropertiesFluentBuilder::component_name) / [`set_component_name(Option<String>)`](crate::operation::list_properties::builders::ListPropertiesFluentBuilder::set_component_name):<br>required: **false**<br><p>The name of the component whose properties are returned by the operation.</p><br>
9    ///   - [`component_path(impl Into<String>)`](crate::operation::list_properties::builders::ListPropertiesFluentBuilder::component_path) / [`set_component_path(Option<String>)`](crate::operation::list_properties::builders::ListPropertiesFluentBuilder::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>
10    ///   - [`entity_id(impl Into<String>)`](crate::operation::list_properties::builders::ListPropertiesFluentBuilder::entity_id) / [`set_entity_id(Option<String>)`](crate::operation::list_properties::builders::ListPropertiesFluentBuilder::set_entity_id):<br>required: **true**<br><p>The ID for the entity whose metadata (component/properties) is returned by the operation.</p><br>
11    ///   - [`max_results(i32)`](crate::operation::list_properties::builders::ListPropertiesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_properties::builders::ListPropertiesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results returned at one time. The default is 25.</p><br>
12    ///   - [`next_token(impl Into<String>)`](crate::operation::list_properties::builders::ListPropertiesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_properties::builders::ListPropertiesFluentBuilder::set_next_token):<br>required: **false**<br><p>The string that specifies the next page of results.</p><br>
13    /// - On success, responds with [`ListPropertiesOutput`](crate::operation::list_properties::ListPropertiesOutput) with field(s):
14    ///   - [`property_summaries(Vec::<PropertySummary>)`](crate::operation::list_properties::ListPropertiesOutput::property_summaries): <p>A list of objects that contain information about the properties.</p>
15    ///   - [`next_token(Option<String>)`](crate::operation::list_properties::ListPropertiesOutput::next_token): <p>The string that specifies the next page of property results.</p>
16    /// - On failure, responds with [`SdkError<ListPropertiesError>`](crate::operation::list_properties::ListPropertiesError)
17    pub fn list_properties(&self) -> crate::operation::list_properties::builders::ListPropertiesFluentBuilder {
18        crate::operation::list_properties::builders::ListPropertiesFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_iottwinmaker/client/list_properties.rs

aws_sdk_iottwinmaker/client/
list_properties.rs
