1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeAssetModel`](crate::operation::describe_asset_model::builders::DescribeAssetModelFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`asset_model_id(impl Into<String>)`](crate::operation::describe_asset_model::builders::DescribeAssetModelFluentBuilder::asset_model_id) / [`set_asset_model_id(Option<String>)`](crate::operation::describe_asset_model::builders::DescribeAssetModelFluentBuilder::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>
    ///   - [`exclude_properties(bool)`](crate::operation::describe_asset_model::builders::DescribeAssetModelFluentBuilder::exclude_properties) / [`set_exclude_properties(Option<bool>)`](crate::operation::describe_asset_model::builders::DescribeAssetModelFluentBuilder::set_exclude_properties):<br>required: **false**<br><p>Whether or not to exclude asset model properties from the response.</p><br>
    /// - On success, responds with [`DescribeAssetModelOutput`](crate::operation::describe_asset_model::DescribeAssetModelOutput) with field(s):
    ///   - [`asset_model_id(String)`](crate::operation::describe_asset_model::DescribeAssetModelOutput::asset_model_id): <p>The ID of the asset model, in UUID format.</p>
    ///   - [`asset_model_arn(String)`](crate::operation::describe_asset_model::DescribeAssetModelOutput::asset_model_arn): <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset model, which has the following format.</p> <p><code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}</code></p>
    ///   - [`asset_model_name(String)`](crate::operation::describe_asset_model::DescribeAssetModelOutput::asset_model_name): <p>The name of the asset model.</p>
    ///   - [`asset_model_description(String)`](crate::operation::describe_asset_model::DescribeAssetModelOutput::asset_model_description): <p>The asset model's description.</p>
    ///   - [`asset_model_properties(Vec::<AssetModelProperty>)`](crate::operation::describe_asset_model::DescribeAssetModelOutput::asset_model_properties): <p>The list of asset properties for the asset model.</p> <p>This object doesn't include properties that you define in composite models. You can find composite model properties in the <code>assetModelCompositeModels</code> object.</p>
    ///   - [`asset_model_hierarchies(Vec::<AssetModelHierarchy>)`](crate::operation::describe_asset_model::DescribeAssetModelOutput::asset_model_hierarchies): <p>A list of asset model hierarchies that each contain a <code>childAssetModelId</code> and a <code>hierarchyId</code> (named <code>id</code>). A hierarchy specifies allowed parent/child asset relationships for an asset model.</p>
    ///   - [`asset_model_composite_models(Option<Vec::<AssetModelCompositeModel>>)`](crate::operation::describe_asset_model::DescribeAssetModelOutput::asset_model_composite_models): <p>The list of built-in composite models for the asset model, such as those with those of type <code>AWS/ALARMS</code>.</p>
    ///   - [`asset_model_creation_date(DateTime)`](crate::operation::describe_asset_model::DescribeAssetModelOutput::asset_model_creation_date): <p>The date the asset model was created, in Unix epoch time.</p>
    ///   - [`asset_model_last_update_date(DateTime)`](crate::operation::describe_asset_model::DescribeAssetModelOutput::asset_model_last_update_date): <p>The date the asset model was last updated, in Unix epoch time.</p>
    ///   - [`asset_model_status(Option<AssetModelStatus>)`](crate::operation::describe_asset_model::DescribeAssetModelOutput::asset_model_status): <p>The current status of the asset model, which contains a state and any error message.</p>
    ///   - [`asset_model_type(Option<AssetModelType>)`](crate::operation::describe_asset_model::DescribeAssetModelOutput::asset_model_type): <p>The type of asset model.</p> <ul>  <li>   <p><b>ASSET_MODEL</b> – (default) 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> </ul>
    ///   - [`asset_model_composite_model_summaries(Option<Vec::<AssetModelCompositeModelSummary>>)`](crate::operation::describe_asset_model::DescribeAssetModelOutput::asset_model_composite_model_summaries): <p>The list of the immediate child custom composite model summaries for the asset model.</p>
    ///   - [`asset_model_external_id(Option<String>)`](crate::operation::describe_asset_model::DescribeAssetModelOutput::asset_model_external_id): <p>The external ID of the asset model, if any.</p>
    /// - On failure, responds with [`SdkError<DescribeAssetModelError>`](crate::operation::describe_asset_model::DescribeAssetModelError)
    pub fn describe_asset_model(&self) -> crate::operation::describe_asset_model::builders::DescribeAssetModelFluentBuilder {
        crate::operation::describe_asset_model::builders::DescribeAssetModelFluentBuilder::new(self.handle.clone())
    }
}