aws-cdk-lib 2.133.0__py3-none-any.whl → 2.135.0__py3-none-any.whl

aws_cdk/aws_iotsitewise/__init__.py

@@ -25,6 +25,9 @@ For more information on the resources and properties available for this service,
 
 <!--END CFNONLY DISCLAIMER-->
 '''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
 import abc
 import builtins
 import datetime
@@ -853,7 +856,7 @@ class CfnAsset(
         :param asset_model_id: The ID of the asset model from which to create the asset. This can be either the actual ID in UUID format, or else ``externalId:`` followed by the external ID, if it has one. For more information, see `Referencing objects with external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references>`_ in the *AWS IoT SiteWise User Guide* .
         :param asset_name: A friendly name for the asset.
         :param asset_description: The ID of the asset, in UUID format.
-        :param asset_external_id: The External ID of the asset.
+        :param asset_external_id: The external ID of the asset model composite model. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
         :param asset_hierarchies: A list of asset hierarchies that each contain a ``hierarchyId`` . A hierarchy specifies allowed parent/child asset relationships.
         :param asset_properties: The list of asset properties for the asset. This object doesn't include properties that you define in composite models. You can find composite model properties in the ``assetCompositeModels`` object.
         :param tags: A list of key-value pairs that contain metadata for the asset. For more information, see `Tagging your AWS IoT SiteWise resources <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html>`_ in the *AWS IoT SiteWise User Guide* .
@@ -975,7 +978,7 @@ class CfnAsset(
     @builtins.property
     @jsii.member(jsii_name="assetExternalId")
     def asset_external_id(self) -> typing.Optional[builtins.str]:
-        '''The External ID of the asset.'''
+        '''The external ID of the asset model composite model.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "assetExternalId"))
 
     @asset_external_id.setter
@@ -1056,8 +1059,8 @@ class CfnAsset(
             '''Describes an asset hierarchy that contains a hierarchy's name and ID.
 
             :param child_asset_id: The Id of the child asset.
-            :param external_id: String-friendly customer provided external ID.
-            :param id: Customer provided actual UUID for property.
+            :param external_id: The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
+            :param id: The ID of the hierarchy. This ID is a ``hierarchyId`` . .. epigraph:: This is a return value and can't be set.
             :param logical_id: The ID of the hierarchy. This ID is a ``hierarchyId`` .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html
@@ -1106,7 +1109,9 @@ class CfnAsset(
 
         @builtins.property
         def external_id(self) -> typing.Optional[builtins.str]:
-            '''String-friendly customer provided external ID.
+            '''The external ID of the hierarchy, if it has one.
+
+            When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-externalid
             '''
@@ -1115,7 +1120,11 @@ class CfnAsset(
 
         @builtins.property
         def id(self) -> typing.Optional[builtins.str]:
-            '''Customer provided actual UUID for property.
+            '''The ID of the hierarchy. This ID is a ``hierarchyId`` .
+
+            .. epigraph::
+
+               This is a return value and can't be set.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-id
             '''
@@ -1170,8 +1179,8 @@ class CfnAsset(
             '''Contains asset property information.
 
             :param alias: The alias that identifies the property, such as an OPC-UA server data stream path (for example, ``/company/windfarm/3/turbine/7/temperature`` ). For more information, see `Mapping industrial data streams to asset properties <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html>`_ in the *AWS IoT SiteWise User Guide* .
-            :param external_id: String-friendly customer provided external ID.
-            :param id: Customer provided actual UUID for property.
+            :param external_id: The external ID of the property. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
+            :param id: The ID of the asset property. .. epigraph:: This is a return value and can't be set.
             :param logical_id: The ``LogicalID`` of the asset property.
             :param notification_state: The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see `Interacting with other services <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html>`_ in the *AWS IoT SiteWise User Guide* . If you omit this parameter, the notification state is set to ``DISABLED`` .
             :param unit: The unit (such as ``Newtons`` or ``RPM`` ) of the asset property.
@@ -1229,7 +1238,9 @@ class CfnAsset(
 
         @builtins.property
         def external_id(self) -> typing.Optional[builtins.str]:
-            '''String-friendly customer provided external ID.
+            '''The external ID of the property.
+
+            For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-externalid
             '''
@@ -1238,7 +1249,11 @@ class CfnAsset(
 
         @builtins.property
         def id(self) -> typing.Optional[builtins.str]:
-            '''Customer provided actual UUID for property.
+            '''The ID of the asset property.
+
+            .. epigraph::
+
+               This is a return value and can't be set.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-id
             '''
@@ -1490,10 +1505,10 @@ class CfnAssetModel(
         :param asset_model_name: A unique, friendly name for the asset model.
         :param asset_model_composite_models: 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. .. epigraph:: When creating custom composite models, you need to use `CreateAssetModelCompositeModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html>`_ . For more information, see `Creating custom composite models (Components) <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html>`_ in the *AWS IoT SiteWise User Guide* .
         :param asset_model_description: A description for the asset model.
-        :param asset_model_external_id: The external ID of the asset model.
+        :param asset_model_external_id: The external ID of the asset model. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
         :param asset_model_hierarchies: The 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 `Asset hierarchies <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html>`_ in the *AWS IoT SiteWise User Guide* . You can specify up to 10 hierarchies per asset model. For more information, see `Quotas <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html>`_ in the *AWS IoT SiteWise User Guide* .
         :param asset_model_properties: The property definitions of the asset model. For more information, see `Asset properties <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html>`_ in the *AWS IoT SiteWise User Guide* . You can specify up to 200 properties per asset model. For more information, see `Quotas <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html>`_ in the *AWS IoT SiteWise User Guide* .
-        :param asset_model_type: The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL).
+        :param asset_model_type: The type of asset model. - *ASSET_MODEL* – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. - *COMPONENT_MODEL* – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
         :param tags: A list of key-value pairs that contain metadata for the asset. For more information, see `Tagging your AWS IoT SiteWise resources <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html>`_ in the *AWS IoT SiteWise User Guide* .
         '''
         if __debug__:
@@ -1668,7 +1683,7 @@ class CfnAssetModel(
     @builtins.property
     @jsii.member(jsii_name="assetModelType")
     def asset_model_type(self) -> typing.Optional[builtins.str]:
-        '''The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL).'''
+        '''The type of asset model.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "assetModelType"))
 
     @asset_model_type.setter
