search_system_templates `async` ¶

search_system_templates(
    *,
    config_overrides: Optional[AsyncIoTThingsGraphClientConfig] = None,
    filters: Optional[SystemTemplateFilters] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> SearchSystemTemplatesResponse

Searches for summary information about systems in the user's account. You can filter by the ID of a workflow to return only systems that use the specified workflow.

Parameters:

filters (Optional[SystemTemplateFilters], default: None ) –

An array of filters that limit the result set. The only valid filter is FLOW_TEMPLATE_ID.
next_token (Optional[NextToken], default: None ) –

The string that specifies the next page of results. Use this when you're paginating results.
max_results (Optional[MaxResults], default: None ) –

The maximum number of results to return in the response.

Raises:

InternalFailureException –
InvalidRequestException –
ThrottlingException –
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iotthingsgraph/_services/async_io_t_things_graph.py

async def search_system_templates(
    self,
    *,
    config_overrides: Optional[AsyncIoTThingsGraphClientConfig] = None,
    filters: Optional[
        "capo_iotthingsgraph.types.system_template_filters.SystemTemplateFilters"
    ] = None,
    next_token: Optional["capo_iotthingsgraph.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_iotthingsgraph.types.max_results.MaxResults"
    ] = None,
) -> "capo_iotthingsgraph.types.search_system_templates_response.SearchSystemTemplatesResponse":
    """<p>Searches for summary information about systems in the user's account. You can filter by the ID of a workflow to return only systems that use the specified workflow.</p>

    Args:
        filters: <p>An array of filters that limit the result set. The only valid filter is <code>FLOW_TEMPLATE_ID</code>.</p>
        next_token: <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
        max_results: <p>The maximum number of results to return in the response.</p>

    Raises:
        capo_iotthingsgraph.errors.internal_failure_exception.InternalFailureException: <p></p>
        capo_iotthingsgraph.errors.invalid_request_exception.InvalidRequestException: <p></p>
        capo_iotthingsgraph.errors.throttling_exception.ThrottlingException: <p></p>
        capo_iotthingsgraph.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotthingsgraph.types.search_system_templates_request.SearchSystemTemplatesRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotthingsgraph.types.search_system_templates_response.SearchSystemTemplatesResponse"
    ]:
        import capo_iotthingsgraph._operations.iot_things_graph_front_end_service.search_system_templates

        (
            output,
            http_response,
        ) = await capo_iotthingsgraph._operations.iot_things_graph_front_end_service.search_system_templates.async_search_system_templates(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchSystemTemplates")
    )
    input_: capo_iotthingsgraph.types.search_system_templates_request.SearchSystemTemplatesRequest = {}
    if filters is not None:
        input_["filters"] = filters
    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

search_system_templates async ¶

search_system_templates `async` ¶