Struct aws_sdk_cloudwatch::client::fluent_builders::DescribeAlarmHistory

pub struct DescribeAlarmHistory<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to DescribeAlarmHistory.

Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

CloudWatch retains the history of an alarm even if you delete the alarm.

Implementations

impl<C, M, R> DescribeAlarmHistory<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeAlarmHistoryOutput, SdkError<DescribeAlarmHistoryError>> where
    R::Policy: SmithyRetryPolicy<DescribeAlarmHistoryInputOperationOutputAlias, DescribeAlarmHistoryOutput, DescribeAlarmHistoryError, DescribeAlarmHistoryInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn alarm_name(self, inp: impl Into<String>) -> Self

The name of the alarm.

pub fn set_alarm_name(self, input: Option<String>) -> Self

The name of the alarm.

pub fn alarm_types(self, inp: impl Into<AlarmType>) -> Self

Appends an item to AlarmTypes.

To override the contents of this collection use set_alarm_types.

Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.

pub fn set_alarm_types(self, input: Option<Vec<AlarmType>>) -> Self

Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.

pub fn history_item_type(self, inp: HistoryItemType) -> Self

The type of alarm histories to retrieve.

pub fn set_history_item_type(self, input: Option<HistoryItemType>) -> Self

The type of alarm histories to retrieve.

pub fn start_date(self, inp: Instant) -> Self

The starting date to retrieve alarm history.

pub fn set_start_date(self, input: Option<Instant>) -> Self

The starting date to retrieve alarm history.

pub fn end_date(self, inp: Instant) -> Self

The ending date to retrieve alarm history.

pub fn set_end_date(self, input: Option<Instant>) -> Self

The ending date to retrieve alarm history.

pub fn max_records(self, inp: i32) -> Self

The maximum number of alarm history records to retrieve.

pub fn set_max_records(self, input: Option<i32>) -> Self

The maximum number of alarm history records to retrieve.

pub fn next_token(self, inp: impl Into<String>) -> Self

The token returned by a previous call to indicate that there is more data available.

pub fn set_next_token(self, input: Option<String>) -> Self

The token returned by a previous call to indicate that there is more data available.

pub fn scan_by(self, inp: ScanBy) -> Self

Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.

pub fn set_scan_by(self, input: Option<ScanBy>) -> Self

Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeAlarmHistory<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.