aws_sdk_iotsitewise/client/
create_asset_model_composite_model.rs

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
27
28
29
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateAssetModelCompositeModel`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`asset_model_id(impl Into<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::asset_model_id) / [`set_asset_model_id(Option<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::set_asset_model_id):<br>required: **true**<br><p>The ID of the asset model this composite model is a part of.</p><br>
    ///   - [`asset_model_composite_model_external_id(impl Into<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::asset_model_composite_model_external_id) / [`set_asset_model_composite_model_external_id(Option<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::set_asset_model_composite_model_external_id):<br>required: **false**<br><p>An external ID to assign to the composite model.</p> <p>If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using <code>UpdateAssetModelCompositeModel</code> and specifying the derived ID of the model or property from the created model it's a part of.</p><br>
    ///   - [`parent_asset_model_composite_model_id(impl Into<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::parent_asset_model_composite_model_id) / [`set_parent_asset_model_composite_model_id(Option<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::set_parent_asset_model_composite_model_id):<br>required: **false**<br><p>The ID of the parent composite model in this asset model relationship.</p><br>
    ///   - [`asset_model_composite_model_id(impl Into<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::asset_model_composite_model_id) / [`set_asset_model_composite_model_id(Option<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::set_asset_model_composite_model_id):<br>required: **false**<br><p>The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.</p><br>
    ///   - [`asset_model_composite_model_description(impl Into<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::asset_model_composite_model_description) / [`set_asset_model_composite_model_description(Option<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::set_asset_model_composite_model_description):<br>required: **false**<br><p>A description for the composite model.</p><br>
    ///   - [`asset_model_composite_model_name(impl Into<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::asset_model_composite_model_name) / [`set_asset_model_composite_model_name(Option<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::set_asset_model_composite_model_name):<br>required: **true**<br><p>A unique name for the composite model.</p><br>
    ///   - [`asset_model_composite_model_type(impl Into<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::asset_model_composite_model_type) / [`set_asset_model_composite_model_type(Option<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::set_asset_model_composite_model_type):<br>required: **true**<br><p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or <code> AWS/L4E_ANOMALY</code>.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::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>
    ///   - [`composed_asset_model_id(impl Into<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::composed_asset_model_id) / [`set_composed_asset_model_id(Option<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::set_composed_asset_model_id):<br>required: **false**<br><p>The ID of a component model which is reused to create this composite model.</p><br>
    ///   - [`asset_model_composite_model_properties(AssetModelPropertyDefinition)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::asset_model_composite_model_properties) / [`set_asset_model_composite_model_properties(Option<Vec::<AssetModelPropertyDefinition>>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::set_asset_model_composite_model_properties):<br>required: **false**<br><p>The property definitions of the composite model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models"> Inline custom composite models</a> in the <i>IoT SiteWise User Guide</i>.</p> <p>You can specify up to 200 properties per composite model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p><br>
    ///   - [`if_match(impl Into<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::if_match) / [`set_if_match(Option<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::set_if_match):<br>required: **false**<br><p>The expected current entity tag (ETag) for the asset model’s latest or active version (specified using <code>matchForVersionType</code>). The create request is rejected if the tag does not match the latest or active version's current entity tag. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html">Optimistic locking for asset model writes</a> in the <i>IoT SiteWise User Guide</i>.</p><br>
    ///   - [`if_none_match(impl Into<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::if_none_match) / [`set_if_none_match(Option<String>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::set_if_none_match):<br>required: **false**<br><p>Accepts <b>*</b> to reject the create request if an active version (specified using <code>matchForVersionType</code> as <code>ACTIVE</code>) already exists for the asset model.</p><br>
    ///   - [`match_for_version_type(AssetModelVersionType)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::match_for_version_type) / [`set_match_for_version_type(Option<AssetModelVersionType>)`](crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::set_match_for_version_type):<br>required: **false**<br><p>Specifies the asset model version type (<code>LATEST</code> or <code>ACTIVE</code>) used in conjunction with <code>If-Match</code> or <code>If-None-Match</code> headers to determine the target ETag for the create operation.</p><br>
    /// - On success, responds with [`CreateAssetModelCompositeModelOutput`](crate::operation::create_asset_model_composite_model::CreateAssetModelCompositeModelOutput) with field(s):
    ///   - [`asset_model_composite_model_id(String)`](crate::operation::create_asset_model_composite_model::CreateAssetModelCompositeModelOutput::asset_model_composite_model_id): <p>The ID of the composed asset model. You can use this ID when you call other IoT SiteWise APIs.</p>
    ///   - [`asset_model_composite_model_path(Vec::<AssetModelCompositeModelPathSegment>)`](crate::operation::create_asset_model_composite_model::CreateAssetModelCompositeModelOutput::asset_model_composite_model_path): <p>The path to the composite model listing the parent composite models.</p>
    ///   - [`asset_model_status(Option<AssetModelStatus>)`](crate::operation::create_asset_model_composite_model::CreateAssetModelCompositeModelOutput::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>
    /// - On failure, responds with [`SdkError<CreateAssetModelCompositeModelError>`](crate::operation::create_asset_model_composite_model::CreateAssetModelCompositeModelError)
    pub fn create_asset_model_composite_model(
        &self,
    ) -> crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder {
        crate::operation::create_asset_model_composite_model::builders::CreateAssetModelCompositeModelFluentBuilder::new(self.handle.clone())
    }
}