AWS SDK for C++  1.8.49
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::CloudWatch::CloudWatchClient Class Reference

#include <CloudWatchClient.h>

+ Inheritance diagram for Aws::CloudWatch::CloudWatchClient:

Public Types

typedef Aws::Client::AWSXMLClient BASECLASS
 
- Public Types inherited from Aws::Client::AWSXMLClient
typedef AWSClient BASECLASS
 

Public Member Functions

 CloudWatchClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 CloudWatchClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 CloudWatchClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~CloudWatchClient ()
 
Aws::String ConvertRequestToPresignedUrl (const Aws::AmazonSerializableWebServiceRequest &requestToConvert, const char *region) const
 
virtual Model::DeleteAlarmsOutcome DeleteAlarms (const Model::DeleteAlarmsRequest &request) const
 
virtual Model::DeleteAlarmsOutcomeCallable DeleteAlarmsCallable (const Model::DeleteAlarmsRequest &request) const
 
virtual void DeleteAlarmsAsync (const Model::DeleteAlarmsRequest &request, const DeleteAlarmsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteAnomalyDetectorOutcome DeleteAnomalyDetector (const Model::DeleteAnomalyDetectorRequest &request) const
 
virtual Model::DeleteAnomalyDetectorOutcomeCallable DeleteAnomalyDetectorCallable (const Model::DeleteAnomalyDetectorRequest &request) const
 
virtual void DeleteAnomalyDetectorAsync (const Model::DeleteAnomalyDetectorRequest &request, const DeleteAnomalyDetectorResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteDashboardsOutcome DeleteDashboards (const Model::DeleteDashboardsRequest &request) const
 
virtual Model::DeleteDashboardsOutcomeCallable DeleteDashboardsCallable (const Model::DeleteDashboardsRequest &request) const
 
virtual void DeleteDashboardsAsync (const Model::DeleteDashboardsRequest &request, const DeleteDashboardsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteInsightRulesOutcome DeleteInsightRules (const Model::DeleteInsightRulesRequest &request) const
 
virtual Model::DeleteInsightRulesOutcomeCallable DeleteInsightRulesCallable (const Model::DeleteInsightRulesRequest &request) const
 
virtual void DeleteInsightRulesAsync (const Model::DeleteInsightRulesRequest &request, const DeleteInsightRulesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeAlarmHistoryOutcome DescribeAlarmHistory (const Model::DescribeAlarmHistoryRequest &request) const
 
virtual Model::DescribeAlarmHistoryOutcomeCallable DescribeAlarmHistoryCallable (const Model::DescribeAlarmHistoryRequest &request) const
 
virtual void DescribeAlarmHistoryAsync (const Model::DescribeAlarmHistoryRequest &request, const DescribeAlarmHistoryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeAlarmsOutcome DescribeAlarms (const Model::DescribeAlarmsRequest &request) const
 
virtual Model::DescribeAlarmsOutcomeCallable DescribeAlarmsCallable (const Model::DescribeAlarmsRequest &request) const
 
virtual void DescribeAlarmsAsync (const Model::DescribeAlarmsRequest &request, const DescribeAlarmsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeAlarmsForMetricOutcome DescribeAlarmsForMetric (const Model::DescribeAlarmsForMetricRequest &request) const
 
virtual Model::DescribeAlarmsForMetricOutcomeCallable DescribeAlarmsForMetricCallable (const Model::DescribeAlarmsForMetricRequest &request) const
 
virtual void DescribeAlarmsForMetricAsync (const Model::DescribeAlarmsForMetricRequest &request, const DescribeAlarmsForMetricResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeAnomalyDetectorsOutcome DescribeAnomalyDetectors (const Model::DescribeAnomalyDetectorsRequest &request) const
 
virtual Model::DescribeAnomalyDetectorsOutcomeCallable DescribeAnomalyDetectorsCallable (const Model::DescribeAnomalyDetectorsRequest &request) const
 
virtual void DescribeAnomalyDetectorsAsync (const Model::DescribeAnomalyDetectorsRequest &request, const DescribeAnomalyDetectorsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeInsightRulesOutcome DescribeInsightRules (const Model::DescribeInsightRulesRequest &request) const
 
virtual Model::DescribeInsightRulesOutcomeCallable DescribeInsightRulesCallable (const Model::DescribeInsightRulesRequest &request) const
 
virtual void DescribeInsightRulesAsync (const Model::DescribeInsightRulesRequest &request, const DescribeInsightRulesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DisableAlarmActionsOutcome DisableAlarmActions (const Model::DisableAlarmActionsRequest &request) const
 
virtual Model::DisableAlarmActionsOutcomeCallable DisableAlarmActionsCallable (const Model::DisableAlarmActionsRequest &request) const
 
virtual void DisableAlarmActionsAsync (const Model::DisableAlarmActionsRequest &request, const DisableAlarmActionsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DisableInsightRulesOutcome DisableInsightRules (const Model::DisableInsightRulesRequest &request) const
 
virtual Model::DisableInsightRulesOutcomeCallable DisableInsightRulesCallable (const Model::DisableInsightRulesRequest &request) const
 
virtual void DisableInsightRulesAsync (const Model::DisableInsightRulesRequest &request, const DisableInsightRulesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::EnableAlarmActionsOutcome EnableAlarmActions (const Model::EnableAlarmActionsRequest &request) const
 
virtual Model::EnableAlarmActionsOutcomeCallable EnableAlarmActionsCallable (const Model::EnableAlarmActionsRequest &request) const
 
virtual void EnableAlarmActionsAsync (const Model::EnableAlarmActionsRequest &request, const EnableAlarmActionsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::EnableInsightRulesOutcome EnableInsightRules (const Model::EnableInsightRulesRequest &request) const
 
virtual Model::EnableInsightRulesOutcomeCallable EnableInsightRulesCallable (const Model::EnableInsightRulesRequest &request) const
 
virtual void EnableInsightRulesAsync (const Model::EnableInsightRulesRequest &request, const EnableInsightRulesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetDashboardOutcome GetDashboard (const Model::GetDashboardRequest &request) const
 
virtual Model::GetDashboardOutcomeCallable GetDashboardCallable (const Model::GetDashboardRequest &request) const
 
virtual void GetDashboardAsync (const Model::GetDashboardRequest &request, const GetDashboardResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetInsightRuleReportOutcome GetInsightRuleReport (const Model::GetInsightRuleReportRequest &request) const
 
virtual Model::GetInsightRuleReportOutcomeCallable GetInsightRuleReportCallable (const Model::GetInsightRuleReportRequest &request) const
 
virtual void GetInsightRuleReportAsync (const Model::GetInsightRuleReportRequest &request, const GetInsightRuleReportResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetMetricDataOutcome GetMetricData (const Model::GetMetricDataRequest &request) const
 
virtual Model::GetMetricDataOutcomeCallable GetMetricDataCallable (const Model::GetMetricDataRequest &request) const
 
virtual void GetMetricDataAsync (const Model::GetMetricDataRequest &request, const GetMetricDataResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetMetricStatisticsOutcome GetMetricStatistics (const Model::GetMetricStatisticsRequest &request) const
 
virtual Model::GetMetricStatisticsOutcomeCallable GetMetricStatisticsCallable (const Model::GetMetricStatisticsRequest &request) const
 
virtual void GetMetricStatisticsAsync (const Model::GetMetricStatisticsRequest &request, const GetMetricStatisticsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetMetricWidgetImageOutcome GetMetricWidgetImage (const Model::GetMetricWidgetImageRequest &request) const
 
virtual Model::GetMetricWidgetImageOutcomeCallable GetMetricWidgetImageCallable (const Model::GetMetricWidgetImageRequest &request) const
 
virtual void GetMetricWidgetImageAsync (const Model::GetMetricWidgetImageRequest &request, const GetMetricWidgetImageResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListDashboardsOutcome ListDashboards (const Model::ListDashboardsRequest &request) const
 
virtual Model::ListDashboardsOutcomeCallable ListDashboardsCallable (const Model::ListDashboardsRequest &request) const
 
virtual void ListDashboardsAsync (const Model::ListDashboardsRequest &request, const ListDashboardsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListMetricsOutcome ListMetrics (const Model::ListMetricsRequest &request) const
 
virtual Model::ListMetricsOutcomeCallable ListMetricsCallable (const Model::ListMetricsRequest &request) const
 
virtual void ListMetricsAsync (const Model::ListMetricsRequest &request, const ListMetricsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListTagsForResourceOutcome ListTagsForResource (const Model::ListTagsForResourceRequest &request) const
 
virtual Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable (const Model::ListTagsForResourceRequest &request) const
 
virtual void ListTagsForResourceAsync (const Model::ListTagsForResourceRequest &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::PutAnomalyDetectorOutcome PutAnomalyDetector (const Model::PutAnomalyDetectorRequest &request) const
 
virtual Model::PutAnomalyDetectorOutcomeCallable PutAnomalyDetectorCallable (const Model::PutAnomalyDetectorRequest &request) const
 
virtual void PutAnomalyDetectorAsync (const Model::PutAnomalyDetectorRequest &request, const PutAnomalyDetectorResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::PutCompositeAlarmOutcome PutCompositeAlarm (const Model::PutCompositeAlarmRequest &request) const
 
virtual Model::PutCompositeAlarmOutcomeCallable PutCompositeAlarmCallable (const Model::PutCompositeAlarmRequest &request) const
 
virtual void PutCompositeAlarmAsync (const Model::PutCompositeAlarmRequest &request, const PutCompositeAlarmResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::PutDashboardOutcome PutDashboard (const Model::PutDashboardRequest &request) const
 
virtual Model::PutDashboardOutcomeCallable PutDashboardCallable (const Model::PutDashboardRequest &request) const
 
virtual void PutDashboardAsync (const Model::PutDashboardRequest &request, const PutDashboardResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::PutInsightRuleOutcome PutInsightRule (const Model::PutInsightRuleRequest &request) const
 
virtual Model::PutInsightRuleOutcomeCallable PutInsightRuleCallable (const Model::PutInsightRuleRequest &request) const
 
virtual void PutInsightRuleAsync (const Model::PutInsightRuleRequest &request, const PutInsightRuleResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::PutMetricAlarmOutcome PutMetricAlarm (const Model::PutMetricAlarmRequest &request) const
 
virtual Model::PutMetricAlarmOutcomeCallable PutMetricAlarmCallable (const Model::PutMetricAlarmRequest &request) const
 
virtual void PutMetricAlarmAsync (const Model::PutMetricAlarmRequest &request, const PutMetricAlarmResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::PutMetricDataOutcome PutMetricData (const Model::PutMetricDataRequest &request) const
 
virtual Model::PutMetricDataOutcomeCallable PutMetricDataCallable (const Model::PutMetricDataRequest &request) const
 
virtual void PutMetricDataAsync (const Model::PutMetricDataRequest &request, const PutMetricDataResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::SetAlarmStateOutcome SetAlarmState (const Model::SetAlarmStateRequest &request) const
 
virtual Model::SetAlarmStateOutcomeCallable SetAlarmStateCallable (const Model::SetAlarmStateRequest &request) const
 
virtual void SetAlarmStateAsync (const Model::SetAlarmStateRequest &request, const SetAlarmStateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::TagResourceOutcome TagResource (const Model::TagResourceRequest &request) const
 
virtual Model::TagResourceOutcomeCallable TagResourceCallable (const Model::TagResourceRequest &request) const
 
virtual void TagResourceAsync (const Model::TagResourceRequest &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UntagResourceOutcome UntagResource (const Model::UntagResourceRequest &request) const
 
virtual Model::UntagResourceOutcomeCallable UntagResourceCallable (const Model::UntagResourceRequest &request) const
 
virtual void UntagResourceAsync (const Model::UntagResourceRequest &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void OverrideEndpoint (const Aws::String &endpoint)
 
- Public Member Functions inherited from Aws::Client::AWSXMLClient
 AWSXMLClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSXMLClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSXMLClient ()=default
 
- Public Member Functions inherited from Aws::Client::AWSClient
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSClient ()
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
void DisableRequestProcessing ()
 
void EnableRequestProcessing ()
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Client::AWSXMLClient
virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
XmlOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr) const
 
XmlOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr) const
 
XmlOutcome MakeRequestWithEventStream (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *singerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr) const
 
XmlOutcome MakeRequestWithEventStream (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr) const
 
- Protected Member Functions inherited from Aws::Client::AWSClient
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr) const
 
virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const
 
const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const
 
Aws::Client::AWSAuthSignerGetSignerByName (const char *name) const
 
std::shared_ptr< Aws::Http::HttpRequestBuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const
 
std::shared_ptr< Aws::Http::HttpResponseMakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Attributes inherited from Aws::Client::AWSClient
Aws::String m_region
 

Detailed Description

Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.

CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.

In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.

Definition at line 225 of file CloudWatchClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 228 of file CloudWatchClient.h.

Constructor & Destructor Documentation

◆ CloudWatchClient() [1/3]

Aws::CloudWatch::CloudWatchClient::CloudWatchClient ( const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration())

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ CloudWatchClient() [2/3]

Aws::CloudWatch::CloudWatchClient::CloudWatchClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ CloudWatchClient() [3/3]

Aws::CloudWatch::CloudWatchClient::CloudWatchClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

◆ ~CloudWatchClient()

virtual Aws::CloudWatch::CloudWatchClient::~CloudWatchClient ( )
virtual

Member Function Documentation

◆ ConvertRequestToPresignedUrl()

Aws::String Aws::CloudWatch::CloudWatchClient::ConvertRequestToPresignedUrl ( const Aws::AmazonSerializableWebServiceRequest requestToConvert,
const char *  region 
) const

Converts any request object to a presigned URL with the GET method, using region for the signer and a timeout of 15 minutes.

◆ DeleteAlarms()

virtual Model::DeleteAlarmsOutcome Aws::CloudWatch::CloudWatchClient::DeleteAlarms ( const Model::DeleteAlarmsRequest request) const
virtual

Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.

In the event of an error, no alarms are deleted.

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

See Also:

AWS API Reference

◆ DeleteAlarmsAsync()

virtual void Aws::CloudWatch::CloudWatchClient::DeleteAlarmsAsync ( const Model::DeleteAlarmsRequest request,
const DeleteAlarmsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.

In the event of an error, no alarms are deleted.

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteAlarmsCallable()

virtual Model::DeleteAlarmsOutcomeCallable Aws::CloudWatch::CloudWatchClient::DeleteAlarmsCallable ( const Model::DeleteAlarmsRequest request) const
virtual

Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.

In the event of an error, no alarms are deleted.

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteAnomalyDetector()

virtual Model::DeleteAnomalyDetectorOutcome Aws::CloudWatch::CloudWatchClient::DeleteAnomalyDetector ( const Model::DeleteAnomalyDetectorRequest request) const
virtual

Deletes the specified anomaly detection model from your account.

See Also:

AWS API Reference

◆ DeleteAnomalyDetectorAsync()

virtual void Aws::CloudWatch::CloudWatchClient::DeleteAnomalyDetectorAsync ( const Model::DeleteAnomalyDetectorRequest request,
const DeleteAnomalyDetectorResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes the specified anomaly detection model from your account.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteAnomalyDetectorCallable()

virtual Model::DeleteAnomalyDetectorOutcomeCallable Aws::CloudWatch::CloudWatchClient::DeleteAnomalyDetectorCallable ( const Model::DeleteAnomalyDetectorRequest request) const
virtual

Deletes the specified anomaly detection model from your account.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteDashboards()

virtual Model::DeleteDashboardsOutcome Aws::CloudWatch::CloudWatchClient::DeleteDashboards ( const Model::DeleteDashboardsRequest request) const
virtual

Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

See Also:

AWS API Reference

◆ DeleteDashboardsAsync()

virtual void Aws::CloudWatch::CloudWatchClient::DeleteDashboardsAsync ( const Model::DeleteDashboardsRequest request,
const DeleteDashboardsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteDashboardsCallable()

virtual Model::DeleteDashboardsOutcomeCallable Aws::CloudWatch::CloudWatchClient::DeleteDashboardsCallable ( const Model::DeleteDashboardsRequest request) const
virtual

Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteInsightRules()

virtual Model::DeleteInsightRulesOutcome Aws::CloudWatch::CloudWatchClient::DeleteInsightRules ( const Model::DeleteInsightRulesRequest request) const
virtual

Permanently deletes the specified Contributor Insights rules.

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

See Also:

AWS API Reference

◆ DeleteInsightRulesAsync()

virtual void Aws::CloudWatch::CloudWatchClient::DeleteInsightRulesAsync ( const Model::DeleteInsightRulesRequest request,
const DeleteInsightRulesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Permanently deletes the specified Contributor Insights rules.

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteInsightRulesCallable()

virtual Model::DeleteInsightRulesOutcomeCallable Aws::CloudWatch::CloudWatchClient::DeleteInsightRulesCallable ( const Model::DeleteInsightRulesRequest request) const
virtual

Permanently deletes the specified Contributor Insights rules.

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeAlarmHistory()

virtual Model::DescribeAlarmHistoryOutcome Aws::CloudWatch::CloudWatchClient::DescribeAlarmHistory ( const Model::DescribeAlarmHistoryRequest request) const
virtual

Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

CloudWatch retains the history of an alarm even if you delete the alarm.

See Also:

AWS API Reference

◆ DescribeAlarmHistoryAsync()

virtual void Aws::CloudWatch::CloudWatchClient::DescribeAlarmHistoryAsync ( const Model::DescribeAlarmHistoryRequest request,
const DescribeAlarmHistoryResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

CloudWatch retains the history of an alarm even if you delete the alarm.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeAlarmHistoryCallable()

virtual Model::DescribeAlarmHistoryOutcomeCallable Aws::CloudWatch::CloudWatchClient::DescribeAlarmHistoryCallable ( const Model::DescribeAlarmHistoryRequest request) const
virtual

Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

CloudWatch retains the history of an alarm even if you delete the alarm.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeAlarms()

virtual Model::DescribeAlarmsOutcome Aws::CloudWatch::CloudWatchClient::DescribeAlarms ( const Model::DescribeAlarmsRequest request) const
virtual

Retrieves the specified alarms. You can filter the results by specifying a a prefix for the alarm name, the alarm state, or a prefix for any action.

See Also:

AWS API Reference

◆ DescribeAlarmsAsync()

virtual void Aws::CloudWatch::CloudWatchClient::DescribeAlarmsAsync ( const Model::DescribeAlarmsRequest request,
const DescribeAlarmsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Retrieves the specified alarms. You can filter the results by specifying a a prefix for the alarm name, the alarm state, or a prefix for any action.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeAlarmsCallable()

virtual Model::DescribeAlarmsOutcomeCallable Aws::CloudWatch::CloudWatchClient::DescribeAlarmsCallable ( const Model::DescribeAlarmsRequest request) const
virtual

Retrieves the specified alarms. You can filter the results by specifying a a prefix for the alarm name, the alarm state, or a prefix for any action.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeAlarmsForMetric()

virtual Model::DescribeAlarmsForMetricOutcome Aws::CloudWatch::CloudWatchClient::DescribeAlarmsForMetric ( const Model::DescribeAlarmsForMetricRequest request) const
virtual

Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

See Also:

AWS API Reference

◆ DescribeAlarmsForMetricAsync()

virtual void Aws::CloudWatch::CloudWatchClient::DescribeAlarmsForMetricAsync ( const Model::DescribeAlarmsForMetricRequest request,
const DescribeAlarmsForMetricResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeAlarmsForMetricCallable()

virtual Model::DescribeAlarmsForMetricOutcomeCallable Aws::CloudWatch::CloudWatchClient::DescribeAlarmsForMetricCallable ( const Model::DescribeAlarmsForMetricRequest request) const
virtual

Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeAnomalyDetectors()

virtual Model::DescribeAnomalyDetectorsOutcome Aws::CloudWatch::CloudWatchClient::DescribeAnomalyDetectors ( const Model::DescribeAnomalyDetectorsRequest request) const
virtual

Lists the anomaly detection models that you have created in your account. You can list all models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension.

See Also:

AWS API Reference

◆ DescribeAnomalyDetectorsAsync()

virtual void Aws::CloudWatch::CloudWatchClient::DescribeAnomalyDetectorsAsync ( const Model::DescribeAnomalyDetectorsRequest request,
const DescribeAnomalyDetectorsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Lists the anomaly detection models that you have created in your account. You can list all models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeAnomalyDetectorsCallable()

virtual Model::DescribeAnomalyDetectorsOutcomeCallable Aws::CloudWatch::CloudWatchClient::DescribeAnomalyDetectorsCallable ( const Model::DescribeAnomalyDetectorsRequest request) const
virtual

Lists the anomaly detection models that you have created in your account. You can list all models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeInsightRules()

virtual Model::DescribeInsightRulesOutcome Aws::CloudWatch::CloudWatchClient::DescribeInsightRules ( const Model::DescribeInsightRulesRequest request) const
virtual

Returns a list of all the Contributor Insights rules in your account. All rules in your account are returned with a single operation.

For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data.

See Also:

AWS API Reference

◆ DescribeInsightRulesAsync()

virtual void Aws::CloudWatch::CloudWatchClient::DescribeInsightRulesAsync ( const Model::DescribeInsightRulesRequest request,
const DescribeInsightRulesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of all the Contributor Insights rules in your account. All rules in your account are returned with a single operation.

For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeInsightRulesCallable()

virtual Model::DescribeInsightRulesOutcomeCallable Aws::CloudWatch::CloudWatchClient::DescribeInsightRulesCallable ( const Model::DescribeInsightRulesRequest request) const
virtual

Returns a list of all the Contributor Insights rules in your account. All rules in your account are returned with a single operation.

For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DisableAlarmActions()

virtual Model::DisableAlarmActionsOutcome Aws::CloudWatch::CloudWatchClient::DisableAlarmActions ( const Model::DisableAlarmActionsRequest request) const
virtual

Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.

See Also:

AWS API Reference

◆ DisableAlarmActionsAsync()

virtual void Aws::CloudWatch::CloudWatchClient::DisableAlarmActionsAsync ( const Model::DisableAlarmActionsRequest request,
const DisableAlarmActionsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DisableAlarmActionsCallable()

virtual Model::DisableAlarmActionsOutcomeCallable Aws::CloudWatch::CloudWatchClient::DisableAlarmActionsCallable ( const Model::DisableAlarmActionsRequest request) const
virtual

Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DisableInsightRules()

virtual Model::DisableInsightRulesOutcome Aws::CloudWatch::CloudWatchClient::DisableInsightRules ( const Model::DisableInsightRulesRequest request) const
virtual

Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.

See Also:

AWS API Reference

◆ DisableInsightRulesAsync()

virtual void Aws::CloudWatch::CloudWatchClient::DisableInsightRulesAsync ( const Model::DisableInsightRulesRequest request,
const DisableInsightRulesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DisableInsightRulesCallable()

virtual Model::DisableInsightRulesOutcomeCallable Aws::CloudWatch::CloudWatchClient::DisableInsightRulesCallable ( const Model::DisableInsightRulesRequest request) const
virtual

Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ EnableAlarmActions()

virtual Model::EnableAlarmActionsOutcome Aws::CloudWatch::CloudWatchClient::EnableAlarmActions ( const Model::EnableAlarmActionsRequest request) const
virtual

Enables the actions for the specified alarms.

See Also:

AWS API Reference

◆ EnableAlarmActionsAsync()

virtual void Aws::CloudWatch::CloudWatchClient::EnableAlarmActionsAsync ( const Model::EnableAlarmActionsRequest request,
const EnableAlarmActionsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Enables the actions for the specified alarms.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ EnableAlarmActionsCallable()

virtual Model::EnableAlarmActionsOutcomeCallable Aws::CloudWatch::CloudWatchClient::EnableAlarmActionsCallable ( const Model::EnableAlarmActionsRequest request) const
virtual

Enables the actions for the specified alarms.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ EnableInsightRules()

virtual Model::EnableInsightRulesOutcome Aws::CloudWatch::CloudWatchClient::EnableInsightRules ( const Model::EnableInsightRulesRequest request) const
virtual

Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.

See Also:

AWS API Reference

◆ EnableInsightRulesAsync()

virtual void Aws::CloudWatch::CloudWatchClient::EnableInsightRulesAsync ( const Model::EnableInsightRulesRequest request,
const EnableInsightRulesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ EnableInsightRulesCallable()

virtual Model::EnableInsightRulesOutcomeCallable Aws::CloudWatch::CloudWatchClient::EnableInsightRulesCallable ( const Model::EnableInsightRulesRequest request) const
virtual

Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetDashboard()

virtual Model::GetDashboardOutcome Aws::CloudWatch::CloudWatchClient::GetDashboard ( const Model::GetDashboardRequest request) const
virtual

Displays the details of the dashboard that you specify.

To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

See Also:

AWS API Reference

◆ GetDashboardAsync()

virtual void Aws::CloudWatch::CloudWatchClient::GetDashboardAsync ( const Model::GetDashboardRequest request,
const GetDashboardResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Displays the details of the dashboard that you specify.

To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetDashboardCallable()

virtual Model::GetDashboardOutcomeCallable Aws::CloudWatch::CloudWatchClient::GetDashboardCallable ( const Model::GetDashboardRequest request) const
virtual

Displays the details of the dashboard that you specify.

To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetInsightRuleReport()

virtual Model::GetInsightRuleReportOutcome Aws::CloudWatch::CloudWatchClient::GetInsightRuleReport ( const Model::GetInsightRuleReportRequest request) const
virtual

This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.

You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

  • UniqueContributors – the number of unique contributors for each data point.

  • MaxContributorValue – the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

    If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

  • SampleCount – the number of data points matched by the rule.

  • Sum – the sum of the values from all contributors during the time period represented by that data point.

  • Minimum – the minimum value from a single observation during the time period represented by that data point.

  • Maximum – the maximum value from a single observation during the time period represented by that data point.

  • Average – the average value from all contributors during the time period represented by that data point.

See Also:

AWS API Reference

◆ GetInsightRuleReportAsync()

virtual void Aws::CloudWatch::CloudWatchClient::GetInsightRuleReportAsync ( const Model::GetInsightRuleReportRequest request,
const GetInsightRuleReportResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.

You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

  • UniqueContributors – the number of unique contributors for each data point.

  • MaxContributorValue – the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

    If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

  • SampleCount – the number of data points matched by the rule.

  • Sum – the sum of the values from all contributors during the time period represented by that data point.

  • Minimum – the minimum value from a single observation during the time period represented by that data point.

  • Maximum – the maximum value from a single observation during the time period represented by that data point.

  • Average – the average value from all contributors during the time period represented by that data point.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetInsightRuleReportCallable()

virtual Model::GetInsightRuleReportOutcomeCallable Aws::CloudWatch::CloudWatchClient::GetInsightRuleReportCallable ( const Model::GetInsightRuleReportRequest request) const
virtual

This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.

You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

  • UniqueContributors – the number of unique contributors for each data point.

  • MaxContributorValue – the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

    If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

  • SampleCount – the number of data points matched by the rule.

  • Sum – the sum of the values from all contributors during the time period represented by that data point.

  • Minimum – the minimum value from a single observation during the time period represented by that data point.

  • Maximum – the maximum value from a single observation during the time period represented by that data point.

  • Average – the average value from all contributors during the time period represented by that data point.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetMetricData()

virtual Model::GetMetricDataOutcome Aws::CloudWatch::CloudWatchClient::GetMetricData ( const Model::GetMetricDataRequest request) const
virtual

You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.

Amazon CloudWatch retains metric data as follows:

  • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

See Also:

AWS API Reference

◆ GetMetricDataAsync()

virtual void Aws::CloudWatch::CloudWatchClient::GetMetricDataAsync ( const Model::GetMetricDataRequest request,
const GetMetricDataResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.

Amazon CloudWatch retains metric data as follows:

  • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetMetricDataCallable()

virtual Model::GetMetricDataOutcomeCallable Aws::CloudWatch::CloudWatchClient::GetMetricDataCallable ( const Model::GetMetricDataRequest request) const
virtual

You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.

Amazon CloudWatch retains metric data as follows:

  • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetMetricStatistics()

virtual Model::GetMetricStatisticsOutcome Aws::CloudWatch::CloudWatchClient::GetMetricStatistics ( const Model::GetMetricStatisticsRequest request) const
virtual

Gets statistics for the specified metric.

The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.

CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.

CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

  • The SampleCount value of the statistic set is 1.

  • The Min and the Max values of the statistic set are equal.

Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Amazon CloudWatch retains metric data as follows:

  • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.

See Also:

AWS API Reference

◆ GetMetricStatisticsAsync()

virtual void Aws::CloudWatch::CloudWatchClient::GetMetricStatisticsAsync ( const Model::GetMetricStatisticsRequest request,
const GetMetricStatisticsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets statistics for the specified metric.

The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.

CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.

CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

  • The SampleCount value of the statistic set is 1.

  • The Min and the Max values of the statistic set are equal.

Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Amazon CloudWatch retains metric data as follows:

  • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetMetricStatisticsCallable()

virtual Model::GetMetricStatisticsOutcomeCallable Aws::CloudWatch::CloudWatchClient::GetMetricStatisticsCallable ( const Model::GetMetricStatisticsRequest request) const
virtual

Gets statistics for the specified metric.

The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.

CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.

CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

  • The SampleCount value of the statistic set is 1.

  • The Min and the Max values of the statistic set are equal.

Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Amazon CloudWatch retains metric data as follows:

  • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetMetricWidgetImage()

virtual Model::GetMetricWidgetImageOutcome Aws::CloudWatch::CloudWatchClient::GetMetricWidgetImage ( const Model::GetMetricWidgetImageRequest request) const
virtual

You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.

The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.

There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

  • As many as 100 metrics in the graph.

  • Up to 100 KB uncompressed payload.

See Also:

AWS API Reference

◆ GetMetricWidgetImageAsync()

virtual void Aws::CloudWatch::CloudWatchClient::GetMetricWidgetImageAsync ( const Model::GetMetricWidgetImageRequest request,
const GetMetricWidgetImageResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.

The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.

There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

  • As many as 100 metrics in the graph.

  • Up to 100 KB uncompressed payload.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetMetricWidgetImageCallable()

virtual Model::GetMetricWidgetImageOutcomeCallable Aws::CloudWatch::CloudWatchClient::GetMetricWidgetImageCallable ( const Model::GetMetricWidgetImageRequest request) const
virtual

You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.

The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.

There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

  • As many as 100 metrics in the graph.

  • Up to 100 KB uncompressed payload.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListDashboards()

virtual Model::ListDashboardsOutcome Aws::CloudWatch::CloudWatchClient::ListDashboards ( const Model::ListDashboardsRequest request) const
virtual

Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

See Also:

AWS API Reference

◆ ListDashboardsAsync()

virtual void Aws::CloudWatch::CloudWatchClient::ListDashboardsAsync ( const Model::ListDashboardsRequest request,
const ListDashboardsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListDashboardsCallable()

virtual Model::ListDashboardsOutcomeCallable Aws::CloudWatch::CloudWatchClient::ListDashboardsCallable ( const Model::ListDashboardsRequest request) const
virtual

Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListMetrics()

virtual Model::ListMetricsOutcome Aws::CloudWatch::CloudWatchClient::ListMetrics ( const Model::ListMetricsRequest request) const
virtual

List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics.

ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.

See Also:

AWS API Reference

◆ ListMetricsAsync()

virtual void Aws::CloudWatch::CloudWatchClient::ListMetricsAsync ( const Model::ListMetricsRequest request,
const ListMetricsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics.

ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListMetricsCallable()

virtual Model::ListMetricsOutcomeCallable Aws::CloudWatch::CloudWatchClient::ListMetricsCallable ( const Model::ListMetricsRequest request) const
virtual

List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics.

ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListTagsForResource()

virtual Model::ListTagsForResourceOutcome Aws::CloudWatch::CloudWatchClient::ListTagsForResource ( const Model::ListTagsForResourceRequest request) const
virtual

Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.

See Also:

AWS API Reference

◆ ListTagsForResourceAsync()

virtual void Aws::CloudWatch::CloudWatchClient::ListTagsForResourceAsync ( const Model::ListTagsForResourceRequest request,
const ListTagsForResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListTagsForResourceCallable()

virtual Model::ListTagsForResourceOutcomeCallable Aws::CloudWatch::CloudWatchClient::ListTagsForResourceCallable ( const Model::ListTagsForResourceRequest request) const
virtual

Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ OverrideEndpoint()

void Aws::CloudWatch::CloudWatchClient::OverrideEndpoint ( const Aws::String endpoint)

◆ PutAnomalyDetector()

virtual Model::PutAnomalyDetectorOutcome Aws::CloudWatch::CloudWatchClient::PutAnomalyDetector ( const Model::PutAnomalyDetectorRequest request) const
virtual

Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.

For more information, see CloudWatch Anomaly Detection.

See Also:

AWS API Reference

◆ PutAnomalyDetectorAsync()

virtual void Aws::CloudWatch::CloudWatchClient::PutAnomalyDetectorAsync ( const Model::PutAnomalyDetectorRequest request,
const PutAnomalyDetectorResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.

For more information, see CloudWatch Anomaly Detection.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ PutAnomalyDetectorCallable()

virtual Model::PutAnomalyDetectorOutcomeCallable Aws::CloudWatch::CloudWatchClient::PutAnomalyDetectorCallable ( const Model::PutAnomalyDetectorRequest request) const
virtual

Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.

For more information, see CloudWatch Anomaly Detection.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ PutCompositeAlarm()

virtual Model::PutCompositeAlarmOutcome Aws::CloudWatch::CloudWatchClient::PutCompositeAlarm ( const Model::PutCompositeAlarmRequest request) const
virtual

Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

See Also:

AWS API Reference

◆ PutCompositeAlarmAsync()

virtual void Aws::CloudWatch::CloudWatchClient::PutCompositeAlarmAsync ( const Model::PutCompositeAlarmRequest request,
const PutCompositeAlarmResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ PutCompositeAlarmCallable()

virtual Model::PutCompositeAlarmOutcomeCallable Aws::CloudWatch::CloudWatchClient::PutCompositeAlarmCallable ( const Model::PutCompositeAlarmRequest request) const
virtual

Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ PutDashboard()

virtual Model::PutDashboardOutcome Aws::CloudWatch::CloudWatchClient::PutDashboard ( const Model::PutDashboardRequest request) const
virtual

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

All dashboards in your account are global, not region-specific.

A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

See Also:

AWS API Reference

◆ PutDashboardAsync()

virtual void Aws::CloudWatch::CloudWatchClient::PutDashboardAsync ( const Model::PutDashboardRequest request,
const PutDashboardResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

All dashboards in your account are global, not region-specific.

A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ PutDashboardCallable()

virtual Model::PutDashboardOutcomeCallable Aws::CloudWatch::CloudWatchClient::PutDashboardCallable ( const Model::PutDashboardRequest request) const
virtual

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

All dashboards in your account are global, not region-specific.

A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ PutInsightRule()

virtual Model::PutInsightRuleOutcome Aws::CloudWatch::CloudWatchClient::PutInsightRule ( const Model::PutInsightRuleRequest request) const
virtual

Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data.

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

See Also:

AWS API Reference

◆ PutInsightRuleAsync()

virtual void Aws::CloudWatch::CloudWatchClient::PutInsightRuleAsync ( const Model::PutInsightRuleRequest request,
const PutInsightRuleResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data.

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ PutInsightRuleCallable()

virtual Model::PutInsightRuleOutcomeCallable Aws::CloudWatch::CloudWatchClient::PutInsightRuleCallable ( const Model::PutInsightRuleRequest request) const
virtual

Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data.

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ PutMetricAlarm()

virtual Model::PutMetricAlarmOutcome Aws::CloudWatch::CloudWatchClient::PutMetricAlarm ( const Model::PutMetricAlarmRequest request) const
virtual

Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

Alarms based on anomaly detection models cannot have Auto Scaling actions.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

  • iam:CreateServiceLinkedRole for all alarms with EC2 actions

  • ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance status metrics

  • ec2:StopInstances for alarms with stop actions

  • ec2:TerminateInstances for alarms with terminate actions

  • No specific permissions are needed for alarms with recover actions

If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.

If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.

If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.

The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked role is called AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role.

See Also:

AWS API Reference

◆ PutMetricAlarmAsync()

virtual void Aws::CloudWatch::CloudWatchClient::PutMetricAlarmAsync ( const Model::PutMetricAlarmRequest request,
const PutMetricAlarmResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

Alarms based on anomaly detection models cannot have Auto Scaling actions.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

  • iam:CreateServiceLinkedRole for all alarms with EC2 actions

  • ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance status metrics

  • ec2:StopInstances for alarms with stop actions

  • ec2:TerminateInstances for alarms with terminate actions

  • No specific permissions are needed for alarms with recover actions

If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.

If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.

If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.

The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked role is called AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ PutMetricAlarmCallable()

virtual Model::PutMetricAlarmOutcomeCallable Aws::CloudWatch::CloudWatchClient::PutMetricAlarmCallable ( const Model::PutMetricAlarmRequest request) const
virtual

Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

Alarms based on anomaly detection models cannot have Auto Scaling actions.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

  • iam:CreateServiceLinkedRole for all alarms with EC2 actions

  • ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance status metrics

  • ec2:StopInstances for alarms with stop actions

  • ec2:TerminateInstances for alarms with terminate actions

  • No specific permissions are needed for alarms with recover actions

If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.

If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.

If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.

The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked role is called AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ PutMetricData()

virtual Model::PutMetricDataOutcome Aws::CloudWatch::CloudWatchClient::PutMetricData ( const Model::PutMetricDataRequest request) const
virtual

Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.

You can publish either individual data points in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricDatum structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data.

Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics.

Although the Value parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData or GetMetricStatistics.

CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

  • The SampleCount value of the statistic set is 1 and Min, Max, and Sum are all equal.

  • The Min and Max are equal, and Sum is equal to Min multiplied by SampleCount.

See Also:

AWS API Reference

◆ PutMetricDataAsync()

virtual void Aws::CloudWatch::CloudWatchClient::PutMetricDataAsync ( const Model::PutMetricDataRequest request,
const PutMetricDataResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.

You can publish either individual data points in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricDatum structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data.

Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics.

Although the Value parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData or GetMetricStatistics.

CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

  • The SampleCount value of the statistic set is 1 and Min, Max, and Sum are all equal.

  • The Min and Max are equal, and Sum is equal to Min multiplied by SampleCount.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ PutMetricDataCallable()

virtual Model::PutMetricDataOutcomeCallable Aws::CloudWatch::CloudWatchClient::PutMetricDataCallable ( const Model::PutMetricDataRequest request) const
virtual

Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.

You can publish either individual data points in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricDatum structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data.

Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics.

Although the Value parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData or GetMetricStatistics.

CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

  • The SampleCount value of the statistic set is 1 and Min, Max, and Sum are all equal.

  • The Min and Max are equal, and Sum is equal to Min multiplied by SampleCount.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ SetAlarmState()

virtual Model::SetAlarmStateOutcome Aws::CloudWatch::CloudWatchClient::SetAlarmState ( const Model::SetAlarmStateRequest request) const
virtual

Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message.

Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return to its actual state. It returns to its actual state only once any of its children alarms change state. It is also reevaluated if you update its configuration.

If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information in the StateReasonData parameter to enable the policy to take the correct action.

See Also:

AWS API Reference

◆ SetAlarmStateAsync()

virtual void Aws::CloudWatch::CloudWatchClient::SetAlarmStateAsync ( const Model::SetAlarmStateRequest request,
const SetAlarmStateResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message.

Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return to its actual state. It returns to its actual state only once any of its children alarms change state. It is also reevaluated if you update its configuration.

If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information in the StateReasonData parameter to enable the policy to take the correct action.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ SetAlarmStateCallable()

virtual Model::SetAlarmStateOutcomeCallable Aws::CloudWatch::CloudWatchClient::SetAlarmStateCallable ( const Model::SetAlarmStateRequest request) const
virtual

Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message.

Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return to its actual state. It returns to its actual state only once any of its children alarms change state. It is also reevaluated if you update its configuration.

If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information in the StateReasonData parameter to enable the policy to take the correct action.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ TagResource()

virtual Model::TagResourceOutcome Aws::CloudWatch::CloudWatchClient::TagResource ( const Model::TagResourceRequest request) const
virtual

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a CloudWatch resource.

See Also:

AWS API Reference

◆ TagResourceAsync()

virtual void Aws::CloudWatch::CloudWatchClient::TagResourceAsync ( const Model::TagResourceRequest request,
const TagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a CloudWatch resource.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ TagResourceCallable()

virtual Model::TagResourceOutcomeCallable Aws::CloudWatch::CloudWatchClient::TagResourceCallable ( const Model::TagResourceRequest request) const
virtual

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a CloudWatch resource.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UntagResource()

virtual Model::UntagResourceOutcome Aws::CloudWatch::CloudWatchClient::UntagResource ( const Model::UntagResourceRequest request) const
virtual

Removes one or more tags from the specified resource.

See Also:

AWS API Reference

◆ UntagResourceAsync()

virtual void Aws::CloudWatch::CloudWatchClient::UntagResourceAsync ( const Model::UntagResourceRequest request,
const UntagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Removes one or more tags from the specified resource.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UntagResourceCallable()

virtual Model::UntagResourceOutcomeCallable Aws::CloudWatch::CloudWatchClient::UntagResourceCallable ( const Model::UntagResourceRequest request) const
virtual

Removes one or more tags from the specified resource.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.


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