list_asset_model_properties async ¶

async def list_asset_model_properties(
    self,
    asset_model_id: "capo_iotsitewise.types.custom_id.CustomID",
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    next_token: Optional["capo_iotsitewise.types.next_token.NextToken"] = None,
    max_results: Optional["capo_iotsitewise.types.max_results.MaxResults"] = None,
    filter: Optional[
        "capo_iotsitewise.types.list_asset_model_properties_filter.ListAssetModelPropertiesFilter"
    ] = None,
    asset_model_version: Optional[
        "capo_iotsitewise.types.asset_model_version_filter.AssetModelVersionFilter"
    ] = None,
) -> "capo_iotsitewise.types.list_asset_model_properties_response.ListAssetModelPropertiesResponse":
    """<p>Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.</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>
        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. If not specified, the default value is 50.</p>
        filter: <p> Filters the requested list of asset model properties. You can choose one of the following options:</p> <ul> <li> <p> <code>ALL</code> – The list includes all asset model properties for a given asset model ID. </p> </li> <li> <p> <code>BASE</code> – The list includes only base asset model properties for a given asset model ID. </p> </li> </ul> <p>Default: <code>BASE</code> </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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotsitewise.types.list_asset_model_properties_request.ListAssetModelPropertiesRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotsitewise.types.list_asset_model_properties_response.ListAssetModelPropertiesResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.list_asset_model_properties

        (
            output,
            http_response,
        ) = await capo_iotsitewise._operations.aws_io_t_site_wise.list_asset_model_properties.async_list_asset_model_properties(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAssetModelProperties")
    )
    input_: capo_iotsitewise.types.list_asset_model_properties_request.ListAssetModelPropertiesRequest = {
        "asset_model_id": asset_model_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if filter is not None:
        input_["filter"] = filter
    if asset_model_version is not None:
        input_["asset_model_version"] = asset_model_version

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output