list_asset_models ¶

def list_asset_models(
    self,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    asset_model_types: Optional[
        "capo_iotsitewise.types.list_asset_models_type_filter.ListAssetModelsTypeFilter"
    ] = None,
    next_token: Optional["capo_iotsitewise.types.next_token.NextToken"] = None,
    max_results: Optional["capo_iotsitewise.types.max_results.MaxResults"] = None,
    asset_model_version: Optional[
        "capo_iotsitewise.types.asset_model_version_filter.AssetModelVersionFilter"
    ] = None,
) -> "capo_iotsitewise.types.list_asset_models_response.ListAssetModelsResponse":
    """<p>Retrieves a paginated list of summaries of all asset models.</p>

    Args:
        asset_model_types: <p>The type of asset model. If you don't provide an <code>assetModelTypes</code>, all types of asset models are returned.</p> <ul> <li> <p> <b>ASSET_MODEL</b> – 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> <li> <p> <b>INTERFACE</b> – An interface is a type of model that defines a standard structure that can be applied to different asset models.</p> </li> </ul>
        next_token: <p>The token to be used for the next set of paginated results.</p>
        max_results: <p>The maximum number of results to return for each paginated request.</p> <p>Default: 50</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.list_asset_models_request.ListAssetModelsRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.list_asset_models_response.ListAssetModelsResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.list_asset_models

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAssetModels")
    )
    input_: capo_iotsitewise.types.list_asset_models_request.ListAssetModelsRequest = {}
    if asset_model_types is not None:
        input_["asset_model_types"] = asset_model_types
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    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