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.

C# |
public class DescribeAlarmsRequest : AmazonWebServiceRequest

All Members | Constructors | Methods | Properties | ||
Icon | Member | Description |
---|---|---|
![]() | DescribeAlarmsRequest()()()() | Initializes a new instance of the DescribeAlarmsRequest class |
![]() | ActionPrefix |
The action name prefix.
Constraints: |
![]() | AlarmNamePrefix |
The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.
Constraints: |
![]() | AlarmNames |
A list of alarm names to retrieve information for.
Constraints: |
![]() | Equals(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: |
![]() | 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: |
![]() | 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
|

Object | ||
![]() | AmazonWebServiceRequest | |
![]() | DescribeAlarmsRequest |