/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the monitoring-2010-08-01.normal.json service model.
*/
using System;
using System.Runtime.ExceptionServices;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using System.Net;
using Amazon.CloudWatch.Model;
using Amazon.CloudWatch.Model.Internal.MarshallTransformations;
using Amazon.CloudWatch.Internal;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Internal.Auth;
using Amazon.Runtime.Internal.Transform;
namespace Amazon.CloudWatch
{
///
/// Implementation for accessing CloudWatch
///
/// Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources
/// and the applications you run on Amazon Web Services 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 Amazon Web Services,
/// you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility
/// into resource utilization, application performance, and operational health.
///
///
public partial class AmazonCloudWatchClient : AmazonServiceClient, IAmazonCloudWatch
{
private static IServiceMetadata serviceMetadata = new AmazonCloudWatchMetadata();
private ICloudWatchPaginatorFactory _paginators;
///
/// Paginators for the service
///
public ICloudWatchPaginatorFactory Paginators
{
get
{
if (this._paginators == null)
{
this._paginators = new CloudWatchPaginatorFactory(this);
}
return this._paginators;
}
}
#region Constructors
///
/// Constructs AmazonCloudWatchClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
public AmazonCloudWatchClient()
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonCloudWatchConfig()) { }
///
/// Constructs AmazonCloudWatchClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The region to connect.
public AmazonCloudWatchClient(RegionEndpoint region)
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonCloudWatchConfig{RegionEndpoint = region}) { }
///
/// Constructs AmazonCloudWatchClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The AmazonCloudWatchClient Configuration Object
public AmazonCloudWatchClient(AmazonCloudWatchConfig config)
: base(FallbackCredentialsFactory.GetCredentials(config), config){}
///
/// Constructs AmazonCloudWatchClient with AWS Credentials
///
/// AWS Credentials
public AmazonCloudWatchClient(AWSCredentials credentials)
: this(credentials, new AmazonCloudWatchConfig())
{
}
///
/// Constructs AmazonCloudWatchClient with AWS Credentials
///
/// AWS Credentials
/// The region to connect.
public AmazonCloudWatchClient(AWSCredentials credentials, RegionEndpoint region)
: this(credentials, new AmazonCloudWatchConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonCloudWatchClient with AWS Credentials and an
/// AmazonCloudWatchClient Configuration object.
///
/// AWS Credentials
/// The AmazonCloudWatchClient Configuration Object
public AmazonCloudWatchClient(AWSCredentials credentials, AmazonCloudWatchConfig clientConfig)
: base(credentials, clientConfig)
{
}
///
/// Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
public AmazonCloudWatchClient(string awsAccessKeyId, string awsSecretAccessKey)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonCloudWatchConfig())
{
}
///
/// Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The region to connect.
public AmazonCloudWatchClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonCloudWatchConfig() {RegionEndpoint=region})
{
}
///
/// Constructs AmazonCloudWatchClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonCloudWatchClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The AmazonCloudWatchClient Configuration Object
public AmazonCloudWatchClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonCloudWatchConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, clientConfig)
{
}
///
/// Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
public AmazonCloudWatchClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonCloudWatchConfig())
{
}
///
/// Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The region to connect.
public AmazonCloudWatchClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonCloudWatchConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonCloudWatchClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonCloudWatchClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The AmazonCloudWatchClient Configuration Object
public AmazonCloudWatchClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonCloudWatchConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, clientConfig)
{
}
#endregion
#region Overrides
///
/// Creates the signer for the service.
///
protected override AbstractAWSSigner CreateSigner()
{
return new AWS4Signer();
}
///
/// Customize the pipeline
///
///
protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)
{
pipeline.RemoveHandler();
pipeline.AddHandlerAfter(new AmazonCloudWatchEndpointResolver());
}
///
/// Capture metadata for the service.
///
protected override IServiceMetadata ServiceMetadata
{
get
{
return serviceMetadata;
}
}
#endregion
#region Dispose
///
/// Disposes the service client.
///
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
}
#endregion
#region DeleteAlarms
///
/// 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.
///
///
///
/// If you specify an incorrect alarm name or make any other error in the operation,
/// no alarms are deleted. To confirm that alarms were deleted successfully, you can use
/// the DescribeAlarms
/// operation after using DeleteAlarms
.
///
///
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the DeleteAlarms service method.
///
/// The response from the DeleteAlarms service method, as returned by CloudWatch.
///
/// The named resource does not exist.
///
/// REST API Reference for DeleteAlarms Operation
public virtual DeleteAlarmsResponse DeleteAlarms(DeleteAlarmsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteAlarmsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteAlarmsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
///
/// If you specify an incorrect alarm name or make any other error in the operation,
/// no alarms are deleted. To confirm that alarms were deleted successfully, you can use
/// the DescribeAlarms
/// operation after using DeleteAlarms
.
///
///
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the DeleteAlarms service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteAlarms service method, as returned by CloudWatch.
///
/// The named resource does not exist.
///
/// REST API Reference for DeleteAlarms Operation
public virtual Task DeleteAlarmsAsync(DeleteAlarmsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteAlarmsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteAlarmsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteAnomalyDetector
///
/// Deletes the specified anomaly detection model from your account. For more information
/// about how to delete an anomaly detection model, see Deleting
/// an anomaly detection model in the CloudWatch User Guide.
///
/// Container for the necessary parameters to execute the DeleteAnomalyDetector service method.
///
/// The response from the DeleteAnomalyDetector service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// Parameters were used together that cannot be used together.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
///
/// The named resource does not exist.
///
/// REST API Reference for DeleteAnomalyDetector Operation
public virtual DeleteAnomalyDetectorResponse DeleteAnomalyDetector(DeleteAnomalyDetectorRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteAnomalyDetectorRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteAnomalyDetectorResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes the specified anomaly detection model from your account. For more information
/// about how to delete an anomaly detection model, see Deleting
/// an anomaly detection model in the CloudWatch User Guide.
///
/// Container for the necessary parameters to execute the DeleteAnomalyDetector service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteAnomalyDetector service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// Parameters were used together that cannot be used together.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
///
/// The named resource does not exist.
///
/// REST API Reference for DeleteAnomalyDetector Operation
public virtual Task DeleteAnomalyDetectorAsync(DeleteAnomalyDetectorRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteAnomalyDetectorRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteAnomalyDetectorResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteDashboards
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteDashboards service method.
///
/// The response from the DeleteDashboards service method, as returned by CloudWatch.
///
/// The specified dashboard does not exist.
///
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
/// REST API Reference for DeleteDashboards Operation
public virtual DeleteDashboardsResponse DeleteDashboards(DeleteDashboardsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteDashboardsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteDashboardsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteDashboards service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteDashboards service method, as returned by CloudWatch.
///
/// The specified dashboard does not exist.
///
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
/// REST API Reference for DeleteDashboards Operation
public virtual Task DeleteDashboardsAsync(DeleteDashboardsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteDashboardsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteDashboardsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteInsightRules
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DeleteInsightRules service method.
///
/// The response from the DeleteInsightRules service method, as returned by CloudWatch.
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for DeleteInsightRules Operation
public virtual DeleteInsightRulesResponse DeleteInsightRules(DeleteInsightRulesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteInsightRulesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteInsightRulesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DeleteInsightRules service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteInsightRules service method, as returned by CloudWatch.
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for DeleteInsightRules Operation
public virtual Task DeleteInsightRulesAsync(DeleteInsightRulesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteInsightRulesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteInsightRulesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteMetricStream
///
/// Permanently deletes the metric stream that you specify.
///
/// Container for the necessary parameters to execute the DeleteMetricStream service method.
///
/// The response from the DeleteMetricStream service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for DeleteMetricStream Operation
public virtual DeleteMetricStreamResponse DeleteMetricStream(DeleteMetricStreamRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteMetricStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteMetricStreamResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Permanently deletes the metric stream that you specify.
///
/// Container for the necessary parameters to execute the DeleteMetricStream service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteMetricStream service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for DeleteMetricStream Operation
public virtual Task DeleteMetricStreamAsync(DeleteMetricStreamRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteMetricStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteMetricStreamResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeAlarmHistory
///
/// 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.
///
///
///
/// To use this operation and return information about a composite alarm, you must be
/// signed on with the cloudwatch:DescribeAlarmHistory
permission that is
/// scoped to *
. You can't return information about composite alarms if your
/// cloudwatch:DescribeAlarmHistory
permission has a narrower scope.
///
///
///
/// The response from the DescribeAlarmHistory service method, as returned by CloudWatch.
///
/// The next token specified is invalid.
///
/// REST API Reference for DescribeAlarmHistory Operation
public virtual DescribeAlarmHistoryResponse DescribeAlarmHistory()
{
return DescribeAlarmHistory(new DescribeAlarmHistoryRequest());
}
///
/// 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.
///
///
///
/// To use this operation and return information about a composite alarm, you must be
/// signed on with the cloudwatch:DescribeAlarmHistory
permission that is
/// scoped to *
. You can't return information about composite alarms if your
/// cloudwatch:DescribeAlarmHistory
permission has a narrower scope.
///
///
/// Container for the necessary parameters to execute the DescribeAlarmHistory service method.
///
/// The response from the DescribeAlarmHistory service method, as returned by CloudWatch.
///
/// The next token specified is invalid.
///
/// REST API Reference for DescribeAlarmHistory Operation
public virtual DescribeAlarmHistoryResponse DescribeAlarmHistory(DescribeAlarmHistoryRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeAlarmHistoryRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeAlarmHistoryResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
///
/// To use this operation and return information about a composite alarm, you must be
/// signed on with the cloudwatch:DescribeAlarmHistory
permission that is
/// scoped to *
. You can't return information about composite alarms if your
/// cloudwatch:DescribeAlarmHistory
permission has a narrower scope.
///
///
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeAlarmHistory service method, as returned by CloudWatch.
///
/// The next token specified is invalid.
///
/// REST API Reference for DescribeAlarmHistory Operation
public virtual Task DescribeAlarmHistoryAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
return DescribeAlarmHistoryAsync(new DescribeAlarmHistoryRequest(), cancellationToken);
}
///
/// 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.
///
///
///
/// To use this operation and return information about a composite alarm, you must be
/// signed on with the cloudwatch:DescribeAlarmHistory
permission that is
/// scoped to *
. You can't return information about composite alarms if your
/// cloudwatch:DescribeAlarmHistory
permission has a narrower scope.
///
///
/// Container for the necessary parameters to execute the DescribeAlarmHistory service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeAlarmHistory service method, as returned by CloudWatch.
///
/// The next token specified is invalid.
///
/// REST API Reference for DescribeAlarmHistory Operation
public virtual Task DescribeAlarmHistoryAsync(DescribeAlarmHistoryRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeAlarmHistoryRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeAlarmHistoryResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeAlarms
///
/// Retrieves the specified alarms. You can filter the results by specifying a prefix
/// for the alarm name, the alarm state, or a prefix for any action.
///
///
///
/// To use this operation and return information about composite alarms, you must be signed
/// on with the cloudwatch:DescribeAlarms
permission that is scoped to *
.
/// You can't return information about composite alarms if your cloudwatch:DescribeAlarms
/// permission has a narrower scope.
///
///
///
/// The response from the DescribeAlarms service method, as returned by CloudWatch.
///
/// The next token specified is invalid.
///
/// REST API Reference for DescribeAlarms Operation
public virtual DescribeAlarmsResponse DescribeAlarms()
{
return DescribeAlarms(new DescribeAlarmsRequest());
}
///
/// Retrieves the specified alarms. You can filter the results by specifying a prefix
/// for the alarm name, the alarm state, or a prefix for any action.
///
///
///
/// To use this operation and return information about composite alarms, you must be signed
/// on with the cloudwatch:DescribeAlarms
permission that is scoped to *
.
/// You can't return information about composite alarms if your cloudwatch:DescribeAlarms
/// permission has a narrower scope.
///
///
/// Container for the necessary parameters to execute the DescribeAlarms service method.
///
/// The response from the DescribeAlarms service method, as returned by CloudWatch.
///
/// The next token specified is invalid.
///
/// REST API Reference for DescribeAlarms Operation
public virtual DescribeAlarmsResponse DescribeAlarms(DescribeAlarmsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeAlarmsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeAlarmsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Retrieves the specified alarms. You can filter the results by specifying a prefix
/// for the alarm name, the alarm state, or a prefix for any action.
///
///
///
/// To use this operation and return information about composite alarms, you must be signed
/// on with the cloudwatch:DescribeAlarms
permission that is scoped to *
.
/// You can't return information about composite alarms if your cloudwatch:DescribeAlarms
/// permission has a narrower scope.
///
///
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeAlarms service method, as returned by CloudWatch.
///
/// The next token specified is invalid.
///
/// REST API Reference for DescribeAlarms Operation
public virtual Task DescribeAlarmsAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
return DescribeAlarmsAsync(new DescribeAlarmsRequest(), cancellationToken);
}
///
/// Retrieves the specified alarms. You can filter the results by specifying a prefix
/// for the alarm name, the alarm state, or a prefix for any action.
///
///
///
/// To use this operation and return information about composite alarms, you must be signed
/// on with the cloudwatch:DescribeAlarms
permission that is scoped to *
.
/// You can't return information about composite alarms if your cloudwatch:DescribeAlarms
/// permission has a narrower scope.
///
///
/// Container for the necessary parameters to execute the DescribeAlarms service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeAlarms service method, as returned by CloudWatch.
///
/// The next token specified is invalid.
///
/// REST API Reference for DescribeAlarms Operation
public virtual Task DescribeAlarmsAsync(DescribeAlarmsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeAlarmsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeAlarmsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeAlarmsForMetric
///
/// Retrieves the alarms for the specified metric. To filter the results, specify a statistic,
/// period, or unit.
///
///
///
/// This operation retrieves only standard alarms that are based on the specified metric.
/// It does not return alarms based on math expressions that use the specified metric,
/// or composite alarms that use the specified metric.
///
///
/// Container for the necessary parameters to execute the DescribeAlarmsForMetric service method.
///
/// The response from the DescribeAlarmsForMetric service method, as returned by CloudWatch.
/// REST API Reference for DescribeAlarmsForMetric Operation
public virtual DescribeAlarmsForMetricResponse DescribeAlarmsForMetric(DescribeAlarmsForMetricRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeAlarmsForMetricRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeAlarmsForMetricResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Retrieves the alarms for the specified metric. To filter the results, specify a statistic,
/// period, or unit.
///
///
///
/// This operation retrieves only standard alarms that are based on the specified metric.
/// It does not return alarms based on math expressions that use the specified metric,
/// or composite alarms that use the specified metric.
///
///
/// Container for the necessary parameters to execute the DescribeAlarmsForMetric service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeAlarmsForMetric service method, as returned by CloudWatch.
/// REST API Reference for DescribeAlarmsForMetric Operation
public virtual Task DescribeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeAlarmsForMetricRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeAlarmsForMetricResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeAnomalyDetectors
///
/// Lists the anomaly detection models that you have created in your account. For single
/// metric anomaly detectors, you can list all of the models in your account or filter
/// the results to only the models that are related to a certain namespace, metric name,
/// or metric dimension. For metric math anomaly detectors, you can list them by adding
/// METRIC_MATH
to the AnomalyDetectorTypes
array. This will
/// return all metric math anomaly detectors in your account.
///
/// Container for the necessary parameters to execute the DescribeAnomalyDetectors service method.
///
/// The response from the DescribeAnomalyDetectors service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The next token specified is invalid.
///
///
/// Parameters were used together that cannot be used together.
///
///
/// The value of an input parameter is bad or out-of-range.
///
/// REST API Reference for DescribeAnomalyDetectors Operation
public virtual DescribeAnomalyDetectorsResponse DescribeAnomalyDetectors(DescribeAnomalyDetectorsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeAnomalyDetectorsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeAnomalyDetectorsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Lists the anomaly detection models that you have created in your account. For single
/// metric anomaly detectors, you can list all of the models in your account or filter
/// the results to only the models that are related to a certain namespace, metric name,
/// or metric dimension. For metric math anomaly detectors, you can list them by adding
/// METRIC_MATH
to the AnomalyDetectorTypes
array. This will
/// return all metric math anomaly detectors in your account.
///
/// Container for the necessary parameters to execute the DescribeAnomalyDetectors service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeAnomalyDetectors service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The next token specified is invalid.
///
///
/// Parameters were used together that cannot be used together.
///
///
/// The value of an input parameter is bad or out-of-range.
///
/// REST API Reference for DescribeAnomalyDetectors Operation
public virtual Task DescribeAnomalyDetectorsAsync(DescribeAnomalyDetectorsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeAnomalyDetectorsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeAnomalyDetectorsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeInsightRules
///
/// Returns a list of all the Contributor Insights rules in your account.
///
///
///
/// For more information about Contributor Insights, see Using
/// Contributor Insights to Analyze High-Cardinality Data.
///
///
/// Container for the necessary parameters to execute the DescribeInsightRules service method.
///
/// The response from the DescribeInsightRules service method, as returned by CloudWatch.
///
/// The next token specified is invalid.
///
/// REST API Reference for DescribeInsightRules Operation
public virtual DescribeInsightRulesResponse DescribeInsightRules(DescribeInsightRulesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeInsightRulesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeInsightRulesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns a list of all the Contributor Insights rules in your account.
///
///
///
/// For more information about Contributor Insights, see Using
/// Contributor Insights to Analyze High-Cardinality Data.
///
///
/// Container for the necessary parameters to execute the DescribeInsightRules service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeInsightRules service method, as returned by CloudWatch.
///
/// The next token specified is invalid.
///
/// REST API Reference for DescribeInsightRules Operation
public virtual Task DescribeInsightRulesAsync(DescribeInsightRulesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeInsightRulesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeInsightRulesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DisableAlarmActions
///
/// 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.
///
/// Container for the necessary parameters to execute the DisableAlarmActions service method.
///
/// The response from the DisableAlarmActions service method, as returned by CloudWatch.
/// REST API Reference for DisableAlarmActions Operation
public virtual DisableAlarmActionsResponse DisableAlarmActions(DisableAlarmActionsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DisableAlarmActionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DisableAlarmActionsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
/// Container for the necessary parameters to execute the DisableAlarmActions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DisableAlarmActions service method, as returned by CloudWatch.
/// REST API Reference for DisableAlarmActions Operation
public virtual Task DisableAlarmActionsAsync(DisableAlarmActionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DisableAlarmActionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DisableAlarmActionsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DisableInsightRules
///
/// Disables the specified Contributor Insights rules. When rules are disabled, they do
/// not analyze log groups and do not incur costs.
///
/// Container for the necessary parameters to execute the DisableInsightRules service method.
///
/// The response from the DisableInsightRules service method, as returned by CloudWatch.
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for DisableInsightRules Operation
public virtual DisableInsightRulesResponse DisableInsightRules(DisableInsightRulesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DisableInsightRulesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DisableInsightRulesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Disables the specified Contributor Insights rules. When rules are disabled, they do
/// not analyze log groups and do not incur costs.
///
/// Container for the necessary parameters to execute the DisableInsightRules service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DisableInsightRules service method, as returned by CloudWatch.
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for DisableInsightRules Operation
public virtual Task DisableInsightRulesAsync(DisableInsightRulesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DisableInsightRulesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DisableInsightRulesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region EnableAlarmActions
///
/// Enables the actions for the specified alarms.
///
/// Container for the necessary parameters to execute the EnableAlarmActions service method.
///
/// The response from the EnableAlarmActions service method, as returned by CloudWatch.
/// REST API Reference for EnableAlarmActions Operation
public virtual EnableAlarmActionsResponse EnableAlarmActions(EnableAlarmActionsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = EnableAlarmActionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = EnableAlarmActionsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Enables the actions for the specified alarms.
///
/// Container for the necessary parameters to execute the EnableAlarmActions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the EnableAlarmActions service method, as returned by CloudWatch.
/// REST API Reference for EnableAlarmActions Operation
public virtual Task EnableAlarmActionsAsync(EnableAlarmActionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = EnableAlarmActionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = EnableAlarmActionsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region EnableInsightRules
///
/// Enables the specified Contributor Insights rules. When rules are enabled, they immediately
/// begin analyzing log data.
///
/// Container for the necessary parameters to execute the EnableInsightRules service method.
///
/// The response from the EnableInsightRules service method, as returned by CloudWatch.
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// The operation exceeded one or more limits.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for EnableInsightRules Operation
public virtual EnableInsightRulesResponse EnableInsightRules(EnableInsightRulesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = EnableInsightRulesRequestMarshaller.Instance;
options.ResponseUnmarshaller = EnableInsightRulesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Enables the specified Contributor Insights rules. When rules are enabled, they immediately
/// begin analyzing log data.
///
/// Container for the necessary parameters to execute the EnableInsightRules service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the EnableInsightRules service method, as returned by CloudWatch.
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// The operation exceeded one or more limits.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for EnableInsightRules Operation
public virtual Task EnableInsightRulesAsync(EnableInsightRulesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = EnableInsightRulesRequestMarshaller.Instance;
options.ResponseUnmarshaller = EnableInsightRulesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetDashboard
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetDashboard service method.
///
/// The response from the GetDashboard service method, as returned by CloudWatch.
///
/// The specified dashboard does not exist.
///
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
/// REST API Reference for GetDashboard Operation
public virtual GetDashboardResponse GetDashboard(GetDashboardRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetDashboardRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetDashboardResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetDashboard service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetDashboard service method, as returned by CloudWatch.
///
/// The specified dashboard does not exist.
///
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
/// REST API Reference for GetDashboard Operation
public virtual Task GetDashboardAsync(GetDashboardRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetDashboardRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetDashboardResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetInsightRuleReport
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the GetInsightRuleReport service method.
///
/// The response from the GetInsightRuleReport service method, as returned by CloudWatch.
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
///
/// The named resource does not exist.
///
/// REST API Reference for GetInsightRuleReport Operation
public virtual GetInsightRuleReportResponse GetInsightRuleReport(GetInsightRuleReportRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetInsightRuleReportRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetInsightRuleReportResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the GetInsightRuleReport service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetInsightRuleReport service method, as returned by CloudWatch.
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
///
/// The named resource does not exist.
///
/// REST API Reference for GetInsightRuleReport Operation
public virtual Task GetInsightRuleReportAsync(GetInsightRuleReportRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetInsightRuleReportRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetInsightRuleReportResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetMetricData
///
/// You can use the GetMetricData
API to retrieve CloudWatch metric values.
/// The operation can also include a CloudWatch Metrics Insights query, and one or more
/// metric math functions.
///
///
///
/// A GetMetricData
operation that does not include a query can 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 metric 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.
///
///
///
/// If you include a Metrics Insights query, each GetMetricData
operation
/// can include only one query. But the same GetMetricData
operation can
/// also retrieve other metrics. Metrics Insights queries can query only the most recent
/// three hours of metric data. For more information about Metrics Insights, see Query
/// your metrics with CloudWatch Metrics Insights.
///
///
///
/// 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.
///
///
///
/// Using Metrics Insights queries with metric math
///
///
///
/// You can't mix a Metric Insights query and metric math syntax in the same expression,
/// but you can reference results from a Metrics Insights query within other Metric math
/// expressions. A Metrics Insights query without a GROUP BY clause returns a single
/// time-series (TS), and can be used as input for a metric math expression that expects
/// a single time series. A Metrics Insights query with a GROUP BY clause returns
/// an array of time-series (TS[]), and can be used as input for a metric math expression
/// that expects an array of time series.
///
///
/// Container for the necessary parameters to execute the GetMetricData service method.
///
/// The response from the GetMetricData service method, as returned by CloudWatch.
///
/// The next token specified is invalid.
///
/// REST API Reference for GetMetricData Operation
public virtual GetMetricDataResponse GetMetricData(GetMetricDataRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetMetricDataRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetMetricDataResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// You can use the GetMetricData
API to retrieve CloudWatch metric values.
/// The operation can also include a CloudWatch Metrics Insights query, and one or more
/// metric math functions.
///
///
///
/// A GetMetricData
operation that does not include a query can 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 metric 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.
///
///
///
/// If you include a Metrics Insights query, each GetMetricData
operation
/// can include only one query. But the same GetMetricData
operation can
/// also retrieve other metrics. Metrics Insights queries can query only the most recent
/// three hours of metric data. For more information about Metrics Insights, see Query
/// your metrics with CloudWatch Metrics Insights.
///
///
///
/// 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.
///
///
///
/// Using Metrics Insights queries with metric math
///
///
///
/// You can't mix a Metric Insights query and metric math syntax in the same expression,
/// but you can reference results from a Metrics Insights query within other Metric math
/// expressions. A Metrics Insights query without a GROUP BY clause returns a single
/// time-series (TS), and can be used as input for a metric math expression that expects
/// a single time series. A Metrics Insights query with a GROUP BY clause returns
/// an array of time-series (TS[]), and can be used as input for a metric math expression
/// that expects an array of time series.
///
///
/// Container for the necessary parameters to execute the GetMetricData service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetMetricData service method, as returned by CloudWatch.
///
/// The next token specified is invalid.
///
/// REST API Reference for GetMetricData Operation
public virtual Task GetMetricDataAsync(GetMetricDataRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetMetricDataRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetMetricDataResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetMetricStatistics
///
/// 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 Amazon Web Services services,
/// see the Amazon
/// CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
///
///
/// Container for the necessary parameters to execute the GetMetricStatistics service method.
///
/// The response from the GetMetricStatistics service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// Parameters were used together that cannot be used together.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for GetMetricStatistics Operation
public virtual GetMetricStatisticsResponse GetMetricStatistics(GetMetricStatisticsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetMetricStatisticsRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetMetricStatisticsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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 Amazon Web Services services,
/// see the Amazon
/// CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
///
///
/// Container for the necessary parameters to execute the GetMetricStatistics service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetMetricStatistics service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// Parameters were used together that cannot be used together.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for GetMetricStatistics Operation
public virtual Task GetMetricStatisticsAsync(GetMetricStatisticsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetMetricStatisticsRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetMetricStatisticsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetMetricStream
///
/// Returns information about the metric stream that you specify.
///
/// Container for the necessary parameters to execute the GetMetricStream service method.
///
/// The response from the GetMetricStream service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// Parameters were used together that cannot be used together.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
///
/// The named resource does not exist.
///
/// REST API Reference for GetMetricStream Operation
public virtual GetMetricStreamResponse GetMetricStream(GetMetricStreamRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetMetricStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetMetricStreamResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns information about the metric stream that you specify.
///
/// Container for the necessary parameters to execute the GetMetricStream service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetMetricStream service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// Parameters were used together that cannot be used together.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
///
/// The named resource does not exist.
///
/// REST API Reference for GetMetricStream Operation
public virtual Task GetMetricStreamAsync(GetMetricStreamRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetMetricStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetMetricStreamResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetMetricWidgetImage
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the GetMetricWidgetImage service method.
///
/// The response from the GetMetricWidgetImage service method, as returned by CloudWatch.
/// REST API Reference for GetMetricWidgetImage Operation
public virtual GetMetricWidgetImageResponse GetMetricWidgetImage(GetMetricWidgetImageRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetMetricWidgetImageRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetMetricWidgetImageResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the GetMetricWidgetImage service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetMetricWidgetImage service method, as returned by CloudWatch.
/// REST API Reference for GetMetricWidgetImage Operation
public virtual Task GetMetricWidgetImageAsync(GetMetricWidgetImageRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetMetricWidgetImageRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetMetricWidgetImageResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListDashboards
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListDashboards service method.
///
/// The response from the ListDashboards service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
/// REST API Reference for ListDashboards Operation
public virtual ListDashboardsResponse ListDashboards(ListDashboardsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListDashboardsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListDashboardsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListDashboards service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListDashboards service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
/// REST API Reference for ListDashboards Operation
public virtual Task ListDashboardsAsync(ListDashboardsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListDashboardsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListDashboardsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListManagedInsightRules
///
/// Returns a list that contains the number of managed Contributor Insights rules in
/// your account.
///
/// Container for the necessary parameters to execute the ListManagedInsightRules service method.
///
/// The response from the ListManagedInsightRules service method, as returned by CloudWatch.
///
/// The next token specified is invalid.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for ListManagedInsightRules Operation
public virtual ListManagedInsightRulesResponse ListManagedInsightRules(ListManagedInsightRulesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListManagedInsightRulesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListManagedInsightRulesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns a list that contains the number of managed Contributor Insights rules in
/// your account.
///
/// Container for the necessary parameters to execute the ListManagedInsightRules service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListManagedInsightRules service method, as returned by CloudWatch.
///
/// The next token specified is invalid.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for ListManagedInsightRules Operation
public virtual Task ListManagedInsightRulesAsync(ListManagedInsightRulesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListManagedInsightRulesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListManagedInsightRulesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListMetrics
///
/// List the specified metrics. You can use the returned metrics with GetMetricData
/// or GetMetricStatistics
/// to get 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 for the metric to appear. To see
/// metric statistics sooner, use GetMetricData
/// or GetMetricStatistics.
///
///
///
/// If you are using CloudWatch cross-account observability, you can use this operation
/// in a monitoring account and view metrics from the linked source accounts. For more
/// information, see CloudWatch
/// cross-account observability.
///
///
///
/// 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.
///
///
///
/// The response from the ListMetrics service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
/// REST API Reference for ListMetrics Operation
public virtual ListMetricsResponse ListMetrics()
{
return ListMetrics(new ListMetricsRequest());
}
///
/// List the specified metrics. You can use the returned metrics with GetMetricData
/// or GetMetricStatistics
/// to get 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 for the metric to appear. To see
/// metric statistics sooner, use GetMetricData
/// or GetMetricStatistics.
///
///
///
/// If you are using CloudWatch cross-account observability, you can use this operation
/// in a monitoring account and view metrics from the linked source accounts. For more
/// information, see CloudWatch
/// cross-account observability.
///
///
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListMetrics service method.
///
/// The response from the ListMetrics service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
/// REST API Reference for ListMetrics Operation
public virtual ListMetricsResponse ListMetrics(ListMetricsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListMetricsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListMetricsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// List the specified metrics. You can use the returned metrics with GetMetricData
/// or GetMetricStatistics
/// to get 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 for the metric to appear. To see
/// metric statistics sooner, use GetMetricData
/// or GetMetricStatistics.
///
///
///
/// If you are using CloudWatch cross-account observability, you can use this operation
/// in a monitoring account and view metrics from the linked source accounts. For more
/// information, see CloudWatch
/// cross-account observability.
///
///
///
/// 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.
///
///
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListMetrics service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
/// REST API Reference for ListMetrics Operation
public virtual Task ListMetricsAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
return ListMetricsAsync(new ListMetricsRequest(), cancellationToken);
}
///
/// List the specified metrics. You can use the returned metrics with GetMetricData
/// or GetMetricStatistics
/// to get 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 for the metric to appear. To see
/// metric statistics sooner, use GetMetricData
/// or GetMetricStatistics.
///
///
///
/// If you are using CloudWatch cross-account observability, you can use this operation
/// in a monitoring account and view metrics from the linked source accounts. For more
/// information, see CloudWatch
/// cross-account observability.
///
///
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListMetrics service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListMetrics service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
/// REST API Reference for ListMetrics Operation
public virtual Task ListMetricsAsync(ListMetricsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListMetricsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListMetricsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListMetricStreams
///
/// Returns a list of metric streams in this account.
///
/// Container for the necessary parameters to execute the ListMetricStreams service method.
///
/// The response from the ListMetricStreams service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The next token specified is invalid.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for ListMetricStreams Operation
public virtual ListMetricStreamsResponse ListMetricStreams(ListMetricStreamsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListMetricStreamsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListMetricStreamsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns a list of metric streams in this account.
///
/// Container for the necessary parameters to execute the ListMetricStreams service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListMetricStreams service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The next token specified is invalid.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for ListMetricStreams Operation
public virtual Task ListMetricStreamsAsync(ListMetricStreamsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListMetricStreamsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListMetricStreamsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListTagsForResource
///
/// Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor
/// Insights rules support tagging.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// The named resource does not exist.
///
/// REST API Reference for ListTagsForResource Operation
public virtual ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor
/// Insights rules support tagging.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// The named resource does not exist.
///
/// REST API Reference for ListTagsForResource Operation
public virtual Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutAnomalyDetector
///
/// 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.
///
///
/// Container for the necessary parameters to execute the PutAnomalyDetector service method.
///
/// The response from the PutAnomalyDetector service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// Parameters were used together that cannot be used together.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// The operation exceeded one or more limits.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for PutAnomalyDetector Operation
public virtual PutAnomalyDetectorResponse PutAnomalyDetector(PutAnomalyDetectorRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutAnomalyDetectorRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutAnomalyDetectorResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the PutAnomalyDetector service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutAnomalyDetector service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// Parameters were used together that cannot be used together.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// The operation exceeded one or more limits.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for PutAnomalyDetector Operation
public virtual Task PutAnomalyDetectorAsync(PutAnomalyDetectorRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutAnomalyDetectorRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutAnomalyDetectorResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutCompositeAlarm
///
/// 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. The rule expression of a composite alarm can include as
/// many as 100 underlying alarms. Any single alarm can be included in the rule expressions
/// of as many as 150 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.
///
///
///
/// To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm
/// permission that is scoped to *
. You can't create a composite alarms if
/// your cloudwatch:PutCompositeAlarm
permission has a narrower scope.
///
///
///
/// If you are an IAM user, you must have iam:CreateServiceLinkedRole
to
/// create a composite alarm that has Systems Manager OpsItem actions.
///
///
/// Container for the necessary parameters to execute the PutCompositeAlarm service method.
///
/// The response from the PutCompositeAlarm service method, as returned by CloudWatch.
///
/// The quota for alarms for this customer has already been reached.
///
/// REST API Reference for PutCompositeAlarm Operation
public virtual PutCompositeAlarmResponse PutCompositeAlarm(PutCompositeAlarmRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutCompositeAlarmRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutCompositeAlarmResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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. The rule expression of a composite alarm can include as
/// many as 100 underlying alarms. Any single alarm can be included in the rule expressions
/// of as many as 150 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.
///
///
///
/// To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm
/// permission that is scoped to *
. You can't create a composite alarms if
/// your cloudwatch:PutCompositeAlarm
permission has a narrower scope.
///
///
///
/// If you are an IAM user, you must have iam:CreateServiceLinkedRole
to
/// create a composite alarm that has Systems Manager OpsItem actions.
///
///
/// Container for the necessary parameters to execute the PutCompositeAlarm service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutCompositeAlarm service method, as returned by CloudWatch.
///
/// The quota for alarms for this customer has already been reached.
///
/// REST API Reference for PutCompositeAlarm Operation
public virtual Task PutCompositeAlarmAsync(PutCompositeAlarmRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutCompositeAlarmRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutCompositeAlarmResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutDashboard
///
/// 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.
///
///
/// Container for the necessary parameters to execute the PutDashboard service method.
///
/// The response from the PutDashboard service method, as returned by CloudWatch.
///
/// Some part of the dashboard data is invalid.
///
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
/// REST API Reference for PutDashboard Operation
public virtual PutDashboardResponse PutDashboard(PutDashboardRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutDashboardRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutDashboardResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the PutDashboard service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutDashboard service method, as returned by CloudWatch.
///
/// Some part of the dashboard data is invalid.
///
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
/// REST API Reference for PutDashboard Operation
public virtual Task PutDashboardAsync(PutDashboardRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutDashboardRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutDashboardResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutInsightRule
///
/// 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.
///
///
/// Container for the necessary parameters to execute the PutInsightRule service method.
///
/// The response from the PutInsightRule service method, as returned by CloudWatch.
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// The operation exceeded one or more limits.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for PutInsightRule Operation
public virtual PutInsightRuleResponse PutInsightRule(PutInsightRuleRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutInsightRuleRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutInsightRuleResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the PutInsightRule service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutInsightRule service method, as returned by CloudWatch.
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// The operation exceeded one or more limits.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for PutInsightRule Operation
public virtual Task PutInsightRuleAsync(PutInsightRuleRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutInsightRuleRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutInsightRuleResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutManagedInsightRules
///
/// Creates a managed Contributor Insights rule for a specified Amazon Web Services resource.
/// When you enable a managed rule, you create a Contributor Insights rule that collects
/// data from Amazon Web Services services. You cannot edit these rules with PutInsightRule
.
/// The rules can be enabled, disabled, and deleted using EnableInsightRules
,
/// DisableInsightRules
, and DeleteInsightRules
. If a previously
/// created managed rule is currently disabled, a subsequent call to this API will re-enable
/// it. Use ListManagedInsightRules
to describe all available rules.
///
/// Container for the necessary parameters to execute the PutManagedInsightRules service method.
///
/// The response from the PutManagedInsightRules service method, as returned by CloudWatch.
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for PutManagedInsightRules Operation
public virtual PutManagedInsightRulesResponse PutManagedInsightRules(PutManagedInsightRulesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutManagedInsightRulesRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutManagedInsightRulesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates a managed Contributor Insights rule for a specified Amazon Web Services resource.
/// When you enable a managed rule, you create a Contributor Insights rule that collects
/// data from Amazon Web Services services. You cannot edit these rules with PutInsightRule
.
/// The rules can be enabled, disabled, and deleted using EnableInsightRules
,
/// DisableInsightRules
, and DeleteInsightRules
. If a previously
/// created managed rule is currently disabled, a subsequent call to this API will re-enable
/// it. Use ListManagedInsightRules
to describe all available rules.
///
/// Container for the necessary parameters to execute the PutManagedInsightRules service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutManagedInsightRules service method, as returned by CloudWatch.
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for PutManagedInsightRules Operation
public virtual Task PutManagedInsightRulesAsync(PutManagedInsightRulesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutManagedInsightRulesRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutManagedInsightRulesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutMetricAlarm
///
/// Creates or updates an alarm and associates it with the specified metric, metric math
/// expression, anomaly detection model, or Metrics Insights query. For more information
/// about using a Metrics Insights query for an alarm, see Create
/// alarms on Metrics Insights queries.
///
///
///
/// 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:
///
/// -
///
/// The
iam:CreateServiceLinkedRole
permission for all alarms with EC2 actions
///
/// -
///
/// The
iam:CreateServiceLinkedRole
permissions to create an alarm with Systems
/// Manager OpsItem or response plan actions.
///
///
///
/// The first time you create an alarm in the Amazon Web Services Management Console,
/// the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked
/// role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents
/// and AWSServiceRoleForCloudWatchAlarms_ActionSSM
. For more information,
/// see Amazon
/// Web Services service-linked role.
///
///
///
/// Each PutMetricAlarm
action has a maximum uncompressed payload of 120
/// KB.
///
///
///
/// Cross-account alarms
///
///
///
/// You can set an alarm on metrics in the current account, or in another account. To
/// create a cross-account alarm that watches a metric in a different account, you must
/// have completed the following pre-requisites:
///
/// -
///
/// The account where the metrics are located (the sharing account) must already
/// have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not
/// already have this role, you must create it using the instructions in Set up a sharing
/// account in
/// Cross-account cross-Region CloudWatch console. The policy for that role must grant
/// access to the ID of the account where you are creating the alarm.
///
///
-
///
/// The account where you are creating the alarm (the monitoring account) must
/// already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount
/// to allow CloudWatch to assume the sharing role in the sharing account. If it does
/// not, you must create it following the directions in Set up a monitoring account
/// in
/// Cross-account cross-Region CloudWatch console.
///
///
///
/// Container for the necessary parameters to execute the PutMetricAlarm service method.
///
/// The response from the PutMetricAlarm service method, as returned by CloudWatch.
///
/// The quota for alarms for this customer has already been reached.
///
/// REST API Reference for PutMetricAlarm Operation
public virtual PutMetricAlarmResponse PutMetricAlarm(PutMetricAlarmRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutMetricAlarmRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutMetricAlarmResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates or updates an alarm and associates it with the specified metric, metric math
/// expression, anomaly detection model, or Metrics Insights query. For more information
/// about using a Metrics Insights query for an alarm, see Create
/// alarms on Metrics Insights queries.
///
///
///
/// 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:
///
/// -
///
/// The
iam:CreateServiceLinkedRole
permission for all alarms with EC2 actions
///
/// -
///
/// The
iam:CreateServiceLinkedRole
permissions to create an alarm with Systems
/// Manager OpsItem or response plan actions.
///
///
///
/// The first time you create an alarm in the Amazon Web Services Management Console,
/// the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked
/// role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents
/// and AWSServiceRoleForCloudWatchAlarms_ActionSSM
. For more information,
/// see Amazon
/// Web Services service-linked role.
///
///
///
/// Each PutMetricAlarm
action has a maximum uncompressed payload of 120
/// KB.
///
///
///
/// Cross-account alarms
///
///
///
/// You can set an alarm on metrics in the current account, or in another account. To
/// create a cross-account alarm that watches a metric in a different account, you must
/// have completed the following pre-requisites:
///
/// -
///
/// The account where the metrics are located (the sharing account) must already
/// have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not
/// already have this role, you must create it using the instructions in Set up a sharing
/// account in
/// Cross-account cross-Region CloudWatch console. The policy for that role must grant
/// access to the ID of the account where you are creating the alarm.
///
///
-
///
/// The account where you are creating the alarm (the monitoring account) must
/// already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount
/// to allow CloudWatch to assume the sharing role in the sharing account. If it does
/// not, you must create it following the directions in Set up a monitoring account
/// in
/// Cross-account cross-Region CloudWatch console.
///
///
///
/// Container for the necessary parameters to execute the PutMetricAlarm service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutMetricAlarm service method, as returned by CloudWatch.
///
/// The quota for alarms for this customer has already been reached.
///
/// REST API Reference for PutMetricAlarm Operation
public virtual Task PutMetricAlarmAsync(PutMetricAlarmRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutMetricAlarmRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutMetricAlarmResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutMetricData
///
/// 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 1 MB in size for HTTP POST requests.
/// You can send a payload compressed by gzip. Each request is also limited to no more
/// than 1000 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 30 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.
///
///
///
/// You specify the time stamp to be associated with each data point. You can specify
/// time stamps that are as much as two weeks before the current date, and as much as
/// 2 hours after the current day and time.
///
///
///
/// 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
.
///
///
///
/// Container for the necessary parameters to execute the PutMetricData service method.
///
/// The response from the PutMetricData service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// Parameters were used together that cannot be used together.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for PutMetricData Operation
public virtual PutMetricDataResponse PutMetricData(PutMetricDataRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutMetricDataRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutMetricDataResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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 1 MB in size for HTTP POST requests.
/// You can send a payload compressed by gzip. Each request is also limited to no more
/// than 1000 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 30 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.
///
///
///
/// You specify the time stamp to be associated with each data point. You can specify
/// time stamps that are as much as two weeks before the current date, and as much as
/// 2 hours after the current day and time.
///
///
///
/// 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
.
///
///
///
/// Container for the necessary parameters to execute the PutMetricData service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutMetricData service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// Parameters were used together that cannot be used together.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for PutMetricData Operation
public virtual Task PutMetricDataAsync(PutMetricDataRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutMetricDataRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutMetricDataResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutMetricStream
///
/// Creates or updates a metric stream. Metric streams can automatically stream CloudWatch
/// metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party
/// solutions.
///
///
///
/// For more information, see
/// Using Metric Streams.
///
///
///
/// To create a metric stream, you must be signed in to an account that has the iam:PassRole
/// permission and either the CloudWatchFullAccess
policy or the cloudwatch:PutMetricStream
/// permission.
///
///
///
/// When you create or update a metric stream, you choose one of the following:
///
/// -
///
/// Stream metrics from all metric namespaces in the account.
///
///
-
///
/// Stream metrics from all metric namespaces in the account, except for the namespaces
/// that you list in
ExcludeFilters
.
///
/// -
///
/// Stream metrics from only the metric namespaces that you list in
IncludeFilters
.
///
///
///
/// By default, a metric stream always sends the MAX
, MIN
, SUM
,
/// and SAMPLECOUNT
statistics for each metric that is streamed. You can
/// use the StatisticsConfigurations
parameter to have the metric stream
/// send additional statistics in the stream. Streaming additional statistics incurs additional
/// costs. For more information, see Amazon
/// CloudWatch Pricing.
///
///
///
/// When you use PutMetricStream
to create a new metric stream, the stream
/// is created in the running
state. If you use it to update an existing
/// stream, the state of the stream is not changed.
///
///
///
/// If you are using CloudWatch cross-account observability and you create a metric stream
/// in a monitoring account, you can choose whether to include metrics from source accounts
/// in the stream. For more information, see CloudWatch
/// cross-account observability.
///
///
/// Container for the necessary parameters to execute the PutMetricStream service method.
///
/// The response from the PutMetricStream service method, as returned by CloudWatch.
///
/// More than one process tried to modify a resource at the same time.
///
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// Parameters were used together that cannot be used together.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for PutMetricStream Operation
public virtual PutMetricStreamResponse PutMetricStream(PutMetricStreamRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutMetricStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutMetricStreamResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates or updates a metric stream. Metric streams can automatically stream CloudWatch
/// metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party
/// solutions.
///
///
///
/// For more information, see
/// Using Metric Streams.
///
///
///
/// To create a metric stream, you must be signed in to an account that has the iam:PassRole
/// permission and either the CloudWatchFullAccess
policy or the cloudwatch:PutMetricStream
/// permission.
///
///
///
/// When you create or update a metric stream, you choose one of the following:
///
/// -
///
/// Stream metrics from all metric namespaces in the account.
///
///
-
///
/// Stream metrics from all metric namespaces in the account, except for the namespaces
/// that you list in
ExcludeFilters
.
///
/// -
///
/// Stream metrics from only the metric namespaces that you list in
IncludeFilters
.
///
///
///
/// By default, a metric stream always sends the MAX
, MIN
, SUM
,
/// and SAMPLECOUNT
statistics for each metric that is streamed. You can
/// use the StatisticsConfigurations
parameter to have the metric stream
/// send additional statistics in the stream. Streaming additional statistics incurs additional
/// costs. For more information, see Amazon
/// CloudWatch Pricing.
///
///
///
/// When you use PutMetricStream
to create a new metric stream, the stream
/// is created in the running
state. If you use it to update an existing
/// stream, the state of the stream is not changed.
///
///
///
/// If you are using CloudWatch cross-account observability and you create a metric stream
/// in a monitoring account, you can choose whether to include metrics from source accounts
/// in the stream. For more information, see CloudWatch
/// cross-account observability.
///
///
/// Container for the necessary parameters to execute the PutMetricStream service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutMetricStream service method, as returned by CloudWatch.
///
/// More than one process tried to modify a resource at the same time.
///
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// Parameters were used together that cannot be used together.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for PutMetricStream Operation
public virtual Task PutMetricStreamAsync(PutMetricStreamRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutMetricStreamRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutMetricStreamResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region SetAlarmState
///
/// 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.
///
///
/// Container for the necessary parameters to execute the SetAlarmState service method.
///
/// The response from the SetAlarmState service method, as returned by CloudWatch.
///
/// Data was not syntactically valid JSON.
///
///
/// The named resource does not exist.
///
/// REST API Reference for SetAlarmState Operation
public virtual SetAlarmStateResponse SetAlarmState(SetAlarmStateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = SetAlarmStateRequestMarshaller.Instance;
options.ResponseUnmarshaller = SetAlarmStateResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the SetAlarmState service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the SetAlarmState service method, as returned by CloudWatch.
///
/// Data was not syntactically valid JSON.
///
///
/// The named resource does not exist.
///
/// REST API Reference for SetAlarmState Operation
public virtual Task SetAlarmStateAsync(SetAlarmStateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = SetAlarmStateRequestMarshaller.Instance;
options.ResponseUnmarshaller = SetAlarmStateResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region StartMetricStreams
///
/// Starts the streaming of metrics for one or more of your metric streams.
///
/// Container for the necessary parameters to execute the StartMetricStreams service method.
///
/// The response from the StartMetricStreams service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for StartMetricStreams Operation
public virtual StartMetricStreamsResponse StartMetricStreams(StartMetricStreamsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = StartMetricStreamsRequestMarshaller.Instance;
options.ResponseUnmarshaller = StartMetricStreamsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Starts the streaming of metrics for one or more of your metric streams.
///
/// Container for the necessary parameters to execute the StartMetricStreams service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartMetricStreams service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for StartMetricStreams Operation
public virtual Task StartMetricStreamsAsync(StartMetricStreamsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = StartMetricStreamsRequestMarshaller.Instance;
options.ResponseUnmarshaller = StartMetricStreamsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region StopMetricStreams
///
/// Stops the streaming of metrics for one or more of your metric streams.
///
/// Container for the necessary parameters to execute the StopMetricStreams service method.
///
/// The response from the StopMetricStreams service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for StopMetricStreams Operation
public virtual StopMetricStreamsResponse StopMetricStreams(StopMetricStreamsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = StopMetricStreamsRequestMarshaller.Instance;
options.ResponseUnmarshaller = StopMetricStreamsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Stops the streaming of metrics for one or more of your metric streams.
///
/// Container for the necessary parameters to execute the StopMetricStreams service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StopMetricStreams service method, as returned by CloudWatch.
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// An input parameter that is required is missing.
///
/// REST API Reference for StopMetricStreams Operation
public virtual Task StopMetricStreamsAsync(StopMetricStreamsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = StopMetricStreamsRequestMarshaller.Instance;
options.ResponseUnmarshaller = StopMetricStreamsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region TagResource
///
/// 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 Amazon Web Services 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.
///
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by CloudWatch.
///
/// More than one process tried to modify a resource at the same time.
///
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// The named resource does not exist.
///
/// REST API Reference for TagResource Operation
public virtual TagResourceResponse TagResource(TagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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 Amazon Web Services 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.
///
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by CloudWatch.
///
/// More than one process tried to modify a resource at the same time.
///
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// The named resource does not exist.
///
/// REST API Reference for TagResource Operation
public virtual Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region UntagResource
///
/// Removes one or more tags from the specified resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by CloudWatch.
///
/// More than one process tried to modify a resource at the same time.
///
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// The named resource does not exist.
///
/// REST API Reference for UntagResource Operation
public virtual UntagResourceResponse UntagResource(UntagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Removes one or more tags from the specified resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by CloudWatch.
///
/// More than one process tried to modify a resource at the same time.
///
///
/// Request processing has failed due to some unknown error, exception, or failure.
///
///
/// The value of an input parameter is bad or out-of-range.
///
///
/// The named resource does not exist.
///
/// REST API Reference for UntagResource Operation
public virtual Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
}
}