Skip to content

update_suite_definition async

update_suite_definition(
    suite_definition_id: UUID,
    *,
    config_overrides: Optional[AsyncIotDeviceAdvisorClientConfig] = None,
    suite_definition_configuration: Optional[SuiteDefinitionConfiguration] = None,
) -> UpdateSuiteDefinitionResponse

Updates a Device Advisor test suite.

Requires permission to access the UpdateSuiteDefinition action.

Parameters:

  • suite_definition_id (UUID) –

    Suite definition ID of the test suite to be updated.

  • suite_definition_configuration (Optional[SuiteDefinitionConfiguration], default: None ) –

    Updates a Device Advisor test suite with suite definition configuration.

Raises:

Source code in docs_src/capo_iotdeviceadvisor/_services/async_iot_device_advisor.py
async def update_suite_definition(
    self,
    suite_definition_id: "capo_iotdeviceadvisor.types.uuid.UUID",
    *,
    config_overrides: Optional[AsyncIotDeviceAdvisorClientConfig] = None,
    suite_definition_configuration: Optional[
        "capo_iotdeviceadvisor.types.suite_definition_configuration.SuiteDefinitionConfiguration"
    ] = None,
) -> "capo_iotdeviceadvisor.types.update_suite_definition_response.UpdateSuiteDefinitionResponse":
    """<p>Updates 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">UpdateSuiteDefinition</a> action.</p>

    Args:
        suite_definition_id: <p>Suite definition ID of the test suite to be updated.</p>
        suite_definition_configuration: <p>Updates a Device Advisor test suite with suite definition configuration.</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.update_suite_definition_request.UpdateSuiteDefinitionRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotdeviceadvisor.types.update_suite_definition_response.UpdateSuiteDefinitionResponse"
    ]:
        import capo_iotdeviceadvisor._operations.iot_senate_service.update_suite_definition

        (
            output,
            http_response,
        ) = await capo_iotdeviceadvisor._operations.iot_senate_service.update_suite_definition.async_update_suite_definition(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateSuiteDefinition")
    )
    input_: capo_iotdeviceadvisor.types.update_suite_definition_request.UpdateSuiteDefinitionRequest = {
        "suite_definition_id": suite_definition_id
    }
    if suite_definition_configuration is not None:
        input_["suite_definition_configuration"] = suite_definition_configuration

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output