aws_sdk_iotsitewise/client/list_asset_models.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 [`ListAssetModels`](crate::operation::list_asset_models::builders::ListAssetModelsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_asset_models::builders::ListAssetModelsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`asset_model_types(AssetModelType)`](crate::operation::list_asset_models::builders::ListAssetModelsFluentBuilder::asset_model_types) / [`set_asset_model_types(Option<Vec::<AssetModelType>>)`](crate::operation::list_asset_models::builders::ListAssetModelsFluentBuilder::set_asset_model_types):<br>required: **false**<br><p>The type of asset model. If you don't provide an <code>assetModelTypes</code>, all types of asset models are returned.</p> <ul> <li> <p><b>ASSET_MODEL</b> – An asset model that you can use to create assets. Can't be included as a component in another asset model.</p></li> <li> <p><b>COMPONENT_MODEL</b> – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.</p></li> <li> <p><b>INTERFACE</b> – An interface is a type of model that defines a standard structure that can be applied to different asset models.</p></li> </ul><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::list_asset_models::builders::ListAssetModelsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_asset_models::builders::ListAssetModelsFluentBuilder::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_asset_models::builders::ListAssetModelsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_asset_models::builders::ListAssetModelsFluentBuilder::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 /// - [`asset_model_version(impl Into<String>)`](crate::operation::list_asset_models::builders::ListAssetModelsFluentBuilder::asset_model_version) / [`set_asset_model_version(Option<String>)`](crate::operation::list_asset_models::builders::ListAssetModelsFluentBuilder::set_asset_model_version):<br>required: **false**<br><p>The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html"> Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p><br>
11 /// - On success, responds with [`ListAssetModelsOutput`](crate::operation::list_asset_models::ListAssetModelsOutput) with field(s):
12 /// - [`asset_model_summaries(Vec::<AssetModelSummary>)`](crate::operation::list_asset_models::ListAssetModelsOutput::asset_model_summaries): <p>A list that summarizes each asset model.</p>
13 /// - [`next_token(Option<String>)`](crate::operation::list_asset_models::ListAssetModelsOutput::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<ListAssetModelsError>`](crate::operation::list_asset_models::ListAssetModelsError)
15 pub fn list_asset_models(&self) -> crate::operation::list_asset_models::builders::ListAssetModelsFluentBuilder {
16 crate::operation::list_asset_models::builders::ListAssetModelsFluentBuilder::new(self.handle.clone())
17 }
18}