AWS SDK for C++  1.8.59
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::CloudWatch::Model::DescribeAlarmsRequest Class Reference

#include <DescribeAlarmsRequest.h>

+ Inheritance diagram for Aws::CloudWatch::Model::DescribeAlarmsRequest:

Public Member Functions

 DescribeAlarmsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetAlarmNames () const
 
bool AlarmNamesHasBeenSet () const
 
void SetAlarmNames (const Aws::Vector< Aws::String > &value)
 
void SetAlarmNames (Aws::Vector< Aws::String > &&value)
 
DescribeAlarmsRequestWithAlarmNames (const Aws::Vector< Aws::String > &value)
 
DescribeAlarmsRequestWithAlarmNames (Aws::Vector< Aws::String > &&value)
 
DescribeAlarmsRequestAddAlarmNames (const Aws::String &value)
 
DescribeAlarmsRequestAddAlarmNames (Aws::String &&value)
 
DescribeAlarmsRequestAddAlarmNames (const char *value)
 
const Aws::StringGetAlarmNamePrefix () const
 
bool AlarmNamePrefixHasBeenSet () const
 
void SetAlarmNamePrefix (const Aws::String &value)
 
void SetAlarmNamePrefix (Aws::String &&value)
 
void SetAlarmNamePrefix (const char *value)
 
DescribeAlarmsRequestWithAlarmNamePrefix (const Aws::String &value)
 
DescribeAlarmsRequestWithAlarmNamePrefix (Aws::String &&value)
 
DescribeAlarmsRequestWithAlarmNamePrefix (const char *value)
 
const Aws::Vector< AlarmType > & GetAlarmTypes () const
 
bool AlarmTypesHasBeenSet () const
 
void SetAlarmTypes (const Aws::Vector< AlarmType > &value)
 
void SetAlarmTypes (Aws::Vector< AlarmType > &&value)
 
DescribeAlarmsRequestWithAlarmTypes (const Aws::Vector< AlarmType > &value)
 
DescribeAlarmsRequestWithAlarmTypes (Aws::Vector< AlarmType > &&value)
 
DescribeAlarmsRequestAddAlarmTypes (const AlarmType &value)
 
DescribeAlarmsRequestAddAlarmTypes (AlarmType &&value)
 
const Aws::StringGetChildrenOfAlarmName () const
 
bool ChildrenOfAlarmNameHasBeenSet () const
 
void SetChildrenOfAlarmName (const Aws::String &value)
 
void SetChildrenOfAlarmName (Aws::String &&value)
 
void SetChildrenOfAlarmName (const char *value)
 
DescribeAlarmsRequestWithChildrenOfAlarmName (const Aws::String &value)
 
DescribeAlarmsRequestWithChildrenOfAlarmName (Aws::String &&value)
 
DescribeAlarmsRequestWithChildrenOfAlarmName (const char *value)
 
const Aws::StringGetParentsOfAlarmName () const
 
bool ParentsOfAlarmNameHasBeenSet () const
 
void SetParentsOfAlarmName (const Aws::String &value)
 
void SetParentsOfAlarmName (Aws::String &&value)
 
void SetParentsOfAlarmName (const char *value)
 
DescribeAlarmsRequestWithParentsOfAlarmName (const Aws::String &value)
 
DescribeAlarmsRequestWithParentsOfAlarmName (Aws::String &&value)
 
DescribeAlarmsRequestWithParentsOfAlarmName (const char *value)
 
const StateValueGetStateValue () const
 
bool StateValueHasBeenSet () const
 
void SetStateValue (const StateValue &value)
 
void SetStateValue (StateValue &&value)
 
DescribeAlarmsRequestWithStateValue (const StateValue &value)
 
DescribeAlarmsRequestWithStateValue (StateValue &&value)
 
const Aws::StringGetActionPrefix () const
 
bool ActionPrefixHasBeenSet () const
 
void SetActionPrefix (const Aws::String &value)
 
void SetActionPrefix (Aws::String &&value)
 
void SetActionPrefix (const char *value)
 
DescribeAlarmsRequestWithActionPrefix (const Aws::String &value)
 
DescribeAlarmsRequestWithActionPrefix (Aws::String &&value)
 
