list_alerts ¶

def list_alerts(
    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,
    state_filter: Optional["capo_medialive.types.__string.__string"] = None,
) -> "capo_medialive.types.list_alerts_response.ListAlertsResponse":
    """List the alerts for a channel with optional filtering based on alert state.

    Args:
        channel_id: The unique ID of the channel
        max_results: The maximum number of items to return
        next_token: The next pagination token
        state_filter: Specifies the set of alerts to return based on their state. SET - Return only alerts with SET state. CLEARED - Return only alerts with CLEARED state. ALL - Return all alerts.

    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.list_alerts_request.ListAlertsRequest]",
    ) -> OperationResponse[
        "capo_medialive.types.list_alerts_response.ListAlertsResponse"
    ]:
        import capo_medialive._operations.media_live.list_alerts

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAlerts")
    )
    input_: capo_medialive.types.list_alerts_request.ListAlertsRequest = {
        "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
    if state_filter is not None:
        input_["state_filter"] = state_filter

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