update_asset_model ¶

def update_asset_model(
    self,
    asset_model_id: "capo_iotsitewise.types.custom_id.CustomID",
    asset_model_name: "capo_iotsitewise.types.name.Name",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    asset_model_external_id: Optional[
        "capo_iotsitewise.types.external_id.ExternalId"
    ] = None,
    asset_model_description: Optional[
        "capo_iotsitewise.types.description.Description"
    ] = None,
    asset_model_properties: Optional[
        "capo_iotsitewise.types.asset_model_properties.AssetModelProperties"
    ] = None,
    asset_model_hierarchies: Optional[
        "capo_iotsitewise.types.asset_model_hierarchies.AssetModelHierarchies"
    ] = None,
    asset_model_composite_models: Optional[
        "capo_iotsitewise.types.asset_model_composite_models.AssetModelCompositeModels"
    ] = None,
    client_token: Optional[
        "capo_iotsitewise.types.client_token.ClientToken"
    ] = None,
    if_match: Optional["capo_iotsitewise.types.e_tag.ETag"] = None,
    if_none_match: Optional["capo_iotsitewise.types.select_all.SelectAll"] = None,
    match_for_version_type: Optional[
        "capo_iotsitewise.types.asset_model_version_type.AssetModelVersionType"
    ] = None,
) -> "capo_iotsitewise.types.update_asset_model_response.UpdateAssetModelResponse":
    """<p>Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html">Updating assets and models</a> in the <i>IoT SiteWise User Guide</i>.</p> <important> <p>If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.</p> <p>To replace an existing asset model property with a new one with the same <code>name</code>, do the following:</p> <ol> <li> <p>Submit an <code>UpdateAssetModel</code> request with the entire existing property removed.</p> </li> <li> <p>Submit a second <code>UpdateAssetModel</code> request that includes the new property. The new asset property will have the same <code>name</code> as the previous one and IoT SiteWise will generate a new unique <code>id</code>.</p> </li> </ol> </important>

    Args:
        asset_model_id: <p>The ID of the asset model to update. 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>
        asset_model_external_id: <p>An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
        asset_model_name: <p>A unique name for the asset model.</p>
        asset_model_description: <p>A description for the asset model.</p>
        asset_model_properties: <p>The updated property definitions of the asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html">Asset properties</a> in the <i>IoT SiteWise User Guide</i>.</p> <p>You can specify up to 200 properties per asset 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>
        asset_model_hierarchies: <p>The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p> <p>You can specify up to 10 hierarchies per asset 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>
        asset_model_composite_models: <p>The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.</p> <note> <p>When creating custom composite models, you need to use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html">CreateAssetModelCompositeModel</a>. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html">Creating custom composite models (Components)</a> in the <i>IoT SiteWise User Guide</i>.</p> </note>
        client_token: <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>
        if_match: <p>The expected current entity tag (ETag) for the asset model’s latest or active version (specified using <code>matchForVersionType</code>). The update 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>
        if_none_match: <p>Accepts <b>*</b> to reject the update request if an active version (specified using <code>matchForVersionType</code> as <code>ACTIVE</code>) already exists for the asset model.</p>
        match_for_version_type: <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 update operation.</p>

    Raises:
        capo_iotsitewise.errors.conflicting_operation_exception.ConflictingOperationException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.limit_exceeded_exception.LimitExceededException: <p>You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.</p> <p>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>
        capo_iotsitewise.errors.precondition_failed_exception.PreconditionFailedException: <p>The precondition in one or more of the request-header fields evaluated to <code>FALSE</code>.</p>
        capo_iotsitewise.errors.resource_already_exists_exception.ResourceAlreadyExistsException: <p>The resource already exists.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>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>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.update_asset_model_request.UpdateAssetModelRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.update_asset_model_response.UpdateAssetModelResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.update_asset_model

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.update_asset_model.update_asset_model(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateAssetModel")
    )
    input_: capo_iotsitewise.types.update_asset_model_request.UpdateAssetModelRequest = {
        "asset_model_id": asset_model_id,
        "asset_model_name": asset_model_name,
    }
    if asset_model_external_id is not None:
        input_["asset_model_external_id"] = asset_model_external_id
    if asset_model_description is not None:
        input_["asset_model_description"] = asset_model_description
    if asset_model_properties is not None:
        input_["asset_model_properties"] = asset_model_properties
    if asset_model_hierarchies is not None:
        input_["asset_model_hierarchies"] = asset_model_hierarchies
    if asset_model_composite_models is not None:
        input_["asset_model_composite_models"] = asset_model_composite_models
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if if_match is not None:
        input_["if_match"] = if_match
    if if_none_match is not None:
        input_["if_none_match"] = if_none_match
    if match_for_version_type is not None:
        input_["match_for_version_type"] = match_for_version_type

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output