aws_sdk_iotsitewise/client/list_interface_relationships.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 [`ListInterfaceRelationships`](crate::operation::list_interface_relationships::builders::ListInterfaceRelationshipsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_interface_relationships::builders::ListInterfaceRelationshipsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`interface_asset_model_id(impl Into<String>)`](crate::operation::list_interface_relationships::builders::ListInterfaceRelationshipsFluentBuilder::interface_asset_model_id) / [`set_interface_asset_model_id(Option<String>)`](crate::operation::list_interface_relationships::builders::ListInterfaceRelationshipsFluentBuilder::set_interface_asset_model_id):<br>required: **true**<br><p>The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::list_interface_relationships::builders::ListInterfaceRelationshipsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_interface_relationships::builders::ListInterfaceRelationshipsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to be used for the next set of paginated results.</p><br>
9 /// - [`max_results(i32)`](crate::operation::list_interface_relationships::builders::ListInterfaceRelationshipsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_interface_relationships::builders::ListInterfaceRelationshipsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return for each paginated request. Default: 50</p><br>
10 /// - On success, responds with [`ListInterfaceRelationshipsOutput`](crate::operation::list_interface_relationships::ListInterfaceRelationshipsOutput) with field(s):
11 /// - [`interface_relationship_summaries(Vec::<InterfaceRelationshipSummary>)`](crate::operation::list_interface_relationships::ListInterfaceRelationshipsOutput::interface_relationship_summaries): <p>A list that summarizes each interface relationship.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_interface_relationships::ListInterfaceRelationshipsOutput::next_token): <p>The token for the next set of results, or null if there are no additional results.</p>
13 /// - On failure, responds with [`SdkError<ListInterfaceRelationshipsError>`](crate::operation::list_interface_relationships::ListInterfaceRelationshipsError)
14 pub fn list_interface_relationships(&self) -> crate::operation::list_interface_relationships::builders::ListInterfaceRelationshipsFluentBuilder {
15 crate::operation::list_interface_relationships::builders::ListInterfaceRelationshipsFluentBuilder::new(self.handle.clone())
16 }
17}