aws_sdk_iottwinmaker/client/
list_entities.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 [`ListEntities`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`workspace_id(impl Into<String>)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::set_workspace_id):<br>required: **true**<br><p>The ID of the workspace.</p><br>
8    ///   - [`filters(ListEntitiesFilter)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::filters) / [`set_filters(Option<Vec::<ListEntitiesFilter>>)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::set_filters):<br>required: **false**<br><p>A list of objects that filter the request.</p><note>  <p>Only one object is accepted as a valid input.</p> </note><br>
9    ///   - [`max_results(i32)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::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>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::set_next_token):<br>required: **false**<br><p>The string that specifies the next page of results.</p><br>
11    /// - On success, responds with [`ListEntitiesOutput`](crate::operation::list_entities::ListEntitiesOutput) with field(s):
12    ///   - [`entity_summaries(Option<Vec::<EntitySummary>>)`](crate::operation::list_entities::ListEntitiesOutput::entity_summaries): <p>A list of objects that contain information about the entities.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_entities::ListEntitiesOutput::next_token): <p>The string that specifies the next page of results.</p>
14    /// - On failure, responds with [`SdkError<ListEntitiesError>`](crate::operation::list_entities::ListEntitiesError)
15    pub fn list_entities(&self) -> crate::operation::list_entities::builders::ListEntitiesFluentBuilder {
16        crate::operation::list_entities::builders::ListEntitiesFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_iottwinmaker/client/list_entities.rs

aws_sdk_iottwinmaker/client/
list_entities.rs