@@ -1726,13 +1741,13 @@ class CfnAssetModel(
 
             :param name: The name of the composite model.
             :param type: The type of the composite model. For alarm composite models, this type is ``AWS/ALARM`` .
-            :param composed_asset_model_id: The component model ID for which the composite model is composed of.
+            :param composed_asset_model_id: The ID of a component model which is reused to create this composite model.
             :param composite_model_properties: The asset property definitions for this composite model.
-            :param description: The description of the composite model.
-            :param external_id: The External ID of the composite model.
-            :param id: The Actual ID of the composite model.
-            :param parent_asset_model_composite_model_external_id: The parent composite model External ID.
-            :param path: The path of the composite model. This is only for derived composite models
+            :param description: The description of the composite model. .. epigraph:: If the composite model is a ``component-model-based`` composite model, the description is inherited from the ``COMPONENT_MODEL`` asset model and cannot be changed.
+            :param external_id: The external ID of a composite model on this asset model. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* . .. epigraph:: One of ``ExternalId`` or ``Path`` must be specified.
+            :param id: The ID of the asset model composite model. .. epigraph:: This is a return value and can't be set.
+            :param parent_asset_model_composite_model_external_id: The external ID of the parent composite model. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
+            :param path: The structured path to the property from the root of the asset using property names. Path is used as the ID if the asset model is a derived composite model. .. epigraph:: One of ``ExternalId`` or ``Path`` must be specified.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html
             :exampleMetadata: fixture=_generated
@@ -1871,7 +1886,7 @@ class CfnAssetModel(
 
         @builtins.property
         def composed_asset_model_id(self) -> typing.Optional[builtins.str]:
-            '''The component model ID for which the composite model is composed of.
+            '''The ID of a component model which is reused to create this composite model.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-composedassetmodelid
             '''
@@ -1893,6 +1908,10 @@ class CfnAssetModel(
         def description(self) -> typing.Optional[builtins.str]:
             '''The description of the composite model.
 
+            .. epigraph::
+
+               If the composite model is a ``component-model-based`` composite model, the description is inherited from the ``COMPONENT_MODEL`` asset model and cannot be changed.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-description
             '''
             result = self._values.get("description")
@@ -1900,7 +1919,12 @@ class CfnAssetModel(
 
         @builtins.property
         def external_id(self) -> typing.Optional[builtins.str]:
-            '''The External ID of the composite model.
+            '''The external ID of a composite model on this asset model.
+
+            For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
+            .. epigraph::
+
+               One of ``ExternalId`` or ``Path`` must be specified.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-externalid
             '''
@@ -1909,7 +1933,11 @@ class CfnAssetModel(
 
         @builtins.property
         def id(self) -> typing.Optional[builtins.str]:
-            '''The Actual ID of the composite model.
+            '''The ID of the asset model composite model.
+
+            .. epigraph::
+
+               This is a return value and can't be set.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-id
             '''
@@ -1920,7 +1948,9 @@ class CfnAssetModel(
         def parent_asset_model_composite_model_external_id(
             self,
         ) -> typing.Optional[builtins.str]:
-            '''The parent composite model External ID.
+            '''The external ID of the parent composite model.
+
+            For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-parentassetmodelcompositemodelexternalid
             '''
@@ -1929,9 +1959,12 @@ class CfnAssetModel(
 
         @builtins.property
         def path(self) -> typing.Optional[typing.List[builtins.str]]:
-            '''The path of the composite model.
+            '''The structured path to the property from the root of the asset using property names.
 
-            This is only for derived composite models
+            Path is used as the ID if the asset model is a derived composite model.
+            .. epigraph::
+
+               One of ``ExternalId`` or ``Path`` must be specified.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-path
             '''
@@ -1974,9 +2007,9 @@ class CfnAssetModel(
 
             :param child_asset_model_id: The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the ``childAssetModelId`` asset model. AWS IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ , you may provide either the asset model ID or else ``externalId:`` followed by the asset model's external ID. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
             :param name: The name of the asset model hierarchy that you specify by using the `CreateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html>`_ or `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ API operation.
-            :param external_id: Customer provided external ID for hierarchy.
-            :param id: Customer provided actual ID for hierarchy.
-            :param logical_id: The ``LogicalID`` of the asset model hierarchy. This ID is a ``hierarchyLogicalId`` .
+            :param external_id: The external ID (if any) provided in the `CreateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html>`_ or `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ operation. You can assign an external ID by specifying this value as part of a call to `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ . However, you can't change the external ID if one is already assigned. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* . .. epigraph:: One of ``ExternalId`` or ``LogicalId`` must be specified.
+            :param id: The ID of the asset model hierarchy. This ID is a ``hierarchyId`` . .. epigraph:: This is a return value and can't be set. - If you are callling `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ to create a *new* hierarchy: You can specify its ID here, if desired. AWS 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. - If you are calling UpdateAssetModel to modify an *existing* hierarchy: This can be either the actual ID in UUID format, or else ``externalId:`` followed by the external ID, if it has one. For more information, see `Referencing objects with external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references>`_ in the *AWS IoT SiteWise User Guide* .
+            :param logical_id: The ``LogicalID`` of the asset model hierarchy. This ID is a ``hierarchyLogicalId`` . .. epigraph:: One of ``ExternalId`` or ``LogicalId`` must be specified.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html
             :exampleMetadata: fixture=_generated
@@ -2039,7 +2072,11 @@ class CfnAssetModel(
 
         @builtins.property
         def external_id(self) -> typing.Optional[builtins.str]:
-            '''Customer provided external ID for hierarchy.
+            '''The external ID (if any) provided in the `CreateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html>`_ or `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ operation. You can assign an external ID by specifying this value as part of a call to `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ . However, you can't change the external ID if one is already assigned. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
+
+            .. epigraph::
+
+               One of ``ExternalId`` or ``LogicalId`` must be specified.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-externalid
             '''
@@ -2048,7 +2085,14 @@ class CfnAssetModel(
 
         @builtins.property
         def id(self) -> typing.Optional[builtins.str]:
-            '''Customer provided actual ID for hierarchy.
+            '''The ID of the asset model hierarchy. This ID is a ``hierarchyId`` .
+
+            .. epigraph::
+
+               This is a return value and can't be set.
+
+            - If you are callling `UpdateAssetModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html>`_ to create a *new* hierarchy: You can specify its ID here, if desired. AWS 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.
+            - If you are calling UpdateAssetModel to modify an *existing* hierarchy: This can be either the actual ID in UUID format, or else ``externalId:`` followed by the external ID, if it has one. For more information, see `Referencing objects with external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references>`_ in the *AWS IoT SiteWise User Guide* .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-id
             '''
@@ -2057,9 +2101,11 @@ class CfnAssetModel(
 
         @builtins.property
         def logical_id(self) -> typing.Optional[builtins.str]:
-            '''The ``LogicalID`` of the asset model hierarchy.
+            '''The ``LogicalID`` of the asset model hierarchy. This ID is a ``hierarchyLogicalId`` .
+
+            .. epigraph::
 
-            This ID is a ``hierarchyLogicalId`` .
+               One of ``ExternalId`` or ``LogicalId`` must be specified.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-logicalid
             '''
@@ -2110,9 +2156,9 @@ class CfnAssetModel(
             :param name: The name of the asset model property.
             :param type: Contains a property type, which can be one of ``attribute`` , ``measurement`` , ``metric`` , or ``transform`` .
             :param data_type_spec: The data type of the structure for this property. This parameter exists on properties that have the ``STRUCT`` data type.
-            :param external_id: The External ID of the Asset Model Property.
-            :param id: The ID of the Asset Model Property.
-            :param logical_id: The ``LogicalID`` of the asset model property.
+            :param external_id: The external ID of the asset property. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* . .. epigraph:: One of ``ExternalId`` or ``LogicalId`` must be specified.
+            :param id: The ID of the property. .. epigraph:: This is a return value and can't be set.
+            :param logical_id: The ``LogicalID`` of the asset model property. .. epigraph:: One of ``ExternalId`` or ``LogicalId`` must be specified.
             :param unit: The unit of the asset model property, such as ``Newtons`` or ``RPM`` .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html
@@ -2257,7 +2303,12 @@ class CfnAssetModel(
 
         @builtins.property
         def external_id(self) -> typing.Optional[builtins.str]:
-            '''The External ID of the Asset Model Property.
+            '''The external ID of the asset property.
+
+            For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
+            .. epigraph::
+
+               One of ``ExternalId`` or ``LogicalId`` must be specified.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-externalid
             '''
@@ -2266,7 +2317,11 @@ class CfnAssetModel(
 
         @builtins.property
         def id(self) -> typing.Optional[builtins.str]:
-            '''The ID of the Asset Model Property.
+            '''The ID of the property.
+
+            .. epigraph::
+
+               This is a return value and can't be set.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-id
             '''
@@ -2277,6 +2332,10 @@ class CfnAssetModel(
         def logical_id(self) -> typing.Optional[builtins.str]:
             '''The ``LogicalID`` of the asset model property.
 
+            .. epigraph::
+
+               One of ``ExternalId`` or ``LogicalId`` must be specified.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-logicalid
             '''
             result = self._values.get("logical_id")
@@ -2639,9 +2698,9 @@ class CfnAssetModel(
     )
     class PropertyPathDefinitionProperty:
         def __init__(self, *, name: builtins.str) -> None:
-            '''The definition for property path which is used to reference properties in transforms/metrics.
+            '''Represents one level between a composite model and the root of the asset model.
 
-            :param name: The name of the property.
+            :param name: The name of the path segment.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertypathdefinition.html
             :exampleMetadata: fixture=_generated
@@ -2665,7 +2724,7 @@ class CfnAssetModel(
 
         @builtins.property
         def name(self) -> builtins.str:
-            '''The name of the property.
+            '''The name of the path segment.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertypathdefinition.html#cfn-iotsitewise-assetmodel-propertypathdefinition-name
             '''
@@ -3073,13 +3132,13 @@ class CfnAssetModel(
         ) -> None:
             '''Identifies a property value used in an expression.
 
-            :param hierarchy_external_id: The External ID of the hierarchy that is trying to be referenced.
-            :param hierarchy_id: The ID of the hierarchy that is trying to be referenced.
+            :param hierarchy_external_id: The external ID of the hierarchy being referenced. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
+            :param hierarchy_id: The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify ``externalId:`` followed by the external ID. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* . You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same ``propertyId`` . For example, you might have separately grouped assets that come from the same asset model. For more information, see `Asset hierarchies <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html>`_ in the *AWS IoT SiteWise User Guide* .
             :param hierarchy_logical_id: The ``LogicalID`` of the hierarchy to query for the ``PropertyLogicalID`` . You use a ``hierarchyLogicalID`` instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see `Defining relationships between asset models (hierarchies) <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html>`_ in the *AWS IoT SiteWise User Guide* .
-            :param property_external_id: The External ID of the property that is trying to be referenced.
-            :param property_id: The ID of the property that is trying to be referenced.
+            :param property_external_id: The external ID of the property being referenced. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
+            :param property_id: The ID of the property to use as the variable. You can use the property ``name`` if it's from the same asset model. If the property has an external ID, you can specify ``externalId:`` followed by the external ID. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* . .. epigraph:: This is a return value and can't be set.
             :param property_logical_id: The ``LogicalID`` of the property that is being referenced.
-            :param property_path: The path of the property that is trying to be referenced.
+            :param property_path: The path of the property. Each step of the path is the name of the step. See the following example: ``PropertyPath: Name: AssetModelName Name: Composite1 Name: NestedComposite``
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html
             :exampleMetadata: fixture=_generated
@@ -3129,7 +3188,9 @@ class CfnAssetModel(
 
         @builtins.property
         def hierarchy_external_id(self) -> typing.Optional[builtins.str]:
-            '''The External ID of the hierarchy that is trying to be referenced.
+            '''The external ID of the hierarchy being referenced.
+
+            For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-hierarchyexternalid
             '''
@@ -3138,7 +3199,11 @@ class CfnAssetModel(
 
         @builtins.property
         def hierarchy_id(self) -> typing.Optional[builtins.str]:
-            '''The ID of the hierarchy that is trying to be referenced.
+            '''The ID of the hierarchy to query for the property ID.
+
+            You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify ``externalId:`` followed by the external ID. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
+
+            You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same ``propertyId`` . For example, you might have separately grouped assets that come from the same asset model. For more information, see `Asset hierarchies <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html>`_ in the *AWS IoT SiteWise User Guide* .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-hierarchyid
             '''
@@ -3158,7 +3223,9 @@ class CfnAssetModel(
 
         @builtins.property
         def property_external_id(self) -> typing.Optional[builtins.str]:
-            '''The External ID of the property that is trying to be referenced.
+            '''The external ID of the property being referenced.
+
+            For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertyexternalid
             '''
@@ -3167,7 +3234,12 @@ class CfnAssetModel(
 
         @builtins.property
         def property_id(self) -> typing.Optional[builtins.str]:
-            '''The ID of the property that is trying to be referenced.
+            '''The ID of the property to use as the variable.
+
+            You can use the property ``name`` if it's from the same asset model. If the property has an external ID, you can specify ``externalId:`` followed by the external ID. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
+            .. epigraph::
+
+               This is a return value and can't be set.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertyid
             '''
@@ -3187,7 +3259,11 @@ class CfnAssetModel(
         def property_path(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnAssetModel.PropertyPathDefinitionProperty"]]]]:
-            '''The path of the property that is trying to be referenced.
+            '''The path of the property.
+
+            Each step of the path is the name of the step. See the following example:
+
+            ``PropertyPath: Name: AssetModelName Name: Composite1 Name: NestedComposite``
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertypath
             '''
@@ -3238,10 +3314,10 @@ class CfnAssetModelProps:
         :param asset_model_name: A unique, friendly name for the asset model.
         :param asset_model_composite_models: 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. .. epigraph:: When creating custom composite models, you need to use `CreateAssetModelCompositeModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html>`_ . For more information, see `Creating custom composite models (Components) <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html>`_ in the *AWS IoT SiteWise User Guide* .
         :param asset_model_description: A description for the asset model.
-        :param asset_model_external_id: The external ID of the asset model.
+        :param asset_model_external_id: The external ID of the asset model. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
         :param asset_model_hierarchies: The 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 `Asset hierarchies <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html>`_ in the *AWS IoT SiteWise User Guide* . You can specify up to 10 hierarchies per asset model. For more information, see `Quotas <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html>`_ in the *AWS IoT SiteWise User Guide* .
         :param asset_model_properties: The property definitions of the asset model. For more information, see `Asset properties <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html>`_ in the *AWS IoT SiteWise User Guide* . You can specify up to 200 properties per asset model. For more information, see `Quotas <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html>`_ in the *AWS IoT SiteWise User Guide* .
-        :param asset_model_type: The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL).
+        :param asset_model_type: The type of asset model. - *ASSET_MODEL* – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. - *COMPONENT_MODEL* – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
         :param tags: A list of key-value pairs that contain metadata for the asset. For more information, see `Tagging your AWS IoT SiteWise resources <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html>`_ in the *AWS IoT SiteWise User Guide* .
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html
@@ -3476,6 +3552,8 @@ class CfnAssetModelProps:
     def asset_model_external_id(self) -> typing.Optional[builtins.str]:
         '''The external ID of the asset model.
 
+        For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelexternalid
         '''
         result = self._values.get("asset_model_external_id")
@@ -3513,7 +3591,10 @@ class CfnAssetModelProps:
 
     @builtins.property
     def asset_model_type(self) -> typing.Optional[builtins.str]:
-        '''The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL).
+        '''The type of asset model.
+
+        - *ASSET_MODEL* – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
+        - *COMPONENT_MODEL* – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodeltype
         '''
@@ -3573,7 +3654,7 @@ class CfnAssetProps:
         :param asset_model_id: The ID of the asset model from which to create the asset. This can be either the actual ID in UUID format, or else ``externalId:`` followed by the external ID, if it has one. For more information, see `Referencing objects with external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references>`_ in the *AWS IoT SiteWise User Guide* .
         :param asset_name: A friendly name for the asset.
         :param asset_description: The ID of the asset, in UUID format.
-        :param asset_external_id: The External ID of the asset.
+        :param asset_external_id: The external ID of the asset model composite model. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
         :param asset_hierarchies: A list of asset hierarchies that each contain a ``hierarchyId`` . A hierarchy specifies allowed parent/child asset relationships.
         :param asset_properties: The list of asset properties for the asset. This object doesn't include properties that you define in composite models. You can find composite model properties in the ``assetCompositeModels`` object.
         :param tags: A list of key-value pairs that contain metadata for the asset. For more information, see `Tagging your AWS IoT SiteWise resources <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html>`_ in the *AWS IoT SiteWise User Guide* .
@@ -3673,7 +3754,9 @@ class CfnAssetProps:
 
     @builtins.property
     def asset_external_id(self) -> typing.Optional[builtins.str]:
-        '''The External ID of the asset.
+        '''The external ID of the asset model composite model.
+
+        For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`_ in the *AWS IoT SiteWise User Guide* .
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetexternalid
         '''

aws_cdk/aws_iotthingsgraph/__init__.py

@@ -25,6 +25,9 @@ For more information on the resources and properties available for this service,
 
 <!--END CFNONLY DISCLAIMER-->
 '''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
 import abc
 import builtins
 import datetime

aws_cdk/aws_iottwinmaker/__init__.py

@@ -25,6 +25,9 @@ For more information on the resources and properties available for this service,
 
 <!--END CFNONLY DISCLAIMER-->
 '''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
 import abc
 import builtins
 import datetime

aws_cdk/aws_iotwireless/__init__.py

@@ -25,6 +25,9 @@ For more information on the resources and properties available for this service,
 
 <!--END CFNONLY DISCLAIMER-->
 '''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
 import abc
 import builtins
 import datetime

aws_cdk/aws_ivs/__init__.py

@@ -30,6 +30,9 @@ For more information on the resources and properties available for this service,
 
 <!--END CFNONLY DISCLAIMER-->
 '''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
 import abc
 import builtins
 import datetime

aws_cdk/aws_ivschat/__init__.py

@@ -25,6 +25,9 @@ For more information on the resources and properties available for this service,
 
 <!--END CFNONLY DISCLAIMER-->
 '''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
 import abc
 import builtins
 import datetime