DescribeAlarmsRequestWithActionPrefix (const char *value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeAlarmsRequestWithMaxRecords (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeAlarmsRequestWithNextToken (const Aws::String &value)
 
DescribeAlarmsRequestWithNextToken (Aws::String &&value)
 
DescribeAlarmsRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::CloudWatch::CloudWatchRequest
virtual ~CloudWatchRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::CloudWatch::CloudWatchRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 24 of file DescribeAlarmsRequest.h.

Constructor & Destructor Documentation

◆ DescribeAlarmsRequest()

Aws::CloudWatch::Model::DescribeAlarmsRequest::DescribeAlarmsRequest ( )

Member Function Documentation

◆ ActionPrefixHasBeenSet()

bool Aws::CloudWatch::Model::DescribeAlarmsRequest::ActionPrefixHasBeenSet ( ) const
inline

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.

Definition at line 533 of file DescribeAlarmsRequest.h.

◆ AddAlarmNames() [1/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::AddAlarmNames ( const Aws::String value)
inline

The names of the alarms to retrieve information about.

Definition at line 75 of file DescribeAlarmsRequest.h.

◆ AddAlarmNames() [2/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::AddAlarmNames ( Aws::String &&  value)
inline

The names of the alarms to retrieve information about.

Definition at line 80 of file DescribeAlarmsRequest.h.

◆ AddAlarmNames() [3/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::AddAlarmNames ( const char *  value)
inline

The names of the alarms to retrieve information about.

Definition at line 85 of file DescribeAlarmsRequest.h.

◆ AddAlarmTypes() [1/2]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::AddAlarmTypes ( const AlarmType value)
inline

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.

Definition at line 192 of file DescribeAlarmsRequest.h.

◆ AddAlarmTypes() [2/2]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::AddAlarmTypes ( AlarmType &&  value)
inline

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.

Definition at line 199 of file DescribeAlarmsRequest.h.

◆ AlarmNamePrefixHasBeenSet()

bool Aws::CloudWatch::Model::DescribeAlarmsRequest::AlarmNamePrefixHasBeenSet ( ) const
inline

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.

Definition at line 100 of file DescribeAlarmsRequest.h.

◆ AlarmNamesHasBeenSet()

bool Aws::CloudWatch::Model::DescribeAlarmsRequest::AlarmNamesHasBeenSet ( ) const
inline

The names of the alarms to retrieve information about.

Definition at line 50 of file DescribeAlarmsRequest.h.

◆ AlarmTypesHasBeenSet()

bool Aws::CloudWatch::Model::DescribeAlarmsRequest::AlarmTypesHasBeenSet ( ) const
inline

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.

Definition at line 157 of file DescribeAlarmsRequest.h.

◆ ChildrenOfAlarmNameHasBeenSet()

bool Aws::CloudWatch::Model::DescribeAlarmsRequest::ChildrenOfAlarmNameHasBeenSet ( ) const
inline

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.

Definition at line 238 of file DescribeAlarmsRequest.h.

◆ DumpBodyToUrl()

void Aws::CloudWatch::Model::DescribeAlarmsRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetActionPrefix()

const Aws::String& Aws::CloudWatch::Model::DescribeAlarmsRequest::GetActionPrefix ( ) const
inline

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.

Definition at line 526 of file DescribeAlarmsRequest.h.

◆ GetAlarmNamePrefix()

const Aws::String& Aws::CloudWatch::Model::DescribeAlarmsRequest::GetAlarmNamePrefix ( ) const
inline

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.

Definition at line 93 of file DescribeAlarmsRequest.h.

◆ GetAlarmNames()

const Aws::Vector<Aws::String>& Aws::CloudWatch::Model::DescribeAlarmsRequest::GetAlarmNames ( ) const
inline

The names of the alarms to retrieve information about.

Definition at line 45 of file DescribeAlarmsRequest.h.

◆ GetAlarmTypes()

const Aws::Vector<AlarmType>& Aws::CloudWatch::Model::DescribeAlarmsRequest::GetAlarmTypes ( ) const
inline

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.

Definition at line 150 of file DescribeAlarmsRequest.h.

◆ GetChildrenOfAlarmName()

const Aws::String& Aws::CloudWatch::Model::DescribeAlarmsRequest::GetChildrenOfAlarmName ( ) const
inline

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.

Definition at line 219 of file DescribeAlarmsRequest.h.

◆ GetMaxRecords()

int Aws::CloudWatch::Model::DescribeAlarmsRequest::GetMaxRecords ( ) const
inline

The maximum number of alarm descriptions to retrieve.

Definition at line 581 of file DescribeAlarmsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::CloudWatch::Model::DescribeAlarmsRequest::GetNextToken ( ) const
inline

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

Definition at line 603 of file DescribeAlarmsRequest.h.

◆ GetParentsOfAlarmName()

const Aws::String& Aws::CloudWatch::Model::DescribeAlarmsRequest::GetParentsOfAlarmName ( ) const
inline

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.

Definition at line 369 of file DescribeAlarmsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CloudWatch::Model::DescribeAlarmsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file DescribeAlarmsRequest.h.

◆ GetStateValue()

const StateValue& Aws::CloudWatch::Model::DescribeAlarmsRequest::GetStateValue ( ) const
inline

Specify this parameter to receive information only about alarms that are currently in the state that you specify.

Definition at line 488 of file DescribeAlarmsRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::CloudWatch::Model::DescribeAlarmsRequest::MaxRecordsHasBeenSet ( ) const
inline

The maximum number of alarm descriptions to retrieve.

Definition at line 586 of file DescribeAlarmsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::CloudWatch::Model::DescribeAlarmsRequest::NextTokenHasBeenSet ( ) const
inline

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

Definition at line 609 of file DescribeAlarmsRequest.h.

◆ ParentsOfAlarmNameHasBeenSet()

bool Aws::CloudWatch::Model::DescribeAlarmsRequest::ParentsOfAlarmNameHasBeenSet ( ) const
inline

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.

Definition at line 385 of file DescribeAlarmsRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudWatch::Model::DescribeAlarmsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetActionPrefix() [1/3]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetActionPrefix ( const Aws::String value)
inline

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.

Definition at line 540 of file DescribeAlarmsRequest.h.

◆ SetActionPrefix() [2/3]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetActionPrefix ( Aws::String &&  value)
inline

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.

Definition at line 547 of file DescribeAlarmsRequest.h.

◆ SetActionPrefix() [3/3]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetActionPrefix ( const char *  value)
inline

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.

Definition at line 554 of file DescribeAlarmsRequest.h.

◆ SetAlarmNamePrefix() [1/3]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetAlarmNamePrefix ( const Aws::String value)
inline

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.

Definition at line 107 of file DescribeAlarmsRequest.h.

◆ SetAlarmNamePrefix() [2/3]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetAlarmNamePrefix ( Aws::String &&  value)
inline

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.

Definition at line 114 of file DescribeAlarmsRequest.h.

◆ SetAlarmNamePrefix() [3/3]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetAlarmNamePrefix ( const char *  value)
inline

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.

Definition at line 121 of file DescribeAlarmsRequest.h.

◆ SetAlarmNames() [1/2]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetAlarmNames ( const Aws::Vector< Aws::String > &  value)
inline

The names of the alarms to retrieve information about.

Definition at line 55 of file DescribeAlarmsRequest.h.

◆ SetAlarmNames() [2/2]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetAlarmNames ( Aws::Vector< Aws::String > &&  value)
inline

The names of the alarms to retrieve information about.

Definition at line 60 of file DescribeAlarmsRequest.h.

◆ SetAlarmTypes() [1/2]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetAlarmTypes ( const Aws::Vector< AlarmType > &  value)
inline

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.

Definition at line 164 of file DescribeAlarmsRequest.h.

◆ SetAlarmTypes() [2/2]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetAlarmTypes ( Aws::Vector< AlarmType > &&  value)
inline

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.

Definition at line 171 of file DescribeAlarmsRequest.h.

◆ SetChildrenOfAlarmName() [1/3]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetChildrenOfAlarmName ( const Aws::String value)
inline

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.

Definition at line 257 of file DescribeAlarmsRequest.h.

◆ SetChildrenOfAlarmName() [2/3]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetChildrenOfAlarmName ( Aws::String &&  value)
inline

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.

Definition at line 276 of file DescribeAlarmsRequest.h.

◆ SetChildrenOfAlarmName() [3/3]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetChildrenOfAlarmName ( const char *  value)
inline

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.

Definition at line 295 of file DescribeAlarmsRequest.h.

◆ SetMaxRecords()

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetMaxRecords ( int  value)
inline

The maximum number of alarm descriptions to retrieve.

Definition at line 591 of file DescribeAlarmsRequest.h.

◆ SetNextToken() [1/3]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetNextToken ( const Aws::String value)
inline

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

Definition at line 615 of file DescribeAlarmsRequest.h.

◆ SetNextToken() [2/3]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetNextToken ( Aws::String &&  value)
inline

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

Definition at line 621 of file DescribeAlarmsRequest.h.

◆ SetNextToken() [3/3]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetNextToken ( const char *  value)
inline

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

Definition at line 627 of file DescribeAlarmsRequest.h.

◆ SetParentsOfAlarmName() [1/3]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetParentsOfAlarmName ( const Aws::String value)
inline

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.

Definition at line 401 of file DescribeAlarmsRequest.h.

◆ SetParentsOfAlarmName() [2/3]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetParentsOfAlarmName ( Aws::String &&  value)
inline

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.

Definition at line 417 of file DescribeAlarmsRequest.h.

◆ SetParentsOfAlarmName() [3/3]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetParentsOfAlarmName ( const char *  value)
inline

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.

Definition at line 433 of file DescribeAlarmsRequest.h.

◆ SetStateValue() [1/2]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetStateValue ( const StateValue value)
inline

Specify this parameter to receive information only about alarms that are currently in the state that you specify.

Definition at line 500 of file DescribeAlarmsRequest.h.

◆ SetStateValue() [2/2]

void Aws::CloudWatch::Model::DescribeAlarmsRequest::SetStateValue ( StateValue &&  value)
inline

Specify this parameter to receive information only about alarms that are currently in the state that you specify.

Definition at line 506 of file DescribeAlarmsRequest.h.

◆ StateValueHasBeenSet()

bool Aws::CloudWatch::Model::DescribeAlarmsRequest::StateValueHasBeenSet ( ) const
inline

Specify this parameter to receive information only about alarms that are currently in the state that you specify.

Definition at line 494 of file DescribeAlarmsRequest.h.

◆ WithActionPrefix() [1/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithActionPrefix ( const Aws::String value)
inline

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.

Definition at line 561 of file DescribeAlarmsRequest.h.

◆ WithActionPrefix() [2/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithActionPrefix ( Aws::String &&  value)
inline

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.

Definition at line 568 of file DescribeAlarmsRequest.h.

◆ WithActionPrefix() [3/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithActionPrefix ( const char *  value)
inline

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.

Definition at line 575 of file DescribeAlarmsRequest.h.

◆ WithAlarmNamePrefix() [1/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithAlarmNamePrefix ( const Aws::String value)
inline

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.

Definition at line 128 of file DescribeAlarmsRequest.h.

◆ WithAlarmNamePrefix() [2/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithAlarmNamePrefix ( Aws::String &&  value)
inline

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.

Definition at line 135 of file DescribeAlarmsRequest.h.

◆ WithAlarmNamePrefix() [3/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithAlarmNamePrefix ( const char *  value)
inline

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.

Definition at line 142 of file DescribeAlarmsRequest.h.

◆ WithAlarmNames() [1/2]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithAlarmNames ( const Aws::Vector< Aws::String > &  value)
inline

The names of the alarms to retrieve information about.

Definition at line 65 of file DescribeAlarmsRequest.h.

◆ WithAlarmNames() [2/2]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithAlarmNames ( Aws::Vector< Aws::String > &&  value)
inline

The names of the alarms to retrieve information about.

Definition at line 70 of file DescribeAlarmsRequest.h.

◆ WithAlarmTypes() [1/2]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithAlarmTypes ( const Aws::Vector< AlarmType > &  value)
inline

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.

Definition at line 178 of file DescribeAlarmsRequest.h.

◆ WithAlarmTypes() [2/2]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithAlarmTypes ( Aws::Vector< AlarmType > &&  value)
inline

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.

Definition at line 185 of file DescribeAlarmsRequest.h.

◆ WithChildrenOfAlarmName() [1/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithChildrenOfAlarmName ( const Aws::String value)
inline

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.

Definition at line 314 of file DescribeAlarmsRequest.h.

◆ WithChildrenOfAlarmName() [2/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithChildrenOfAlarmName ( Aws::String &&  value)
inline

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.

Definition at line 333 of file DescribeAlarmsRequest.h.

◆ WithChildrenOfAlarmName() [3/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithChildrenOfAlarmName ( const char *  value)
inline

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.

Definition at line 352 of file DescribeAlarmsRequest.h.

◆ WithMaxRecords()

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithMaxRecords ( int  value)
inline

The maximum number of alarm descriptions to retrieve.

Definition at line 596 of file DescribeAlarmsRequest.h.

◆ WithNextToken() [1/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithNextToken ( const Aws::String value)
inline

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

Definition at line 633 of file DescribeAlarmsRequest.h.

◆ WithNextToken() [2/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithNextToken ( Aws::String &&  value)
inline

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

Definition at line 639 of file DescribeAlarmsRequest.h.

◆ WithNextToken() [3/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithNextToken ( const char *  value)
inline

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

Definition at line 645 of file DescribeAlarmsRequest.h.

◆ WithParentsOfAlarmName() [1/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithParentsOfAlarmName ( const Aws::String value)
inline

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.

Definition at line 449 of file DescribeAlarmsRequest.h.

◆ WithParentsOfAlarmName() [2/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithParentsOfAlarmName ( Aws::String &&  value)
inline

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.

Definition at line 465 of file DescribeAlarmsRequest.h.

◆ WithParentsOfAlarmName() [3/3]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithParentsOfAlarmName ( const char *  value)
inline

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.

Definition at line 481 of file DescribeAlarmsRequest.h.

◆ WithStateValue() [1/2]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithStateValue ( const StateValue value)
inline

Specify this parameter to receive information only about alarms that are currently in the state that you specify.

Definition at line 512 of file DescribeAlarmsRequest.h.

◆ WithStateValue() [2/2]

DescribeAlarmsRequest& Aws::CloudWatch::Model::DescribeAlarmsRequest::WithStateValue ( StateValue &&  value)
inline

Specify this parameter to receive information only about alarms that are currently in the state that you specify.

Definition at line 518 of file DescribeAlarmsRequest.h.


The documentation for this class was generated from the following file: