Gets information about a Device Advisor test suite.
Requires permission to access the GetSuiteDefinition action.
Parameters:
-
suite_definition_id
(UUID)
–
Suite definition ID of the test suite to get.
-
suite_definition_version
(Optional[SuiteDefinitionVersion], default:
None
)
–
Suite definition version of the test suite to get.
Raises:
Source code in docs_src/capo_iotdeviceadvisor/_services/async_iot_device_advisor.py
| async def get_suite_definition(
self,
suite_definition_id: "capo_iotdeviceadvisor.types.uuid.UUID",
*,
config_overrides: Optional[AsyncIotDeviceAdvisorClientConfig] = None,
suite_definition_version: Optional[
"capo_iotdeviceadvisor.types.suite_definition_version.SuiteDefinitionVersion"
] = None,
) -> "capo_iotdeviceadvisor.types.get_suite_definition_response.GetSuiteDefinitionResponse":
"""<p>Gets information about a Device Advisor test suite.</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">GetSuiteDefinition</a> action.</p>
Args:
suite_definition_id: <p>Suite definition ID of the test suite to get.</p>
suite_definition_version: <p>Suite definition version of the test suite to get.</p>
Raises:
capo_iotdeviceadvisor.errors.internal_server_exception.InternalServerException: <p>Sends an Internal Failure exception.</p>
capo_iotdeviceadvisor.errors.resource_not_found_exception.ResourceNotFoundException: <p>Sends a Resource Not Found 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.
"""
async def _handler(
req: "AsyncOperationRequest[capo_iotdeviceadvisor.types.get_suite_definition_request.GetSuiteDefinitionRequest]",
) -> AsyncOperationResponse[
"capo_iotdeviceadvisor.types.get_suite_definition_response.GetSuiteDefinitionResponse"
]:
import capo_iotdeviceadvisor._operations.iot_senate_service.get_suite_definition
(
output,
http_response,
) = await capo_iotdeviceadvisor._operations.iot_senate_service.get_suite_definition.async_get_suite_definition(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetSuiteDefinition")
)
input_: capo_iotdeviceadvisor.types.get_suite_definition_request.GetSuiteDefinitionRequest = {
"suite_definition_id": suite_definition_id
}
if suite_definition_version is not None:
input_["suite_definition_version"] = suite_definition_version
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|