put_asset_model_interface_relationship
async
¶
put_asset_model_interface_relationship(
asset_model_id: CustomID,
interface_asset_model_id: CustomID,
property_mapping_configuration: PropertyMappingConfiguration,
*,
config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
client_token: Optional[ClientToken] = None,
) -> PutAssetModelInterfaceRelationshipResponse
Creates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.
Parameters:
-
asset_model_id(CustomID) –The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
-
interface_asset_model_id(CustomID) –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.
-
property_mapping_configuration(PropertyMappingConfiguration) –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.
-
client_token(Optional[ClientToken], default:None) –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.
Raises:
-
ConflictingOperationException–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.
-
InternalFailureException–IoT SiteWise can't process your request right now. Try again later.
-
InvalidRequestException–The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
LimitExceededException–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.
For more information, see Quotas in the IoT SiteWise User Guide.
-
ResourceNotFoundException–The requested resource can't be found.
-
ThrottlingException–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.
For more information, see Quotas in the IoT SiteWise User Guide.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_iotsitewise/_services/async_io_t_site_wise.py
10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 | |