/*******************************************************************************
* 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.IoT;
using Amazon.IoT.Model;
namespace Amazon.PowerShell.Cmdlets.IOT
{
///
/// Lists the Device Defender security profile violations discovered during the given
/// time period. You can use filters to limit the results to those alerts issued for a
/// particular security profile, behavior, or thing (device).
///
///
///
/// Requires permission to access the ListViolationEvents
/// action.
///
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", "IOTViolationEventList")]
[OutputType("Amazon.IoT.Model.ViolationEvent")]
[AWSCmdlet("Calls the AWS IoT ListViolationEvents API operation.", Operation = new[] {"ListViolationEvents"}, SelectReturnType = typeof(Amazon.IoT.Model.ListViolationEventsResponse))]
[AWSCmdletOutput("Amazon.IoT.Model.ViolationEvent or Amazon.IoT.Model.ListViolationEventsResponse",
"This cmdlet returns a collection of Amazon.IoT.Model.ViolationEvent objects.",
"The service call response (type Amazon.IoT.Model.ListViolationEventsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetIOTViolationEventListCmdlet : AmazonIoTClientCmdlet, IExecutor
{
#region Parameter BehaviorCriteriaType
///
///
/// The criteria for a behavior.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.IoT.BehaviorCriteriaType")]
public Amazon.IoT.BehaviorCriteriaType BehaviorCriteriaType { get; set; }
#endregion
#region Parameter UtcEndTime
///
///
/// The end time for the alerts to be listed.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.DateTime? UtcEndTime { get; set; }
#endregion
#region Parameter ListSuppressedAlert
///
///
/// A list of all suppressed alerts.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ListSuppressedAlerts")]
public System.Boolean? ListSuppressedAlert { get; set; }
#endregion
#region Parameter SecurityProfileName
///
///
/// A filter to limit results to those alerts generated by the specified security profile.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SecurityProfileName { get; set; }
#endregion
#region Parameter UtcStartTime
///
///
/// The start time for the alerts to be listed.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.DateTime? UtcStartTime { get; set; }
#endregion
#region Parameter ThingName
///
///
/// A filter to limit results to those alerts caused by the specified thing.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ThingName { get; set; }
#endregion
#region Parameter VerificationState
///
///
/// The verification state of the violation (detect alarm).
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.IoT.VerificationState")]
public Amazon.IoT.VerificationState VerificationState { get; set; }
#endregion
#region Parameter EndTime
///
///
/// This property is deprecated. Setting this property results in non-UTC DateTimes not
/// being marshalled correctly. Use EndTimeUtc instead. Setting either EndTime or EndTimeUtc
/// results in both EndTime and EndTimeUtc being assigned, the latest assignment to either
/// one of the two property is reflected in the value of both. EndTime 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 end time for the alerts to be listed.
///
/// This parameter is deprecated.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[System.ObsoleteAttribute("This parameter is deprecated and may result in the wrong timestamp being passed to the service, use UtcEndTime instead.")]
public System.DateTime? EndTime { get; set; }
#endregion
#region Parameter MaxResult
///
///
/// The maximum number of results to return at one time.
///
///
///
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","MaxResults")]
public int? MaxResult { get; set; }
#endregion
#region Parameter NextToken
///
///
/// The token for the next set of results.
///
///
///
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 StartTime
///
///
/// This property is deprecated. Setting this property results in non-UTC DateTimes not
/// being marshalled correctly. Use StartTimeUtc instead. Setting either StartTime or
/// StartTimeUtc results in both StartTime and StartTimeUtc being assigned, the latest
/// assignment to either one of the two property is reflected in the value of both. StartTime
/// 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 start time for the alerts to be listed.
///
/// This parameter is deprecated.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[System.ObsoleteAttribute("This parameter is deprecated and may result in the wrong timestamp being passed to the service, use UtcStartTime instead.")]
public System.DateTime? StartTime { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'ViolationEvents'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoT.Model.ListViolationEventsResponse).
/// Specifying the name of a property of type Amazon.IoT.Model.ListViolationEventsResponse 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; } = "ViolationEvents";
#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);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.BehaviorCriteriaType = this.BehaviorCriteriaType;
context.UtcEndTime = this.UtcEndTime;
#if MODULAR
if (this.UtcEndTime == null && ParameterWasBound(nameof(this.UtcEndTime)))
{
WriteWarning("You are passing $null as a value for parameter UtcEndTime which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.ListSuppressedAlert = this.ListSuppressedAlert;
context.MaxResult = this.MaxResult;
#if !MODULAR
if (ParameterWasBound(nameof(this.MaxResult)) && this.MaxResult.HasValue)
{
WriteWarning("AWSPowerShell and AWSPowerShell.NetCore use the MaxResult 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 MaxResult" +
" to the service to specify how many items should be returned by each service call.");
}
#endif
context.NextToken = this.NextToken;
context.SecurityProfileName = this.SecurityProfileName;
context.UtcStartTime = this.UtcStartTime;
#if MODULAR
if (this.UtcStartTime == null && ParameterWasBound(nameof(this.UtcStartTime)))
{
WriteWarning("You are passing $null as a value for parameter UtcStartTime which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.ThingName = this.ThingName;
context.VerificationState = this.VerificationState;
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.EndTime = this.EndTime;
#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.StartTime = this.StartTime;
#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;
var useParameterSelect = this.Select.StartsWith("^");
// create request and set iteration invariants
var request = new Amazon.IoT.Model.ListViolationEventsRequest();
if (cmdletContext.BehaviorCriteriaType != null)
{
request.BehaviorCriteriaType = cmdletContext.BehaviorCriteriaType;
}
if (cmdletContext.UtcEndTime != null)
{
request.EndTimeUtc = cmdletContext.UtcEndTime.Value;
}
if (cmdletContext.ListSuppressedAlert != null)
{
request.ListSuppressedAlerts = cmdletContext.ListSuppressedAlert.Value;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.MaxResult.Value);
}
if (cmdletContext.SecurityProfileName != null)
{
request.SecurityProfileName = cmdletContext.SecurityProfileName;
}
if (cmdletContext.UtcStartTime != null)
{
request.StartTimeUtc = cmdletContext.UtcStartTime.Value;
}
if (cmdletContext.ThingName != null)
{
request.ThingName = cmdletContext.ThingName;
}
if (cmdletContext.VerificationState != null)
{
request.VerificationState = cmdletContext.VerificationState;
}
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (cmdletContext.EndTime != null)
{
if (cmdletContext.UtcEndTime != null)
{
throw new System.ArgumentException("Parameters EndTime and UtcEndTime are mutually exclusive.", nameof(this.EndTime));
}
request.EndTime = cmdletContext.EndTime.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.StartTime != null)
{
if (cmdletContext.UtcStartTime != null)
{
throw new System.ArgumentException("Parameters StartTime and UtcStartTime are mutually exclusive.", nameof(this.StartTime));
}
request.StartTime = cmdletContext.StartTime.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("^");
// create request and set iteration invariants
var request = new Amazon.IoT.Model.ListViolationEventsRequest();
if (cmdletContext.BehaviorCriteriaType != null)
{
request.BehaviorCriteriaType = cmdletContext.BehaviorCriteriaType;
}
if (cmdletContext.UtcEndTime != null)
{
request.EndTimeUtc = cmdletContext.UtcEndTime.Value;
}
if (cmdletContext.ListSuppressedAlert != null)
{
request.ListSuppressedAlerts = cmdletContext.ListSuppressedAlert.Value;
}
if (cmdletContext.SecurityProfileName != null)
{
request.SecurityProfileName = cmdletContext.SecurityProfileName;
}
if (cmdletContext.UtcStartTime != null)
{
request.StartTimeUtc = cmdletContext.UtcStartTime.Value;
}
if (cmdletContext.ThingName != null)
{
request.ThingName = cmdletContext.ThingName;
}
if (cmdletContext.VerificationState != null)
{
request.VerificationState = cmdletContext.VerificationState;
}
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (cmdletContext.EndTime != null)
{
if (cmdletContext.UtcEndTime != null)
{
throw new System.ArgumentException("Parameters EndTime and UtcEndTime are mutually exclusive.", nameof(this.EndTime));
}
request.EndTime = cmdletContext.EndTime.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.StartTime != null)
{
if (cmdletContext.UtcStartTime != null)
{
throw new System.ArgumentException("Parameters StartTime and UtcStartTime are mutually exclusive.", nameof(this.StartTime));
}
request.StartTime = cmdletContext.StartTime.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.MaxResult.HasValue)
{
// The service has a maximum page size of 250. 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 250 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.MaxResult;
}
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(250, _emitLimit.Value);
request.MaxResults = 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.ViolationEvents.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.IoT.Model.ListViolationEventsResponse CallAWSServiceOperation(IAmazonIoT client, Amazon.IoT.Model.ListViolationEventsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS IoT", "ListViolationEvents");
try
{
#if DESKTOP
return client.ListViolationEvents(request);
#elif CORECLR
return client.ListViolationEventsAsync(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 Amazon.IoT.BehaviorCriteriaType BehaviorCriteriaType { get; set; }
public System.DateTime? UtcEndTime { get; set; }
public System.Boolean? ListSuppressedAlert { get; set; }
public int? MaxResult { get; set; }
public System.String NextToken { get; set; }
public System.String SecurityProfileName { get; set; }
public System.DateTime? UtcStartTime { get; set; }
public System.String ThingName { get; set; }
public Amazon.IoT.VerificationState VerificationState { get; set; }
[System.ObsoleteAttribute]
public System.DateTime? EndTime { get; set; }
[System.ObsoleteAttribute]
public System.DateTime? StartTime { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.ViolationEvents;
}
}
}