Lists the Device Advisor test suites you have created.
Requires permission to access the ListSuiteDefinitions action.
Parameters:
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of results to return at once.
-
next_token
(Optional[Token], default:
None
)
–
A token used to get the next set of results.
Raises:
Source code in docs_src/capo_iotdeviceadvisor/_services/iot_device_advisor.py
| def list_suite_definitions(
self,
*,
config_overrides: Optional[IotDeviceAdvisorClientConfig] = None,
max_results: Optional[
"capo_iotdeviceadvisor.types.max_results.MaxResults"
] = None,
next_token: Optional["capo_iotdeviceadvisor.types.token.Token"] = None,
) -> "capo_iotdeviceadvisor.types.list_suite_definitions_response.ListSuiteDefinitionsResponse":
"""<p>Lists the Device Advisor test suites you have created.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListSuiteDefinitions</a> action.</p>
Args:
max_results: <p>The maximum number of results to return at once.</p>
next_token: <p>A token used to get the next set of results.</p>
Raises:
capo_iotdeviceadvisor.errors.internal_server_exception.InternalServerException: <p>Sends an Internal Failure exception.</p>
capo_iotdeviceadvisor.errors.validation_exception.ValidationException: <p>Sends a validation exception.</p>
capo_iotdeviceadvisor.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_iotdeviceadvisor.types.list_suite_definitions_request.ListSuiteDefinitionsRequest]",
) -> OperationResponse[
"capo_iotdeviceadvisor.types.list_suite_definitions_response.ListSuiteDefinitionsResponse"
]:
import capo_iotdeviceadvisor._operations.iot_senate_service.list_suite_definitions
output, http_response = (
capo_iotdeviceadvisor._operations.iot_senate_service.list_suite_definitions.list_suite_definitions(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListSuiteDefinitions")
)
input_: capo_iotdeviceadvisor.types.list_suite_definitions_request.ListSuiteDefinitionsRequest = {}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|