Skip to content

describe_schedule

describe_schedule(
    channel_id: __string,
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[__string] = None,
) -> DescribeScheduleResponse

Get a channel schedule

Parameters:

  • channel_id (__string) –

    Id of the channel whose schedule is being updated.

Raises:

Source code in docs_src/capo_medialive/_services/media_live.py
def describe_schedule(
    self,
    channel_id: "capo_medialive.types.__string.__string",
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
    max_results: Optional["capo_medialive.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_medialive.types.__string.__string"] = None,
) -> "capo_medialive.types.describe_schedule_response.DescribeScheduleResponse":
    """Get a channel schedule

    Args:
        channel_id: Id of the channel whose schedule is being updated.

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

    def _handler(
        req: "OperationRequest[capo_medialive.types.describe_schedule_request.DescribeScheduleRequest]",
    ) -> OperationResponse[
        "capo_medialive.types.describe_schedule_response.DescribeScheduleResponse"
    ]:
        import capo_medialive._operations.media_live.describe_schedule

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeSchedule")
    )
    input_: capo_medialive.types.describe_schedule_request.DescribeScheduleRequest = {
        "channel_id": channel_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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