/// <summary>
/// <para> Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon
/// CloudWatch returns histories for all of the owner's alarms. </para> <para><b>NOTE:</b> Amazon CloudWatch retains the history of an alarm for
/// two weeks, whether or not you delete the alarm. </para>
/// </summary>
///
/// <param name="describeAlarmHistoryRequest">Container for the necessary parameters to execute the DescribeAlarmHistory service method on
/// AmazonCloudWatch.</param>
///
/// <returns>The response from the DescribeAlarmHistory service method, as returned by AmazonCloudWatch.</returns>
///
/// <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException" />
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
public Task<DescribeAlarmHistoryResponse> DescribeAlarmHistoryAsync(DescribeAlarmHistoryRequest describeAlarmHistoryRequest, CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new DescribeAlarmHistoryRequestMarshaller();
var unmarshaller = DescribeAlarmHistoryResponseUnmarshaller.GetInstance();
return Invoke<IRequest, DescribeAlarmHistoryRequest, DescribeAlarmHistoryResponse>(describeAlarmHistoryRequest, marshaller, unmarshaller, signer, cancellationToken);
}
/// <summary>
/// Retrieves history for the specified alarm. Filter alarms by date range or item type.
/// If an alarm name is not specified, Amazon CloudWatch returns histories for all of
/// the owner's alarms.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeAlarmHistory service method.</param>
///
/// <returns>The response from the DescribeAlarmHistory service method, as returned by CloudWatch.</returns>
/// <exception cref="Amazon.CloudWatch.Model.InvalidNextTokenException">
/// The next token specified is invalid.
/// </exception>
public DescribeAlarmHistoryResponse DescribeAlarmHistory(DescribeAlarmHistoryRequest request)
{
var marshaller = new DescribeAlarmHistoryRequestMarshaller();
var unmarshaller = DescribeAlarmHistoryResponseUnmarshaller.Instance;
return Invoke<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResponse>(request, marshaller, unmarshaller);
}
/// <summary>
/// <para> Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon
/// CloudWatch returns histories for all of the owner's alarms. </para> <para><b>NOTE:</b> Amazon CloudWatch retains the history of an alarm for
/// two weeks, whether or not you delete the alarm. </para>
/// </summary>
///
/// <param name="describeAlarmHistoryRequest">Container for the necessary parameters to execute the DescribeAlarmHistory service method on
/// AmazonCloudWatch.</param>
///
/// <returns>The response from the DescribeAlarmHistory service method, as returned by AmazonCloudWatch.</returns>
///
/// <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException" />
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
public async Task<DescribeAlarmHistoryResponse> DescribeAlarmHistoryAsync(DescribeAlarmHistoryRequest describeAlarmHistoryRequest, CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new DescribeAlarmHistoryRequestMarshaller();
var unmarshaller = DescribeAlarmHistoryResponseUnmarshaller.GetInstance();
var response = await Invoke<IRequest, DescribeAlarmHistoryRequest, DescribeAlarmHistoryResponse>(describeAlarmHistoryRequest, marshaller, unmarshaller, signer, cancellationToken)
.ConfigureAwait(continueOnCapturedContext: false);
return response;
}
internal DescribeAlarmHistoryResponse DescribeAlarmHistory(DescribeAlarmHistoryRequest request)
{
var task = DescribeAlarmHistoryAsync(request);
try
{
return task.Result;
}
catch(AggregateException e)
{
throw e.InnerException;
}
}
///
/// <returns>The response from the ListMetrics service method, as returned by AmazonCloudWatch.</returns>
///
/// <exception cref="InternalServiceException"/>
/// <exception cref="InvalidParameterValueException"/>
public ListMetricsResponse ListMetrics()
{
return ListMetrics(new ListMetricsRequest());
}
#endregion
#region GetMetricStatistics
/// <summary>
/// <para> Gets statistics for the specified metric. </para> <para><b>NOTE:</b> The maximum number of data points returned from a single
/// <returns>The response from the DescribeAlarmHistory service method, as returned by AmazonCloudWatch.</returns>
///
/// <exception cref="InvalidNextTokenException"/>
public DescribeAlarmHistoryResponse DescribeAlarmHistory()
{
return DescribeAlarmHistory(new DescribeAlarmHistoryRequest());
}
internal DescribeAlarmHistoryResponse DescribeAlarmHistory(DescribeAlarmHistoryRequest request)
{
var task = DescribeAlarmHistoryAsync(request);
try
{
return task.Result;
}
catch(AggregateException e)
{
ExceptionDispatchInfo.Capture(e.InnerException).Throw();
return null;
}
}
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent;
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
// create request and set iteration invariants
var request = new Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest();
if (cmdletContext.AlarmName != null)
{
request.AlarmName = cmdletContext.AlarmName;
}
if (cmdletContext.UtcEndDate != null)
{
request.EndDateUtc = cmdletContext.UtcEndDate.Value;
}
if (cmdletContext.HistoryItemType != null)
{
request.HistoryItemType = cmdletContext.HistoryItemType;
}
if (cmdletContext.MaxRecord != null)
{
request.MaxRecords = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.MaxRecord.Value);
}
if (cmdletContext.UtcStartDate != null)
{
request.StartDateUtc = cmdletContext.UtcStartDate.Value;
}
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (cmdletContext.EndDate != null)
{
if (cmdletContext.UtcEndDate != null)
{
throw new System.ArgumentException("Parameters EndDate and UtcEndDate are mutually exclusive.", nameof(this.EndDate));
}
request.EndDate = cmdletContext.EndDate.Value;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (cmdletContext.StartDate != null)
{
if (cmdletContext.UtcStartDate != null)
{
throw new System.ArgumentException("Parameters StartDate and UtcStartDate are mutually exclusive.", nameof(this.StartDate));
}
request.StartDate = cmdletContext.StartDate.Value;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
// Initialize loop variant and commence piping
var _nextToken = cmdletContext.NextToken;
var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.NextToken = _nextToken;
CmdletOutput output;
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
if (!useParameterSelect)
{
pipelineOutput = cmdletContext.Select(response, this);
}
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
_nextToken = response.NextToken;
}
catch (Exception e)
{
output = new CmdletOutput {
ErrorResponse = e
};
}
ProcessOutput(output);
} while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken));
if (useParameterSelect)
{
WriteObject(cmdletContext.Select(null, this));
}
return(null);
}
/// <summary>
/// Paginator for DescribeAlarmHistory operation
///</summary>
public IDescribeAlarmHistoryPaginator DescribeAlarmHistory(DescribeAlarmHistoryRequest request)
{
return(new DescribeAlarmHistoryPaginator(this.client, request));
}
internal DescribeAlarmHistoryPaginator(IAmazonCloudWatch client, DescribeAlarmHistoryRequest request)
{
this._client = client;
this._request = request;
}
/// <summary>
/// Initiates the asynchronous execution of the DescribeAlarmHistory operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DescribeAlarmHistory operation.</param>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
/// <returns>The task object representing the asynchronous operation.</returns>
public Task<DescribeAlarmHistoryResponse> DescribeAlarmHistoryAsync(DescribeAlarmHistoryRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new DescribeAlarmHistoryRequestMarshaller();
var unmarshaller = DescribeAlarmHistoryResponseUnmarshaller.Instance;
return InvokeAsync<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResponse>(request, marshaller,
unmarshaller, cancellationToken);
}
private Amazon.CloudWatch.Model.DescribeAlarmHistoryResponse CallAWSServiceOperation(IAmazonCloudWatch client, Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon CloudWatch", "DescribeAlarmHistory");
try
{
#if DESKTOP
return(client.DescribeAlarmHistory(request));
#elif CORECLR
return(client.DescribeAlarmHistoryAsync(request).GetAwaiter().GetResult());
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent;
// create request and set iteration invariants
var request = new Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest();
if (cmdletContext.AlarmName != null)
{
request.AlarmName = cmdletContext.AlarmName;
}
if (cmdletContext.UtcEndDate != null)
{
request.EndDateUtc = cmdletContext.UtcEndDate.Value;
}
if (cmdletContext.HistoryItemType != null)
{
request.HistoryItemType = cmdletContext.HistoryItemType;
}
if (cmdletContext.UtcStartDate != null)
{
request.StartDateUtc = cmdletContext.UtcStartDate.Value;
}
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (cmdletContext.EndDate != null)
{
if (cmdletContext.UtcEndDate != null)
{
throw new System.ArgumentException("Parameters EndDate and UtcEndDate are mutually exclusive.", nameof(this.EndDate));
}
request.EndDate = cmdletContext.EndDate.Value;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (cmdletContext.StartDate != null)
{
if (cmdletContext.UtcStartDate != null)
{
throw new System.ArgumentException("Parameters StartDate and UtcStartDate are mutually exclusive.", nameof(this.StartDate));
}
request.StartDate = cmdletContext.StartDate.Value;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
// Initialize loop variants and commence piping
System.String _nextToken = null;
int? _emitLimit = null;
int _retrievedSoFar = 0;
if (AutoIterationHelpers.HasValue(cmdletContext.NextToken))
{
_nextToken = cmdletContext.NextToken;
}
if (AutoIterationHelpers.HasValue(cmdletContext.MaxRecord))
{
// The service has a maximum page size of 100. If the user has
// asked for more items than page max, and there is no page size
// configured, we rely on the service ignoring the set maximum
// and giving us 100 items back. If a page size is set, that will
// be used to configure the pagination.
// We'll make further calls to satisfy the user's request.
_emitLimit = cmdletContext.MaxRecord;
}
var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.NextToken = _nextToken;
if (_emitLimit.HasValue)
{
int correctPageSize = AutoIterationHelpers.Min(100, _emitLimit.Value);
request.MaxRecords = AutoIterationHelpers.ConvertEmitLimitToInt32(correctPageSize);
}
CmdletOutput output;
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
if (!useParameterSelect)
{
pipelineOutput = cmdletContext.Select(response, this);
}
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
int _receivedThisCall = response.AlarmHistoryItems.Count;
_nextToken = response.NextToken;
_retrievedSoFar += _receivedThisCall;
if (_emitLimit.HasValue)
{
_emitLimit -= _receivedThisCall;
}
}
catch (Exception e)
{
if (_retrievedSoFar == 0 || !_emitLimit.HasValue)
{
output = new CmdletOutput {
ErrorResponse = e
};
}
else
{
break;
}
}
ProcessOutput(output);
} while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken) && (!_emitLimit.HasValue || _emitLimit.Value >= 1));
if (useParameterSelect)
{
WriteObject(cmdletContext.Select(null, this));
}
return(null);
}
/// <summary>
/// Initiates the asynchronous execution of the DescribeAlarmHistory operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DescribeAlarmHistory operation on AmazonCloudWatchClient.</param>
/// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
/// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.</param>
///
/// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAlarmHistory
/// operation.</returns>
public IAsyncResult BeginDescribeAlarmHistory(DescribeAlarmHistoryRequest request, AsyncCallback callback, object state)
{
var marshaller = new DescribeAlarmHistoryRequestMarshaller();
var unmarshaller = DescribeAlarmHistoryResponseUnmarshaller.Instance;
return BeginInvoke<DescribeAlarmHistoryRequest>(request, marshaller, unmarshaller,
callback, state);
}
/// AmazonCloudWatch.</param>
/// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
/// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.</param>
public IAsyncResult BeginPutMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest, AsyncCallback callback, object state)
{
return invokePutMetricAlarm(putMetricAlarmRequest, callback, state, false);
}
/// <summary>
/// Finishes the asynchronous execution of the PutMetricAlarm operation.
/// <seealso cref="Amazon.CloudWatch.AmazonCloudWatch.PutMetricAlarm"/>
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutMetricAlarm.</param>
/// <summary>
/// <para> Retrieves history for the specified alarm. Filter alarms by
/// date range or item type. If an alarm name is not specified, Amazon
/// CloudWatch returns histories for all of the owner's alarms. </para>
/// <para><b>NOTE:</b> Amazon CloudWatch retains the history of an alarm
/// for two weeks, whether or not you delete the alarm. </para>
/// </summary>
///
/// <param name="describeAlarmHistoryRequest">Container for the necessary
/// parameters to execute the DescribeAlarmHistory service method on
/// AmazonCloudWatch.</param>
///
/// <returns>The response from the DescribeAlarmHistory service method, as
/// returned by AmazonCloudWatch.</returns>
///
/// <exception cref="InvalidNextTokenException"/>
public DescribeAlarmHistoryResponse DescribeAlarmHistory(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
{
IRequest<DescribeAlarmHistoryRequest> request = new DescribeAlarmHistoryRequestMarshaller().Marshall(describeAlarmHistoryRequest);
DescribeAlarmHistoryResponse response = Invoke<DescribeAlarmHistoryRequest, DescribeAlarmHistoryResponse> (request, this.signer, DescribeAlarmHistoryResponseUnmarshaller.GetInstance());
return response;
}
public static void CWDescribeAlarmHistory()
{
#region CWDescribeAlarmHistory
var client = new AmazonCloudWatchClient();
var request = new DescribeAlarmHistoryRequest
{
AlarmName =
"awseb-e-kkbEXAMPLE-stack-CloudwatchAlarmLow-1WVXD9EXAMPLE",
EndDate = DateTime.Today,
HistoryItemType = HistoryItemType.Action,
MaxRecords = 1,
StartDate = DateTime.Today.Subtract(TimeSpan.FromDays(30))
};
var response = new DescribeAlarmHistoryResponse();
do
{
response = client.DescribeAlarmHistory(request);
foreach (var item in response.AlarmHistoryItems)
{
Console.WriteLine(item.AlarmName);
Console.WriteLine(item.HistorySummary);
Console.WriteLine();
}
request.NextToken = response.NextToken;
} while (!string.IsNullOrEmpty(response.NextToken));
#endregion
Console.ReadLine();
}
