Struct aws_sdk_cloudwatch::client::fluent_builders::DescribeAlarms
source · [−]pub struct DescribeAlarms<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }
Expand description
Fluent builder constructing a request to DescribeAlarms
.
Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.
To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms
permission that is scoped to *
. You can't return information about composite alarms if your cloudwatch:DescribeAlarms
permission has a narrower scope.
Implementations
impl<C, M, R> DescribeAlarms<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> DescribeAlarms<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<DescribeAlarmsOutput, SdkError<DescribeAlarmsError>> where
R::Policy: SmithyRetryPolicy<DescribeAlarmsInputOperationOutputAlias, DescribeAlarmsOutput, DescribeAlarmsError, DescribeAlarmsInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<DescribeAlarmsOutput, SdkError<DescribeAlarmsError>> where
R::Policy: SmithyRetryPolicy<DescribeAlarmsInputOperationOutputAlias, DescribeAlarmsOutput, DescribeAlarmsError, DescribeAlarmsInputOperationRetryAlias>,
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.
Create a paginator for this request
Paginators are used by calling send().await
which returns a Stream
.
Appends an item to AlarmNames
.
To override the contents of this collection use set_alarm_names
.
The names of the alarms to retrieve information about.
The names of the alarms to retrieve information about.
An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.
If this parameter is specified, you cannot specify AlarmNames
.
An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.
If this parameter is specified, you cannot specify AlarmNames
.
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.
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.
If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the AlarmRule
field of the composite alarm that you specify in ChildrenOfAlarmName
. Information about the composite alarm that you name in ChildrenOfAlarmName
is not returned.
If you specify ChildrenOfAlarmName
, you cannot specify any other parameters in the request except for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Only the Alarm Name
, ARN
, StateValue
(OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp
information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms
operation and specify the parent alarm names in the AlarmNames
parameter.
If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the AlarmRule
field of the composite alarm that you specify in ChildrenOfAlarmName
. Information about the composite alarm that you name in ChildrenOfAlarmName
is not returned.
If you specify ChildrenOfAlarmName
, you cannot specify any other parameters in the request except for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Only the Alarm Name
, ARN
, StateValue
(OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp
information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms
operation and specify the parent alarm names in the AlarmNames
parameter.
If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that have AlarmRule
parameters that reference the alarm named in ParentsOfAlarmName
. Information about the alarm that you specify in ParentsOfAlarmName
is not returned.
If you specify ParentsOfAlarmName
, you cannot specify any other parameters in the request except for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms
operation and specify the parent alarm names in the AlarmNames
parameter.
If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that have AlarmRule
parameters that reference the alarm named in ParentsOfAlarmName
. Information about the alarm that you specify in ParentsOfAlarmName
is not returned.
If you specify ParentsOfAlarmName
, you cannot specify any other parameters in the request except for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms
operation and specify the parent alarm names in the AlarmNames
parameter.
Specify this parameter to receive information only about alarms that are currently in the state that you specify.
Specify this parameter to receive information only about alarms that are currently in the state that you specify.
Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.
Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.
The maximum number of alarm descriptions to retrieve.
The maximum number of alarm descriptions to retrieve.
The token returned by a previous call to indicate that there is more data available.
The token returned by a previous call to indicate that there is more data available.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for DescribeAlarms<C, M, R>
impl<C, M, R> Send for DescribeAlarms<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for DescribeAlarms<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for DescribeAlarms<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for DescribeAlarms<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more