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

#include <DescribeAlarmHistoryRequest.h>

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

Public Member Functions

 DescribeAlarmHistoryRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetAlarmName () const
 
bool AlarmNameHasBeenSet () const
 
void SetAlarmName (const Aws::String &value)
 
void SetAlarmName (Aws::String &&value)
 
void SetAlarmName (const char *value)
 
DescribeAlarmHistoryRequestWithAlarmName (const Aws::String &value)
 
DescribeAlarmHistoryRequestWithAlarmName (Aws::String &&value)
 
DescribeAlarmHistoryRequestWithAlarmName (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)
 
DescribeAlarmHistoryRequestWithAlarmTypes (const Aws::Vector< AlarmType > &value)
 
DescribeAlarmHistoryRequestWithAlarmTypes (Aws::Vector< AlarmType > &&value)
 
DescribeAlarmHistoryRequestAddAlarmTypes (const AlarmType &value)
 
DescribeAlarmHistoryRequestAddAlarmTypes (AlarmType &&value)
 
const HistoryItemTypeGetHistoryItemType () const
 
bool HistoryItemTypeHasBeenSet () const
 
void SetHistoryItemType (const HistoryItemType &value)
 
void SetHistoryItemType (HistoryItemType &&value)
 
DescribeAlarmHistoryRequestWithHistoryItemType (const HistoryItemType &value)
 
DescribeAlarmHistoryRequestWithHistoryItemType (HistoryItemType &&value)
 
const Aws::Utils::DateTimeGetStartDate () const
 
bool StartDateHasBeenSet () const
 
void SetStartDate (const Aws::Utils::DateTime &value)
 
void SetStartDate (Aws::Utils::DateTime &&value)
 
DescribeAlarmHistoryRequestWithStartDate (const Aws::Utils::DateTime &value)
 
DescribeAlarmHistoryRequestWithStartDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEndDate () const
 
bool EndDateHasBeenSet () const
 
void SetEndDate (const Aws::Utils::DateTime &value)
 
void SetEndDate (Aws::Utils::DateTime &&value)
 
DescribeAlarmHistoryRequestWithEndDate (const Aws::Utils::DateTime &value)
 
