stop_channel ¶

stop_channel(
    channel_id: __string, *, config_overrides: Optional[MediaLiveClientConfig] = None
) -> StopChannelResponse

Stops a running channel

Parameters:

channel_id (__string) –

A request to stop a running channel

Raises:

BadGatewayException –

Placeholder documentation for BadGatewayException
BadRequestException –

Placeholder documentation for BadRequestException
ConflictException –

Placeholder documentation for ConflictException
ForbiddenException –

Placeholder documentation for ForbiddenException
GatewayTimeoutException –

Placeholder documentation for GatewayTimeoutException
InternalServerErrorException –

Placeholder documentation for InternalServerErrorException
NotFoundException –

Placeholder documentation for NotFoundException
TooManyRequestsException –

Placeholder documentation for TooManyRequestsException
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_medialive/_services/media_live.py

def stop_channel(
    self,
    channel_id: "capo_medialive.types.__string.__string",
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
) -> "capo_medialive.types.stop_channel_response.StopChannelResponse":
    """Stops a running channel

    Args:
        channel_id: A request to stop a running channel

    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.conflict_exception.ConflictException: Placeholder documentation for ConflictException
        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.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_medialive.types.stop_channel_request.StopChannelRequest]",
    ) -> OperationResponse[
        "capo_medialive.types.stop_channel_response.StopChannelResponse"
    ]:
        import capo_medialive._operations.media_live.stop_channel

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopChannel")
    )
    input_: capo_medialive.types.stop_channel_request.StopChannelRequest = {
        "channel_id": channel_id
    }

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