/******************************************************************************* * 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.CloudTrail; using Amazon.CloudTrail.Model; namespace Amazon.PowerShell.Cmdlets.CT { /// /// Looks up management /// events or CloudTrail /// Insights events that are captured by CloudTrail. You can look up events that occurred /// in a Region within the last 90 days. Lookup supports the following attributes for /// management events: /// /// /// Lookup supports the following attributes for Insights events: /// /// All attributes are optional. The default number of results returned is 50, with a /// maximum of 50 possible. The response includes a token that you can use to get the /// next page of results. /// /// The rate of lookup requests is limited to two per second, per account, per Region. /// If this limit is exceeded, a throttling error occurs. ///

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("Find", "CTEvent")] [OutputType("Amazon.CloudTrail.Model.Event")] [AWSCmdlet("Calls the AWS CloudTrail LookupEvents API operation.", Operation = new[] {"LookupEvents"}, SelectReturnType = typeof(Amazon.CloudTrail.Model.LookupEventsResponse), LegacyAlias="Find-CTEvents")] [AWSCmdletOutput("Amazon.CloudTrail.Model.Event or Amazon.CloudTrail.Model.LookupEventsResponse", "This cmdlet returns a collection of Amazon.CloudTrail.Model.Event objects.", "The service call response (type Amazon.CloudTrail.Model.LookupEventsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class FindCTEventCmdlet : AmazonCloudTrailClientCmdlet, IExecutor { #region Parameter EndTime /// /// /// Specifies that only events that occur before or at the specified time are returned. /// If the specified end time is before the specified start time, an error is returned. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.DateTime? EndTime { get; set; } #endregion #region Parameter EventCategory /// /// /// Specifies the event category. If you do not specify an event category, events of the /// category are not returned in the response. For example, if you do not specify insight /// as the value of EventCategory, no Insights events are returned. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.CloudTrail.EventCategory")] public Amazon.CloudTrail.EventCategory EventCategory { get; set; } #endregion #region Parameter LookupAttribute /// /// /// Contains a list of lookup attributes. Currently the list can contain only one item. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("LookupAttributes")] public Amazon.CloudTrail.Model.LookupAttribute[] LookupAttribute { get; set; } #endregion #region Parameter StartTime /// /// /// Specifies that only events that occur after or at the specified time are returned. /// If the specified start time is after the specified end time, an error is returned. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.DateTime? StartTime { get; set; } #endregion #region Parameter MaxResult /// /// /// The number of events to return. Possible values are 1 through 50. The default is 50. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxResults")] public System.Int32? MaxResult { get; set; } #endregion #region Parameter NextToken /// /// /// The token to use to get the next page of results after a previous API call. This token /// must be passed in with the same parameters that were specified in the original call. /// For example, if the original call specified an AttributeKey of 'Username' with a value /// of 'root', the call with NextToken should include those same parameters. /// /// ///
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 Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Events'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.LookupEventsResponse). /// Specifying the name of a property of type Amazon.CloudTrail.Model.LookupEventsResponse 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; } = "Events"; #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.EndTime = this.EndTime; context.EventCategory = this.EventCategory; if (this.LookupAttribute != null) { context.LookupAttribute = new List(this.LookupAttribute); } context.MaxResult = this.MaxResult; context.NextToken = this.NextToken; context.StartTime = this.StartTime; // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members 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.CloudTrail.Model.LookupEventsRequest(); if (cmdletContext.EndTime != null) { request.EndTime = cmdletContext.EndTime.Value; } if (cmdletContext.EventCategory != null) { request.EventCategory = cmdletContext.EventCategory; } if (cmdletContext.LookupAttribute != null) { request.LookupAttributes = cmdletContext.LookupAttribute; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.StartTime != null) { request.StartTime = cmdletContext.StartTime.Value; } // 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; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.CloudTrail.Model.LookupEventsResponse CallAWSServiceOperation(IAmazonCloudTrail client, Amazon.CloudTrail.Model.LookupEventsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS CloudTrail", "LookupEvents"); try { #if DESKTOP return client.LookupEvents(request); #elif CORECLR return client.LookupEventsAsync(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.DateTime? EndTime { get; set; } public Amazon.CloudTrail.EventCategory EventCategory { get; set; } public List LookupAttribute { get; set; } public System.Int32? MaxResult { get; set; } public System.String NextToken { get; set; } public System.DateTime? StartTime { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Events; } } }