aws_sdk_iotsitewise/client/
list_composition_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 [`ListCompositionRelationships`](crate::operation::list_composition_relationships::builders::ListCompositionRelationshipsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_composition_relationships::builders::ListCompositionRelationshipsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`asset_model_id(impl Into<String>)`](crate::operation::list_composition_relationships::builders::ListCompositionRelationshipsFluentBuilder::asset_model_id) / [`set_asset_model_id(Option<String>)`](crate::operation::list_composition_relationships::builders::ListCompositionRelationshipsFluentBuilder::set_asset_model_id):<br>required: **true**<br><p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_composition_relationships::builders::ListCompositionRelationshipsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_composition_relationships::builders::ListCompositionRelationshipsFluentBuilder::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_composition_relationships::builders::ListCompositionRelationshipsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_composition_relationships::builders::ListCompositionRelationshipsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return for each paginated request.</p> <p>Default: 50</p><br>
10    /// - On success, responds with [`ListCompositionRelationshipsOutput`](crate::operation::list_composition_relationships::ListCompositionRelationshipsOutput) with field(s):
11    ///   - [`composition_relationship_summaries(Vec::<CompositionRelationshipSummary>)`](crate::operation::list_composition_relationships::ListCompositionRelationshipsOutput::composition_relationship_summaries): <p>A list that summarizes each composition relationship.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_composition_relationships::ListCompositionRelationshipsOutput::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<ListCompositionRelationshipsError>`](crate::operation::list_composition_relationships::ListCompositionRelationshipsError)
14    pub fn list_composition_relationships(
15        &self,
16    ) -> crate::operation::list_composition_relationships::builders::ListCompositionRelationshipsFluentBuilder {
17        crate::operation::list_composition_relationships::builders::ListCompositionRelationshipsFluentBuilder::new(self.handle.clone())
18    }
19}