AWS SDK for .NET Documentation
DescribeAlarmsRequest Class
AmazonAmazon.CloudWatch.ModelDescribeAlarmsRequest Did this page help you?   Yes   No    Tell us about it...
Container for the parameters to the DescribeAlarms operation.

Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.

Declaration Syntax
C#
public class DescribeAlarmsRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
DescribeAlarmsRequest()()()()
Initializes a new instance of the DescribeAlarmsRequest class

ActionPrefix
The action name prefix.

Constraints:

Length
1 - 1024


AlarmNamePrefix
The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.

Constraints:

Length
1 - 255


AlarmNames
A list of alarm names to retrieve information for.

Constraints:

Length
0 - 100


Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
MaxRecords
The maximum number of alarm descriptions to retrieve.

Constraints:

Range
1 - 100


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

StateValue
The state value to be used in matching alarms.

Constraints:

Allowed Values
OK, ALARM, INSUFFICIENT_DATA


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithActionPrefix(String) Obsolete.
Sets the ActionPrefix property

WithAlarmNamePrefix(String) Obsolete.
Sets the AlarmNamePrefix property

WithAlarmNames(array<String>[]()[][]) Obsolete.
Adds elements to the AlarmNames collection

WithAlarmNames(IEnumerable<(Of <<'(String>)>>)) Obsolete.
Adds elements to the AlarmNames collection

WithMaxRecords(Int32) Obsolete.
Sets the MaxRecords property

WithNextToken(String) Obsolete.
Sets the NextToken property

WithStateValue(String) Obsolete.
Sets the StateValue property

Inheritance Hierarchy
Object
AmazonWebServiceRequest
 DescribeAlarmsRequest
See Also

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)