Skip to content

start_input_device_maintenance_window

start_input_device_maintenance_window(
    input_device_id: __string,
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
) -> StartInputDeviceMaintenanceWindowResponse

Start a maintenance window for the specified input device. Starting a maintenance window will give the device up to two hours to install software. If the device was streaming prior to the maintenance, it will resume streaming when the software is fully installed. Devices automatically install updates while they are powered on and their MediaLive channels are stopped. A maintenance window allows you to update a device without having to stop MediaLive channels that use the device. The device must remain powered on and connected to the internet for the duration of the maintenance.

Parameters:

  • input_device_id (__string) –

    The unique ID of the input device to start a maintenance window for. For example, hd-123456789abcdef.

Raises:

Source code in docs_src/capo_medialive/_services/media_live.py
def start_input_device_maintenance_window(
    self,
    input_device_id: "capo_medialive.types.__string.__string",
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
) -> "capo_medialive.types.start_input_device_maintenance_window_response.StartInputDeviceMaintenanceWindowResponse":
    """Start a maintenance window for the specified input device. Starting a maintenance window will give the device up to two hours to install software. If the device was streaming prior to the maintenance, it will resume streaming when the software is fully installed. Devices automatically install updates while they are powered on and their MediaLive channels are stopped. A maintenance window allows you to update a device without having to stop MediaLive channels that use the device. The device must remain powered on and connected to the internet for the duration of the maintenance.

    Args:
        input_device_id: The unique ID of the input device to start a maintenance window for. 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.
    """

    def _handler(
        req: "OperationRequest[capo_medialive.types.start_input_device_maintenance_window_request.StartInputDeviceMaintenanceWindowRequest]",
    ) -> OperationResponse[
        "capo_medialive.types.start_input_device_maintenance_window_response.StartInputDeviceMaintenanceWindowResponse"
    ]:
        import capo_medialive._operations.media_live.start_input_device_maintenance_window

        output, http_response = (
            capo_medialive._operations.media_live.start_input_device_maintenance_window.start_input_device_maintenance_window(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartInputDeviceMaintenanceWindow")
    )
    input_: capo_medialive.types.start_input_device_maintenance_window_request.StartInputDeviceMaintenanceWindowRequest = {
        "input_device_id": input_device_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output