/*******************************************************************************
* Copyright 2012-2019 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.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.CloudWatch;
using Amazon.CloudWatch.Model;
namespace Amazon.PowerShell.Cmdlets.CW
{
///
/// 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.
///
This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.
///
[Cmdlet("Get", "CWAlarmHistory")]
[OutputType("Amazon.CloudWatch.Model.AlarmHistoryItem")]
[AWSCmdlet("Calls the Amazon CloudWatch DescribeAlarmHistory API operation.", Operation = new[] {"DescribeAlarmHistory"}, SelectReturnType = typeof(Amazon.CloudWatch.Model.DescribeAlarmHistoryResponse))]
[AWSCmdletOutput("Amazon.CloudWatch.Model.AlarmHistoryItem or Amazon.CloudWatch.Model.DescribeAlarmHistoryResponse",
"This cmdlet returns a collection of Amazon.CloudWatch.Model.AlarmHistoryItem objects.",
"The service call response (type Amazon.CloudWatch.Model.DescribeAlarmHistoryResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetCWAlarmHistoryCmdlet : AmazonCloudWatchClientCmdlet, IExecutor
{
#region Parameter AlarmName
///
///
/// The name of the alarm.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String AlarmName { get; set; }
#endregion
#region Parameter AlarmType
///
///
/// Use this parameter to specify whether you want the operation to return metric alarms
/// or composite alarms. If you omit this parameter, only metric alarms are returned.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("AlarmTypes")]
public System.String[] AlarmType { get; set; }
#endregion
#region Parameter UtcEndDate
///
///
/// The ending date to retrieve alarm history.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? UtcEndDate { get; set; }
#endregion
#region Parameter HistoryItemType
///
///
/// The type of alarm histories to retrieve.
///
///
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.CloudWatch.HistoryItemType")]
public Amazon.CloudWatch.HistoryItemType HistoryItemType { get; set; }
#endregion
#region Parameter ScanBy
///
///
/// Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending
/// to have the newest event history returned first, and specify TimestampAscending
/// to have the oldest history returned first.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.CloudWatch.ScanBy")]
public Amazon.CloudWatch.ScanBy ScanBy { get; set; }
#endregion
#region Parameter UtcStartDate
///
///
/// The starting date to retrieve alarm history.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? UtcStartDate { get; set; }
#endregion
#region Parameter EndDate
///
///
/// This property is deprecated. Setting this property results in non-UTC DateTimes not
/// being marshalled correctly. Use EndDateUtc instead. Setting either EndDate or EndDateUtc
/// results in both EndDate and EndDateUtc being assigned, the latest assignment to either
/// one of the two property is reflected in the value of both. EndDate is provided for
/// backwards compatibility only and assigning a non-Utc DateTime to it results in the
/// wrong timestamp being passed to the service.The ending date to retrieve alarm history.
///
/// This parameter is deprecated.
///
[System.Management.Automation.Parameter(Position = 3, ValueFromPipelineByPropertyName = true)]
[System.ObsoleteAttribute("This parameter is deprecated and may result in the wrong timestamp being passed to the service, use UtcEndDate instead.")]
public System.DateTime? EndDate { get; set; }
#endregion
#region Parameter MaxRecord
///
///
/// The maximum number of alarm history records to retrieve.
///
///
///
Note: In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet.
///
In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call.
///
Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxItems","MaxRecords")]
public int? MaxRecord { get; set; }
#endregion
#region Parameter NextToken
///
///
/// The token returned by a previous call to indicate that there is more data available.
///
///
///
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
///
In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String NextToken { get; set; }
#endregion
#region Parameter StartDate
///
///
/// This property is deprecated. Setting this property results in non-UTC DateTimes not
/// being marshalled correctly. Use StartDateUtc instead. Setting either StartDate or
/// StartDateUtc results in both StartDate and StartDateUtc being assigned, the latest
/// assignment to either one of the two property is reflected in the value of both. StartDate
/// is provided for backwards compatibility only and assigning a non-Utc DateTime to it
/// results in the wrong timestamp being passed to the service.The starting date to retrieve alarm history.
///
/// This parameter is deprecated.
///
[System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)]
[System.ObsoleteAttribute("This parameter is deprecated and may result in the wrong timestamp being passed to the service, use UtcStartDate instead.")]
public System.DateTime? StartDate { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'AlarmHistoryItems'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatch.Model.DescribeAlarmHistoryResponse).
/// Specifying the name of a property of type Amazon.CloudWatch.Model.DescribeAlarmHistoryResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "AlarmHistoryItems";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the AlarmName parameter.
/// The -PassThru parameter is deprecated, use -Select '^AlarmName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^AlarmName' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter NoAutoIteration
///
/// By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple
/// service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken
/// as the start point.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter NoAutoIteration { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.AlarmName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AlarmName = this.AlarmName;
if (this.AlarmType != null)
{
context.AlarmType = new List(this.AlarmType);
}
context.UtcEndDate = this.UtcEndDate;
context.HistoryItemType = this.HistoryItemType;
context.MaxRecord = this.MaxRecord;
#if !MODULAR
if (ParameterWasBound(nameof(this.MaxRecord)) && this.MaxRecord.HasValue)
{
WriteWarning("AWSPowerShell and AWSPowerShell.NetCore use the MaxRecord parameter to limit the total number of items returned by the cmdlet." +
" This behavior is obsolete and will be removed in a future version of these modules. Pipe the output of this cmdlet into Select-Object -First to terminate" +
" retrieving data pages early and control the number of items returned. AWS.Tools already implements the new behavior of simply passing MaxRecord" +
" to the service to specify how many items should be returned by each service call.");
}
#endif
context.NextToken = this.NextToken;
context.ScanBy = this.ScanBy;
context.UtcStartDate = this.UtcStartDate;
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.EndDate = this.EndDate;
#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
context.StartDate = this.StartDate;
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
#if MODULAR
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.AlarmType != null)
{
request.AlarmTypes = cmdletContext.AlarmType;
}
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.ScanBy != null)
{
request.ScanBy = cmdletContext.ScanBy;
}
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;
}
#else
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.AlarmType != null)
{
request.AlarmTypes = cmdletContext.AlarmType;
}
if (cmdletContext.UtcEndDate != null)
{
request.EndDateUtc = cmdletContext.UtcEndDate.Value;
}
if (cmdletContext.HistoryItemType != null)
{
request.HistoryItemType = cmdletContext.HistoryItemType;
}
if (cmdletContext.ScanBy != null)
{
request.ScanBy = cmdletContext.ScanBy;
}
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 (cmdletContext.MaxRecord.HasValue)
{
// 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 = Math.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;
}
#endif
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
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;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public System.String AlarmName { get; set; }
public List AlarmType { get; set; }
public System.DateTime? UtcEndDate { get; set; }
public Amazon.CloudWatch.HistoryItemType HistoryItemType { get; set; }
public int? MaxRecord { get; set; }
public System.String NextToken { get; set; }
public Amazon.CloudWatch.ScanBy ScanBy { get; set; }
public System.DateTime? UtcStartDate { get; set; }
[System.ObsoleteAttribute]
public System.DateTime? EndDate { get; set; }
[System.ObsoleteAttribute]
public System.DateTime? StartDate { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.AlarmHistoryItems;
}
}
}