DescribeAlarmHistoryRequestWithEndDate (Aws::Utils::DateTime &&value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeAlarmHistoryRequestWithMaxRecords (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)
 
DescribeAlarmHistoryRequestWithNextToken (const Aws::String &value)
 
DescribeAlarmHistoryRequestWithNextToken (Aws::String &&value)
 
DescribeAlarmHistoryRequestWithNextToken (const char *value)
 
const ScanByGetScanBy () const
 
bool ScanByHasBeenSet () const
 
void SetScanBy (const ScanBy &value)
 
void SetScanBy (ScanBy &&value)
 
DescribeAlarmHistoryRequestWithScanBy (const ScanBy &value)
 
DescribeAlarmHistoryRequestWithScanBy (ScanBy &&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 26 of file DescribeAlarmHistoryRequest.h.

Constructor & Destructor Documentation

◆ DescribeAlarmHistoryRequest()

Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::DescribeAlarmHistoryRequest ( )

Member Function Documentation

◆ AddAlarmTypes() [1/2]

DescribeAlarmHistoryRequest& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::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 132 of file DescribeAlarmHistoryRequest.h.

◆ AddAlarmTypes() [2/2]

DescribeAlarmHistoryRequest& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::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 139 of file DescribeAlarmHistoryRequest.h.

◆ AlarmNameHasBeenSet()

bool Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::AlarmNameHasBeenSet ( ) const
inline

The name of the alarm.

Definition at line 52 of file DescribeAlarmHistoryRequest.h.

◆ AlarmTypesHasBeenSet()

bool Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::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 97 of file DescribeAlarmHistoryRequest.h.

◆ DumpBodyToUrl()

void Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::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.

◆ EndDateHasBeenSet()

bool Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::EndDateHasBeenSet ( ) const
inline

The ending date to retrieve alarm history.

Definition at line 212 of file DescribeAlarmHistoryRequest.h.

◆ GetAlarmName()

const Aws::String& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::GetAlarmName ( ) const
inline

The name of the alarm.

Definition at line 47 of file DescribeAlarmHistoryRequest.h.

◆ GetAlarmTypes()

const Aws::Vector<AlarmType>& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::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 90 of file DescribeAlarmHistoryRequest.h.

◆ GetEndDate()

const Aws::Utils::DateTime& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::GetEndDate ( ) const
inline

The ending date to retrieve alarm history.

Definition at line 207 of file DescribeAlarmHistoryRequest.h.

◆ GetHistoryItemType()

const HistoryItemType& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::GetHistoryItemType ( ) const
inline

The type of alarm histories to retrieve.

Definition at line 145 of file DescribeAlarmHistoryRequest.h.

◆ GetMaxRecords()

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

The maximum number of alarm history records to retrieve.

Definition at line 238 of file DescribeAlarmHistoryRequest.h.

◆ GetNextToken()

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

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

Definition at line 260 of file DescribeAlarmHistoryRequest.h.

◆ GetScanBy()

const ScanBy& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::GetScanBy ( ) const
inline

Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.

Definition at line 311 of file DescribeAlarmHistoryRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file DescribeAlarmHistoryRequest.h.

◆ GetStartDate()

const Aws::Utils::DateTime& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::GetStartDate ( ) const
inline

The starting date to retrieve alarm history.

Definition at line 176 of file DescribeAlarmHistoryRequest.h.

◆ HistoryItemTypeHasBeenSet()

bool Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::HistoryItemTypeHasBeenSet ( ) const
inline

The type of alarm histories to retrieve.

Definition at line 150 of file DescribeAlarmHistoryRequest.h.

◆ MaxRecordsHasBeenSet()

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

The maximum number of alarm history records to retrieve.

Definition at line 243 of file DescribeAlarmHistoryRequest.h.

◆ NextTokenHasBeenSet()

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

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

Definition at line 266 of file DescribeAlarmHistoryRequest.h.

◆ ScanByHasBeenSet()

bool Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::ScanByHasBeenSet ( ) const
inline

Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.

Definition at line 319 of file DescribeAlarmHistoryRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAlarmName() [1/3]

void Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::SetAlarmName ( const Aws::String value)
inline

The name of the alarm.

Definition at line 57 of file DescribeAlarmHistoryRequest.h.

◆ SetAlarmName() [2/3]

void Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::SetAlarmName ( Aws::String &&  value)
inline

The name of the alarm.

Definition at line 62 of file DescribeAlarmHistoryRequest.h.

◆ SetAlarmName() [3/3]

void Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::SetAlarmName ( const char *  value)
inline

The name of the alarm.

Definition at line 67 of file DescribeAlarmHistoryRequest.h.

◆ SetAlarmTypes() [1/2]

void Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::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 104 of file DescribeAlarmHistoryRequest.h.

◆ SetAlarmTypes() [2/2]

void Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::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 111 of file DescribeAlarmHistoryRequest.h.

◆ SetEndDate() [1/2]

void Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::SetEndDate ( const Aws::Utils::DateTime value)
inline

The ending date to retrieve alarm history.

Definition at line 217 of file DescribeAlarmHistoryRequest.h.

◆ SetEndDate() [2/2]

void Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::SetEndDate ( Aws::Utils::DateTime &&  value)
inline

The ending date to retrieve alarm history.

Definition at line 222 of file DescribeAlarmHistoryRequest.h.

◆ SetHistoryItemType() [1/2]

void Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::SetHistoryItemType ( const HistoryItemType value)
inline

The type of alarm histories to retrieve.

Definition at line 155 of file DescribeAlarmHistoryRequest.h.

◆ SetHistoryItemType() [2/2]

void Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::SetHistoryItemType ( HistoryItemType &&  value)
inline

The type of alarm histories to retrieve.

Definition at line 160 of file DescribeAlarmHistoryRequest.h.

◆ SetMaxRecords()

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

The maximum number of alarm history records to retrieve.

Definition at line 248 of file DescribeAlarmHistoryRequest.h.

◆ SetNextToken() [1/3]

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

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

Definition at line 272 of file DescribeAlarmHistoryRequest.h.

◆ SetNextToken() [2/3]

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

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

Definition at line 278 of file DescribeAlarmHistoryRequest.h.

◆ SetNextToken() [3/3]

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

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

Definition at line 284 of file DescribeAlarmHistoryRequest.h.

◆ SetScanBy() [1/2]

void Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::SetScanBy ( const ScanBy value)
inline

Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.

Definition at line 327 of file DescribeAlarmHistoryRequest.h.

◆ SetScanBy() [2/2]

void Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::SetScanBy ( ScanBy &&  value)
inline

Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.

Definition at line 335 of file DescribeAlarmHistoryRequest.h.

◆ SetStartDate() [1/2]

void Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::SetStartDate ( const Aws::Utils::DateTime value)
inline

The starting date to retrieve alarm history.

Definition at line 186 of file DescribeAlarmHistoryRequest.h.

◆ SetStartDate() [2/2]

void Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::SetStartDate ( Aws::Utils::DateTime &&  value)
inline

The starting date to retrieve alarm history.

Definition at line 191 of file DescribeAlarmHistoryRequest.h.

◆ StartDateHasBeenSet()

bool Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::StartDateHasBeenSet ( ) const
inline

The starting date to retrieve alarm history.

Definition at line 181 of file DescribeAlarmHistoryRequest.h.

◆ WithAlarmName() [1/3]

DescribeAlarmHistoryRequest& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::WithAlarmName ( const Aws::String value)
inline

The name of the alarm.

Definition at line 72 of file DescribeAlarmHistoryRequest.h.

◆ WithAlarmName() [2/3]

DescribeAlarmHistoryRequest& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::WithAlarmName ( Aws::String &&  value)
inline

The name of the alarm.

Definition at line 77 of file DescribeAlarmHistoryRequest.h.

◆ WithAlarmName() [3/3]

DescribeAlarmHistoryRequest& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::WithAlarmName ( const char *  value)
inline

The name of the alarm.

Definition at line 82 of file DescribeAlarmHistoryRequest.h.

◆ WithAlarmTypes() [1/2]

DescribeAlarmHistoryRequest& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::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 118 of file DescribeAlarmHistoryRequest.h.

◆ WithAlarmTypes() [2/2]

DescribeAlarmHistoryRequest& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::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 125 of file DescribeAlarmHistoryRequest.h.

◆ WithEndDate() [1/2]

DescribeAlarmHistoryRequest& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::WithEndDate ( const Aws::Utils::DateTime value)
inline

The ending date to retrieve alarm history.

Definition at line 227 of file DescribeAlarmHistoryRequest.h.

◆ WithEndDate() [2/2]

DescribeAlarmHistoryRequest& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::WithEndDate ( Aws::Utils::DateTime &&  value)
inline

The ending date to retrieve alarm history.

Definition at line 232 of file DescribeAlarmHistoryRequest.h.

◆ WithHistoryItemType() [1/2]

DescribeAlarmHistoryRequest& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::WithHistoryItemType ( const HistoryItemType value)
inline

The type of alarm histories to retrieve.

Definition at line 165 of file DescribeAlarmHistoryRequest.h.

◆ WithHistoryItemType() [2/2]

DescribeAlarmHistoryRequest& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::WithHistoryItemType ( HistoryItemType &&  value)
inline

The type of alarm histories to retrieve.

Definition at line 170 of file DescribeAlarmHistoryRequest.h.

◆ WithMaxRecords()

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

The maximum number of alarm history records to retrieve.

Definition at line 253 of file DescribeAlarmHistoryRequest.h.

◆ WithNextToken() [1/3]

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

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

Definition at line 290 of file DescribeAlarmHistoryRequest.h.

◆ WithNextToken() [2/3]

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

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

Definition at line 296 of file DescribeAlarmHistoryRequest.h.

◆ WithNextToken() [3/3]

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

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

Definition at line 302 of file DescribeAlarmHistoryRequest.h.

◆ WithScanBy() [1/2]

DescribeAlarmHistoryRequest& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::WithScanBy ( const ScanBy value)
inline

Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.

Definition at line 343 of file DescribeAlarmHistoryRequest.h.

◆ WithScanBy() [2/2]

DescribeAlarmHistoryRequest& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::WithScanBy ( ScanBy &&  value)
inline

Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.

Definition at line 351 of file DescribeAlarmHistoryRequest.h.

◆ WithStartDate() [1/2]

DescribeAlarmHistoryRequest& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::WithStartDate ( const Aws::Utils::DateTime value)
inline

The starting date to retrieve alarm history.

Definition at line 196 of file DescribeAlarmHistoryRequest.h.

◆ WithStartDate() [2/2]

DescribeAlarmHistoryRequest& Aws::CloudWatch::Model::DescribeAlarmHistoryRequest::WithStartDate ( Aws::Utils::DateTime &&  value)
inline

The starting date to retrieve alarm history.

Definition at line 201 of file DescribeAlarmHistoryRequest.h.


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