aws_sdk_iotsitewise/client/
list_asset_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 [`ListAssetRelationships`](crate::operation::list_asset_relationships::builders::ListAssetRelationshipsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_asset_relationships::builders::ListAssetRelationshipsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`asset_id(impl Into<String>)`](crate::operation::list_asset_relationships::builders::ListAssetRelationshipsFluentBuilder::asset_id) / [`set_asset_id(Option<String>)`](crate::operation::list_asset_relationships::builders::ListAssetRelationshipsFluentBuilder::set_asset_id):<br>required: **true**<br><p>The ID of the asset. 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    ///   - [`traversal_type(TraversalType)`](crate::operation::list_asset_relationships::builders::ListAssetRelationshipsFluentBuilder::traversal_type) / [`set_traversal_type(Option<TraversalType>)`](crate::operation::list_asset_relationships::builders::ListAssetRelationshipsFluentBuilder::set_traversal_type):<br>required: **true**<br><p>The type of traversal to use to identify asset relationships. Choose the following option:</p> <ul>  <li>   <p><code>PATH_TO_ROOT</code> – Identify the asset's parent assets up to the root asset. The asset that you specify in <code>assetId</code> is the first result in the list of <code>assetRelationshipSummaries</code>, and the root asset is the last result.</p></li> </ul><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_asset_relationships::builders::ListAssetRelationshipsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_asset_relationships::builders::ListAssetRelationshipsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to be used for the next set of paginated results.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_asset_relationships::builders::ListAssetRelationshipsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_asset_relationships::builders::ListAssetRelationshipsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return for each paginated request.</p><br>
11    /// - On success, responds with [`ListAssetRelationshipsOutput`](crate::operation::list_asset_relationships::ListAssetRelationshipsOutput) with field(s):
12    ///   - [`asset_relationship_summaries(Vec::<AssetRelationshipSummary>)`](crate::operation::list_asset_relationships::ListAssetRelationshipsOutput::asset_relationship_summaries): <p>A list that summarizes each asset relationship.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_asset_relationships::ListAssetRelationshipsOutput::next_token): <p>The token for the next set of results, or null if there are no additional results.</p>
14    /// - On failure, responds with [`SdkError<ListAssetRelationshipsError>`](crate::operation::list_asset_relationships::ListAssetRelationshipsError)
15    pub fn list_asset_relationships(&self) -> crate::operation::list_asset_relationships::builders::ListAssetRelationshipsFluentBuilder {
16        crate::operation::list_asset_relationships::builders::ListAssetRelationshipsFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_iotsitewise/client/list_asset_relationships.rs

aws_sdk_iotsitewise/client/
list_asset_relationships.rs
