Skip to content

list_computation_models async

list_computation_models(
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    computation_model_type: Optional[ComputationModelType] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListComputationModelsResponse

Retrieves a paginated list of summaries of all computation models.

Parameters:

  • computation_model_type (Optional[ComputationModelType], default: None ) –

    The type of computation model. If a computationModelType is not provided, all types of computation models are returned.

  • next_token (Optional[NextToken], default: None ) –

    The token to be used for the next set of paginated results.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return for each paginated request.

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.

  • 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/async_io_t_site_wise.py
async def list_computation_models(
    self,
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    computation_model_type: Optional[
        "capo_iotsitewise.types.computation_model_type.ComputationModelType"
    ] = None,
    next_token: Optional["capo_iotsitewise.types.next_token.NextToken"] = None,
    max_results: Optional["capo_iotsitewise.types.max_results.MaxResults"] = None,
) -> "capo_iotsitewise.types.list_computation_models_response.ListComputationModelsResponse":
    """<p>Retrieves a paginated list of summaries of all computation models.</p>

    Args:
        computation_model_type: <p>The type of computation model. If a <code>computationModelType</code> is not provided, all types of computation models are returned.</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.</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.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_computation_models_request.ListComputationModelsRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotsitewise.types.list_computation_models_response.ListComputationModelsResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.list_computation_models

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListComputationModels")
    )
    input_: capo_iotsitewise.types.list_computation_models_request.ListComputationModelsRequest = {}
    if computation_model_type is not None:
        input_["computation_model_type"] = computation_model_type
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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