DescribeAssetModelResponse ¶

class DescribeAssetModelResponse(TypedDict, closed=True):
    asset_model_id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the asset model, in UUID format.</p>"""
    asset_model_external_id: NotRequired[
        "capo_iotsitewise.types.external_id.ExternalId"
    ]
    """<p>The external ID of the asset model, if any.</p>"""
    asset_model_arn: "capo_iotsitewise.types.arn.ARN"
    """<p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset model, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}</code> </p>"""
    asset_model_name: "capo_iotsitewise.types.name.Name"
    """<p>The name of the asset model.</p>"""
    asset_model_type: NotRequired[
        "capo_iotsitewise.types.asset_model_type.AssetModelType"
    ]
    """<p>The type of asset model.</p> <ul> <li> <p> <b>ASSET_MODEL</b> – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.</p> </li> <li> <p> <b>COMPONENT_MODEL</b> – 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. </p> </li> </ul>"""
    asset_model_description: "capo_iotsitewise.types.description.Description"
    """<p>The asset model's description.</p>"""
    asset_model_properties: (
        "capo_iotsitewise.types.asset_model_properties.AssetModelProperties"
    )
    """<p>The list of asset properties for the asset model.</p> <p>This object doesn't include properties that you define in composite models. You can find composite model properties in the <code>assetModelCompositeModels</code> object.</p>"""
    asset_model_hierarchies: (
        "capo_iotsitewise.types.asset_model_hierarchies.AssetModelHierarchies"
    )
    """<p>A list of asset model hierarchies that each contain a <code>childAssetModelId</code> and a <code>hierarchyId</code> (named <code>id</code>). A hierarchy specifies allowed parent/child asset relationships for an asset model.</p>"""
    asset_model_composite_models: NotRequired[
        "capo_iotsitewise.types.asset_model_composite_models.AssetModelCompositeModels"
    ]
    """<p>The list of built-in composite models for the asset model, such as those with those of type <code>AWS/ALARMS</code>.</p>"""
    asset_model_composite_model_summaries: NotRequired[
        "capo_iotsitewise.types.asset_model_composite_model_summaries.AssetModelCompositeModelSummaries"
    ]
    """<p>The list of the immediate child custom composite model summaries for the asset model.</p>"""
    asset_model_creation_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date the asset model was created, in Unix epoch time.</p>"""
    asset_model_last_update_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date the asset model was last updated, in Unix epoch time.</p>"""
    asset_model_status: "capo_iotsitewise.types.asset_model_status.AssetModelStatus"
    """<p>The current status of the asset model, which contains a state and any error message.</p>"""
    asset_model_version: NotRequired["capo_iotsitewise.types.version.Version"]
    """<p>The version of the asset model. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html"> Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>"""
    interface_details: NotRequired[
        "capo_iotsitewise.types.interface_details.InterfaceDetails"
    ]
    """<p>A list of interface details that describe the interfaces implemented by this asset model, including interface asset model IDs and property mappings.</p>"""
    e_tag: NotRequired["capo_iotsitewise.types.e_tag.ETag"]
    """<p>The entity tag (ETag) is a hash of the retrieved version of the asset model. It's used to make concurrent updates safely to the resource. 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> <p>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>"""