Creates a Device Advisor test suite.
Requires permission to access the CreateSuiteDefinition action.
Parameters:
-
suite_definition_configuration
(Optional[SuiteDefinitionConfiguration], default:
None
)
–
Creates a Device Advisor test suite with suite definition configuration.
-
tags
(Optional[TagMap], default:
None
)
–
The tags to be attached to the suite definition.
-
client_token
(Optional[ClientToken], default:
None
)
–
The client token for the test suite definition creation. This token is used for tracking test suite definition creation using retries and obtaining its status. This parameter is optional.
Raises:
Source code in docs_src/capo_iotdeviceadvisor/_services/async_iot_device_advisor.py
| async def create_suite_definition(
self,
*,
config_overrides: Optional[AsyncIotDeviceAdvisorClientConfig] = None,
suite_definition_configuration: Optional[
"capo_iotdeviceadvisor.types.suite_definition_configuration.SuiteDefinitionConfiguration"
] = None,
tags: Optional["capo_iotdeviceadvisor.types.tag_map.TagMap"] = None,
client_token: Optional[
"capo_iotdeviceadvisor.types.client_token.ClientToken"
] = None,
) -> "capo_iotdeviceadvisor.types.create_suite_definition_response.CreateSuiteDefinitionResponse":
"""<p>Creates 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">CreateSuiteDefinition</a> action.</p>
Args:
suite_definition_configuration: <p>Creates a Device Advisor test suite with suite definition configuration.</p>
tags: <p>The tags to be attached to the suite definition.</p>
client_token: <p>The client token for the test suite definition creation. This token is used for tracking test suite definition creation using retries and obtaining its status. This parameter is optional.</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.
"""
async def _handler(
req: "AsyncOperationRequest[capo_iotdeviceadvisor.types.create_suite_definition_request.CreateSuiteDefinitionRequest]",
) -> AsyncOperationResponse[
"capo_iotdeviceadvisor.types.create_suite_definition_response.CreateSuiteDefinitionResponse"
]:
import capo_iotdeviceadvisor._operations.iot_senate_service.create_suite_definition
(
output,
http_response,
) = await capo_iotdeviceadvisor._operations.iot_senate_service.create_suite_definition.async_create_suite_definition(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CreateSuiteDefinition")
)
input_: capo_iotdeviceadvisor.types.create_suite_definition_request.CreateSuiteDefinitionRequest = {}
if suite_definition_configuration is not None:
input_["suite_definition_configuration"] = suite_definition_configuration
if tags is not None:
input_["tags"] = tags
if client_token is None:
client_token = str(uuid.uuid4())
input_["client_token"] = client_token
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|