aws_sdk_iotsitewise/client/
put_asset_model_interface_relationship.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 [`PutAssetModelInterfaceRelationship`](crate::operation::put_asset_model_interface_relationship::builders::PutAssetModelInterfaceRelationshipFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`asset_model_id(impl Into<String>)`](crate::operation::put_asset_model_interface_relationship::builders::PutAssetModelInterfaceRelationshipFluentBuilder::asset_model_id) / [`set_asset_model_id(Option<String>)`](crate::operation::put_asset_model_interface_relationship::builders::PutAssetModelInterfaceRelationshipFluentBuilder::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 externalId: followed by the external ID.</p><br>
7    ///   - [`interface_asset_model_id(impl Into<String>)`](crate::operation::put_asset_model_interface_relationship::builders::PutAssetModelInterfaceRelationshipFluentBuilder::interface_asset_model_id) / [`set_interface_asset_model_id(Option<String>)`](crate::operation::put_asset_model_interface_relationship::builders::PutAssetModelInterfaceRelationshipFluentBuilder::set_interface_asset_model_id):<br>required: **true**<br><p>The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.</p><br>
8    ///   - [`property_mapping_configuration(PropertyMappingConfiguration)`](crate::operation::put_asset_model_interface_relationship::builders::PutAssetModelInterfaceRelationshipFluentBuilder::property_mapping_configuration) / [`set_property_mapping_configuration(Option<PropertyMappingConfiguration>)`](crate::operation::put_asset_model_interface_relationship::builders::PutAssetModelInterfaceRelationshipFluentBuilder::set_property_mapping_configuration):<br>required: **true**<br><p>The configuration for mapping properties from the interface asset model to the asset model where the interface is applied. This configuration controls how properties are matched and created during the interface application process.</p><br>
9    ///   - [`client_token(impl Into<String>)`](crate::operation::put_asset_model_interface_relationship::builders::PutAssetModelInterfaceRelationshipFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::put_asset_model_interface_relationship::builders::PutAssetModelInterfaceRelationshipFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p><br>
10    /// - On success, responds with [`PutAssetModelInterfaceRelationshipOutput`](crate::operation::put_asset_model_interface_relationship::PutAssetModelInterfaceRelationshipOutput) with field(s):
11    ///   - [`asset_model_id(String)`](crate::operation::put_asset_model_interface_relationship::PutAssetModelInterfaceRelationshipOutput::asset_model_id): <p>The ID of the asset model.</p>
12    ///   - [`interface_asset_model_id(String)`](crate::operation::put_asset_model_interface_relationship::PutAssetModelInterfaceRelationshipOutput::interface_asset_model_id): <p>The ID of the interface asset model.</p>
13    ///   - [`asset_model_arn(String)`](crate::operation::put_asset_model_interface_relationship::PutAssetModelInterfaceRelationshipOutput::asset_model_arn): <p>The ARN of the asset model, which has the following format. <code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}</code></p>
14    ///   - [`asset_model_status(Option<AssetModelStatus>)`](crate::operation::put_asset_model_interface_relationship::PutAssetModelInterfaceRelationshipOutput::asset_model_status): <p>Contains current status information for an asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html">Asset and model states</a> in the <i>IoT SiteWise User Guide</i>.</p>
15    /// - On failure, responds with [`SdkError<PutAssetModelInterfaceRelationshipError>`](crate::operation::put_asset_model_interface_relationship::PutAssetModelInterfaceRelationshipError)
16    pub fn put_asset_model_interface_relationship(
17        &self,
18    ) -> crate::operation::put_asset_model_interface_relationship::builders::PutAssetModelInterfaceRelationshipFluentBuilder {
19        crate::operation::put_asset_model_interface_relationship::builders::PutAssetModelInterfaceRelationshipFluentBuilder::new(self.handle.clone())
20    }
21}