Skip to content

reboot_input_device async

reboot_input_device(
    input_device_id: __string,
    *,
    config_overrides: Optional[AsyncMediaLiveClientConfig] = None,
    force: Optional[RebootInputDeviceForce] = None,
) -> RebootInputDeviceResponse

Send a reboot command to the specified input device. The device will begin rebooting within a few seconds of sending the command. When the reboot is complete, the device’s connection status will change to connected.

Parameters:

  • force (Optional[RebootInputDeviceForce], default: None ) –

    Force a reboot of an input device. If the device is streaming, it will stop streaming and begin rebooting within a few seconds of sending the command. If the device was streaming prior to the reboot, the device will resume streaming when the reboot completes.

  • input_device_id (__string) –

    The unique ID of the input device to reboot. For example, hd-123456789abcdef.

Raises:

Source code in docs_src/capo_medialive/_services/async_media_live.py
async def reboot_input_device(
    self,
    input_device_id: "capo_medialive.types.__string.__string",
    *,
    config_overrides: Optional[AsyncMediaLiveClientConfig] = None,
    force: Optional[
        "capo_medialive.types.reboot_input_device_force.RebootInputDeviceForce"
    ] = None,
) -> "capo_medialive.types.reboot_input_device_response.RebootInputDeviceResponse":
    """Send a reboot command to the specified input device. The device will begin rebooting within a few seconds of sending the command. When the reboot is complete, the device’s connection status will change to connected.

    Args:
        force: Force a reboot of an input device. If the device is streaming, it will stop streaming and begin rebooting within a few seconds of sending the command. If the device was streaming prior to the reboot, the device will resume streaming when the reboot completes.
        input_device_id: The unique ID of the input device to reboot. For example, hd-123456789abcdef.

    Raises:
        capo_medialive.errors.bad_gateway_exception.BadGatewayException: Placeholder documentation for BadGatewayException
        capo_medialive.errors.bad_request_exception.BadRequestException: Placeholder documentation for BadRequestException
        capo_medialive.errors.forbidden_exception.ForbiddenException: Placeholder documentation for ForbiddenException
        capo_medialive.errors.gateway_timeout_exception.GatewayTimeoutException: Placeholder documentation for GatewayTimeoutException
        capo_medialive.errors.internal_server_error_exception.InternalServerErrorException: Placeholder documentation for InternalServerErrorException
        capo_medialive.errors.not_found_exception.NotFoundException: Placeholder documentation for NotFoundException
        capo_medialive.errors.too_many_requests_exception.TooManyRequestsException: Placeholder documentation for TooManyRequestsException
        capo_medialive.errors.unprocessable_entity_exception.UnprocessableEntityException: Placeholder documentation for UnprocessableEntityException
        capo_medialive.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_medialive.types.reboot_input_device_request.RebootInputDeviceRequest]",
    ) -> AsyncOperationResponse[
        "capo_medialive.types.reboot_input_device_response.RebootInputDeviceResponse"
    ]:
        import capo_medialive._operations.media_live.reboot_input_device

        (
            output,
            http_response,
        ) = await capo_medialive._operations.media_live.reboot_input_device.async_reboot_input_device(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RebootInputDevice")
    )
    input_: capo_medialive.types.reboot_input_device_request.RebootInputDeviceRequest = {
        "input_device_id": input_device_id
    }
    if force is not None:
        input_["force"] = force

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