pub struct GetAlarmsFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to GetAlarms
.
Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
Implementations§
source§impl GetAlarmsFluentBuilder
impl GetAlarmsFluentBuilder
sourcepub fn as_input(&self) -> &GetAlarmsInputBuilder
pub fn as_input(&self) -> &GetAlarmsInputBuilder
Access the GetAlarms as a reference.
sourcepub async fn send(
self
) -> Result<GetAlarmsOutput, SdkError<GetAlarmsError, HttpResponse>>
pub async fn send( self ) -> Result<GetAlarmsOutput, SdkError<GetAlarmsError, HttpResponse>>
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.
sourcepub fn customize(
self
) -> CustomizableOperation<GetAlarmsOutput, GetAlarmsError, Self>
pub fn customize( self ) -> CustomizableOperation<GetAlarmsOutput, GetAlarmsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn alarm_name(self, input: impl Into<String>) -> Self
pub fn alarm_name(self, input: impl Into<String>) -> Self
The name of the alarm.
Specify an alarm name to return information about a specific alarm.
sourcepub fn set_alarm_name(self, input: Option<String>) -> Self
pub fn set_alarm_name(self, input: Option<String>) -> Self
The name of the alarm.
Specify an alarm name to return information about a specific alarm.
sourcepub fn get_alarm_name(&self) -> &Option<String>
pub fn get_alarm_name(&self) -> &Option<String>
The name of the alarm.
Specify an alarm name to return information about a specific alarm.
sourcepub fn page_token(self, input: impl Into<String>) -> Self
pub fn page_token(self, input: impl Into<String>) -> Self
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetAlarms
request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
sourcepub fn set_page_token(self, input: Option<String>) -> Self
pub fn set_page_token(self, input: Option<String>) -> Self
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetAlarms
request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
sourcepub fn get_page_token(&self) -> &Option<String>
pub fn get_page_token(&self) -> &Option<String>
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetAlarms
request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
sourcepub fn monitored_resource_name(self, input: impl Into<String>) -> Self
pub fn monitored_resource_name(self, input: impl Into<String>) -> Self
The name of the Lightsail resource being monitored by the alarm.
Specify a monitored resource name to return information about all alarms for a specific resource.
sourcepub fn set_monitored_resource_name(self, input: Option<String>) -> Self
pub fn set_monitored_resource_name(self, input: Option<String>) -> Self
The name of the Lightsail resource being monitored by the alarm.
Specify a monitored resource name to return information about all alarms for a specific resource.
sourcepub fn get_monitored_resource_name(&self) -> &Option<String>
pub fn get_monitored_resource_name(&self) -> &Option<String>
The name of the Lightsail resource being monitored by the alarm.
Specify a monitored resource name to return information about all alarms for a specific resource.
Trait Implementations§
source§impl Clone for GetAlarmsFluentBuilder
impl Clone for GetAlarmsFluentBuilder
source§fn clone(&self) -> GetAlarmsFluentBuilder
fn clone(&self) -> GetAlarmsFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for GetAlarmsFluentBuilder
impl !RefUnwindSafe for GetAlarmsFluentBuilder
impl Send for GetAlarmsFluentBuilder
impl Sync for GetAlarmsFluentBuilder
impl Unpin for GetAlarmsFluentBuilder
impl !UnwindSafe for GetAlarmsFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more