Container for the parameters to the DescribeAlarms operation.
Namespace: Amazon.CloudWatch.ModelRetrieves 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.
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)
Syntax
| C# | Visual Basic | Visual C++ |
public class DescribeAlarmsRequest : AmazonWebServiceRequest
Public Class DescribeAlarmsRequest _ Inherits AmazonWebServiceRequest
public ref class DescribeAlarmsRequest : public AmazonWebServiceRequest
Members
| All Members | Constructors  | Properties  | Methods |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| 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()()()() | (Inherited from Object.) |
| WithActionPrefix(String) |
Sets the ActionPrefix property
|
| WithAlarmNamePrefix(String) |
Sets the AlarmNamePrefix property
|
| WithAlarmNames(IEnumerable<(Of <<'(String>)>>)) |
Adds elements to the AlarmNames collection
|
| WithAlarmNames(array<String>[]()[][]) |
Adds elements to the AlarmNames collection
|
| WithMaxRecords(Int32) |
Sets the MaxRecords property
|
| WithNextToken(String) |
Sets the NextToken property
|
| WithStateValue(String) |
Sets the StateValue property
|
Inheritance Hierarchy
System..::..Object
Amazon.Runtime..::..AmazonWebServiceRequest
Amazon.CloudWatch.Model..::..DescribeAlarmsRequest
Amazon.Runtime..::..AmazonWebServiceRequest
Amazon.CloudWatch.Model..::..DescribeAlarmsRequest
See Also
