describe_asset_model ¶

describe_asset_model(
    asset_model_id: CustomID,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    exclude_properties: Optional[ExcludeProperties] = None,
    asset_model_version: Optional[AssetModelVersionFilter] = None,
) -> DescribeAssetModelResponse

Retrieves information about an asset model. This includes details about the asset model's properties, hierarchies, composite models, and any interface relationships if the asset model implements interfaces.

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, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
exclude_properties (Optional[ExcludeProperties], default: None ) –

Whether or not to exclude asset model properties from the response.
asset_model_version (Optional[AssetModelVersionFilter], default: None ) –

The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.

Raises:

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.
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/io_t_site_wise.py

def describe_asset_model(
    self,
    asset_model_id: "capo_iotsitewise.types.custom_id.CustomID",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    exclude_properties: Optional[
        "capo_iotsitewise.types.exclude_properties.ExcludeProperties"
    ] = None,
    asset_model_version: Optional[
        "capo_iotsitewise.types.asset_model_version_filter.AssetModelVersionFilter"
    ] = None,
) -> "capo_iotsitewise.types.describe_asset_model_response.DescribeAssetModelResponse":
    """<p>Retrieves information about an asset model. This includes details about the asset model's properties, hierarchies, composite models, and any interface relationships if the asset model implements interfaces.</p>

    Args:
        asset_model_id: <p>The ID of the asset model. 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>
        exclude_properties: <p> Whether or not to exclude asset model properties from the response. </p>
        asset_model_version: <p>The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is <code>LATEST</code>. 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>

    Raises:
        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.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.describe_asset_model_request.DescribeAssetModelRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.describe_asset_model_response.DescribeAssetModelResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.describe_asset_model

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAssetModel")
    )
    input_: capo_iotsitewise.types.describe_asset_model_request.DescribeAssetModelRequest = {
        "asset_model_id": asset_model_id
    }
    if exclude_properties is not None:
        input_["exclude_properties"] = exclude_properties
    if asset_model_version is not None:
        input_["asset_model_version"] = asset_model_version

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