1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListAssociatedAssets`](crate::operation::list_associated_assets::builders::ListAssociatedAssetsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_associated_assets::builders::ListAssociatedAssetsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`asset_id(impl Into<String>)`](crate::operation::list_associated_assets::builders::ListAssociatedAssetsFluentBuilder::asset_id) / [`set_asset_id(Option<String>)`](crate::operation::list_associated_assets::builders::ListAssociatedAssetsFluentBuilder::set_asset_id):<br>required: **true**<br><p>The ID of the asset to query. 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>
    ///   - [`hierarchy_id(impl Into<String>)`](crate::operation::list_associated_assets::builders::ListAssociatedAssetsFluentBuilder::hierarchy_id) / [`set_hierarchy_id(Option<String>)`](crate::operation::list_associated_assets::builders::ListAssociatedAssetsFluentBuilder::set_hierarchy_id):<br>required: **false**<br><p>The ID of the hierarchy by which child assets are associated to 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>.) To find a hierarchy ID, use the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html">DescribeAsset</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html">DescribeAssetModel</a> operations. This parameter is required if you choose <code>CHILD</code> for <code>traversalDirection</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p><br>
    ///   - [`traversal_direction(TraversalDirection)`](crate::operation::list_associated_assets::builders::ListAssociatedAssetsFluentBuilder::traversal_direction) / [`set_traversal_direction(Option<TraversalDirection>)`](crate::operation::list_associated_assets::builders::ListAssociatedAssetsFluentBuilder::set_traversal_direction):<br>required: **false**<br><p>The direction to list associated assets. Choose one of the following options:</p> <ul>  <li>   <p><code>CHILD</code> – The list includes all child assets associated to the asset. The <code>hierarchyId</code> parameter is required if you choose <code>CHILD</code>.</p></li>  <li>   <p><code>PARENT</code> – The list includes the asset's parent asset.</p></li> </ul> <p>Default: <code>CHILD</code></p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_associated_assets::builders::ListAssociatedAssetsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_associated_assets::builders::ListAssociatedAssetsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to be used for the next set of paginated results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_associated_assets::builders::ListAssociatedAssetsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_associated_assets::builders::ListAssociatedAssetsFluentBuilder::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>
    /// - On success, responds with [`ListAssociatedAssetsOutput`](crate::operation::list_associated_assets::ListAssociatedAssetsOutput) with field(s):
    ///   - [`asset_summaries(Vec::<AssociatedAssetsSummary>)`](crate::operation::list_associated_assets::ListAssociatedAssetsOutput::asset_summaries): <p>A list that summarizes the associated assets.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_associated_assets::ListAssociatedAssetsOutput::next_token): <p>The token for the next set of results, or null if there are no additional results.</p>
    /// - On failure, responds with [`SdkError<ListAssociatedAssetsError>`](crate::operation::list_associated_assets::ListAssociatedAssetsError)
    pub fn list_associated_assets(&self) -> crate::operation::list_associated_assets::builders::ListAssociatedAssetsFluentBuilder {
        crate::operation::list_associated_assets::builders::ListAssociatedAssetsFluentBuilder::new(self.handle.clone())
    }
}