list_reservations ¶

def list_reservations(
    self,
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
    channel_class: Optional["capo_medialive.types.__string.__string"] = None,
    codec: Optional["capo_medialive.types.__string.__string"] = None,
    max_results: Optional["capo_medialive.types.max_results.MaxResults"] = None,
    maximum_bitrate: Optional["capo_medialive.types.__string.__string"] = None,
    maximum_framerate: Optional["capo_medialive.types.__string.__string"] = None,
    next_token: Optional["capo_medialive.types.__string.__string"] = None,
    resolution: Optional["capo_medialive.types.__string.__string"] = None,
    resource_type: Optional["capo_medialive.types.__string.__string"] = None,
    special_feature: Optional["capo_medialive.types.__string.__string"] = None,
    video_quality: Optional["capo_medialive.types.__string.__string"] = None,
) -> "capo_medialive.types.list_reservations_response.ListReservationsResponse":
    """List purchased reservations.

    Args:
        channel_class: Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'
        codec: Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', 'LINK', or 'AV1'
        maximum_bitrate: Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'
        maximum_framerate: Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'
        resolution: Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'
        resource_type: Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
        special_feature: Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'
        video_quality: Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'

    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.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.list_reservations_request.ListReservationsRequest]",
    ) -> OperationResponse[
        "capo_medialive.types.list_reservations_response.ListReservationsResponse"
    ]:
        import capo_medialive._operations.media_live.list_reservations

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListReservations")
    )
    input_: capo_medialive.types.list_reservations_request.ListReservationsRequest = {}
    if channel_class is not None:
        input_["channel_class"] = channel_class
    if codec is not None:
        input_["codec"] = codec
    if max_results is not None:
        input_["max_results"] = max_results
    if maximum_bitrate is not None:
        input_["maximum_bitrate"] = maximum_bitrate
    if maximum_framerate is not None:
        input_["maximum_framerate"] = maximum_framerate
    if next_token is not None:
        input_["next_token"] = next_token
    if resolution is not None:
        input_["resolution"] = resolution
    if resource_type is not None:
        input_["resource_type"] = resource_type
    if special_feature is not None:
        input_["special_feature"] = special_feature
    if video_quality is not None:
        input_["video_quality"] = video_quality

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