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 [`DescribeAsset`](crate::operation::describe_asset::builders::DescribeAssetFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`asset_id(impl Into<String>)`](crate::operation::describe_asset::builders::DescribeAssetFluentBuilder::asset_id) / [`set_asset_id(Option<String>)`](crate::operation::describe_asset::builders::DescribeAssetFluentBuilder::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>
    ///   - [`exclude_properties(bool)`](crate::operation::describe_asset::builders::DescribeAssetFluentBuilder::exclude_properties) / [`set_exclude_properties(Option<bool>)`](crate::operation::describe_asset::builders::DescribeAssetFluentBuilder::set_exclude_properties):<br>required: **false**<br><p>Whether or not to exclude asset properties from the response.</p><br>
    /// - On success, responds with [`DescribeAssetOutput`](crate::operation::describe_asset::DescribeAssetOutput) with field(s):
    ///   - [`asset_id(String)`](crate::operation::describe_asset::DescribeAssetOutput::asset_id): <p>The ID of the asset, in UUID format.</p>
    ///   - [`asset_arn(String)`](crate::operation::describe_asset::DescribeAssetOutput::asset_arn): <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset, which has the following format.</p> <p><code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}</code></p>
    ///   - [`asset_name(String)`](crate::operation::describe_asset::DescribeAssetOutput::asset_name): <p>The name of the asset.</p>
    ///   - [`asset_model_id(String)`](crate::operation::describe_asset::DescribeAssetOutput::asset_model_id): <p>The ID of the asset model that was used to create the asset.</p>
    ///   - [`asset_properties(Vec::<AssetProperty>)`](crate::operation::describe_asset::DescribeAssetOutput::asset_properties): <p>The list of asset properties for the asset.</p> <p>This object doesn't include properties that you define in composite models. You can find composite model properties in the <code>assetCompositeModels</code> object.</p>
    ///   - [`asset_hierarchies(Vec::<AssetHierarchy>)`](crate::operation::describe_asset::DescribeAssetOutput::asset_hierarchies): <p>A list of asset hierarchies that each contain a <code>hierarchyId</code>. A hierarchy specifies allowed parent/child asset relationships.</p>
    ///   - [`asset_composite_models(Option<Vec::<AssetCompositeModel>>)`](crate::operation::describe_asset::DescribeAssetOutput::asset_composite_models): <p>The composite models for the asset.</p>
    ///   - [`asset_creation_date(DateTime)`](crate::operation::describe_asset::DescribeAssetOutput::asset_creation_date): <p>The date the asset was created, in Unix epoch time.</p>
    ///   - [`asset_last_update_date(DateTime)`](crate::operation::describe_asset::DescribeAssetOutput::asset_last_update_date): <p>The date the asset was last updated, in Unix epoch time.</p>
    ///   - [`asset_status(Option<AssetStatus>)`](crate::operation::describe_asset::DescribeAssetOutput::asset_status): <p>The current status of the asset, which contains a state and any error message.</p>
    ///   - [`asset_description(Option<String>)`](crate::operation::describe_asset::DescribeAssetOutput::asset_description): <p>A description for the asset.</p>
    ///   - [`asset_composite_model_summaries(Option<Vec::<AssetCompositeModelSummary>>)`](crate::operation::describe_asset::DescribeAssetOutput::asset_composite_model_summaries): <p>The list of the immediate child custom composite model summaries for the asset.</p>
    ///   - [`asset_external_id(Option<String>)`](crate::operation::describe_asset::DescribeAssetOutput::asset_external_id): <p>The external ID of the asset, if any.</p>
    /// - On failure, responds with [`SdkError<DescribeAssetError>`](crate::operation::describe_asset::DescribeAssetError)
    pub fn describe_asset(&self) -> crate::operation::describe_asset::builders::DescribeAssetFluentBuilder {
        crate::operation::describe_asset::builders::DescribeAssetFluentBuilder::new(self.handle.clone())
    }
}