Searches for system instances in the user's account.
Parameters:
-
filters
(Optional[SystemInstanceFilters], default:
None
)
–
Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID, STATUS, and GREENGRASS_GROUP_NAME.
Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
-
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:
Source code in docs_src/capo_iotthingsgraph/_services/io_t_things_graph.py
| def search_system_instances(
self,
*,
config_overrides: Optional[IoTThingsGraphClientConfig] = None,
filters: Optional[
"capo_iotthingsgraph.types.system_instance_filters.SystemInstanceFilters"
] = 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_instances_response.SearchSystemInstancesResponse":
"""<p>Searches for system instances in the user's account.</p>
Args:
filters: <p>Optional filter to apply to the search. Valid filters are <code>SYSTEM_TEMPLATE_ID</code>, <code>STATUS</code>, and <code>GREENGRASS_GROUP_NAME</code>.</p> <p>Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.</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.
"""
def _handler(
req: "OperationRequest[capo_iotthingsgraph.types.search_system_instances_request.SearchSystemInstancesRequest]",
) -> OperationResponse[
"capo_iotthingsgraph.types.search_system_instances_response.SearchSystemInstancesResponse"
]:
import capo_iotthingsgraph._operations.iot_things_graph_front_end_service.search_system_instances
output, http_response = (
capo_iotthingsgraph._operations.iot_things_graph_front_end_service.search_system_instances.search_system_instances(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("SearchSystemInstances")
)
input_: capo_iotthingsgraph.types.search_system_instances_request.SearchSystemInstancesRequest = {}
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 = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|