/******************************************************************************* * 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.AWSHealth; using Amazon.AWSHealth.Model; namespace Amazon.PowerShell.Cmdlets.HLTH { /// /// Returns a list of entities that have been affected by the specified events, based /// on the specified filter criteria. Entities can refer to individual customer resources, /// groups of customer resources, or any other construct, depending on the Amazon Web /// Service. Events that have impact beyond that of the affected entities, or where the /// extent of impact is unknown, include at least one entity indicating this. /// /// /// /// At least one event ARN is required. ///

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", "HLTHAffectedEntity")] [OutputType("Amazon.AWSHealth.Model.AffectedEntity")] [AWSCmdlet("Calls the AWS Health DescribeAffectedEntities API operation.", Operation = new[] {"DescribeAffectedEntities"}, SelectReturnType = typeof(Amazon.AWSHealth.Model.DescribeAffectedEntitiesResponse))] [AWSCmdletOutput("Amazon.AWSHealth.Model.AffectedEntity or Amazon.AWSHealth.Model.DescribeAffectedEntitiesResponse", "This cmdlet returns a collection of Amazon.AWSHealth.Model.AffectedEntity objects.", "The service call response (type Amazon.AWSHealth.Model.DescribeAffectedEntitiesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetHLTHAffectedEntityCmdlet : AmazonAWSHealthClientCmdlet, IExecutor { #region Parameter Filter_EntityArn /// /// /// A list of entity ARNs (unique identifiers). /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Filter_EntityArns")] public System.String[] Filter_EntityArn { get; set; } #endregion #region Parameter Filter_EntityValue /// /// /// A list of IDs for affected entities. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Filter_EntityValues")] public System.String[] Filter_EntityValue { get; set; } #endregion #region Parameter Filter_EventArn /// /// /// A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", /// "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101" /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyCollection] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Alias("Filter_EventArns")] public System.String[] Filter_EventArn { get; set; } #endregion #region Parameter Filter_LastUpdatedTime /// /// /// A list of the most recent dates and times that the entity was updated. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Filter_LastUpdatedTimes")] public Amazon.AWSHealth.Model.DateTimeRange[] Filter_LastUpdatedTime { get; set; } #endregion #region Parameter Locale /// /// /// The locale (language) to return information in. English (en) is the default and the /// only supported value at this time. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Locale { get; set; } #endregion #region Parameter Filter_StatusCode /// /// /// A list of entity status codes (IMPAIRED, UNIMPAIRED, or /// UNKNOWN). /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Filter_StatusCodes")] public System.String[] Filter_StatusCode { get; set; } #endregion #region Parameter Filter_Tag /// /// /// A map of entity tags attached to the affected entity.Currently, the tags property isn't supported. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Filter_Tags")] public System.Collections.Hashtable[] Filter_Tag { get; set; } #endregion #region Parameter MaxResult /// /// /// The maximum number of items to return in one batch, between 10 and 100, inclusive. /// /// ///
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 /// /// /// If the results of a search are large, only a portion of the results are returned, /// and a nextToken pagination token is returned in the response. To retrieve /// the next batch of results, reissue the search request and include the returned token. /// When all results have been returned, the response does not contain a pagination token /// value. /// /// ///
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 'Entities'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AWSHealth.Model.DescribeAffectedEntitiesResponse). /// Specifying the name of a property of type Amazon.AWSHealth.Model.DescribeAffectedEntitiesResponse 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; } = "Entities"; #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)); } if (this.Filter_EntityArn != null) { context.Filter_EntityArn = new List(this.Filter_EntityArn); } if (this.Filter_EntityValue != null) { context.Filter_EntityValue = new List(this.Filter_EntityValue); } if (this.Filter_EventArn != null) { context.Filter_EventArn = new List(this.Filter_EventArn); } #if MODULAR if (this.Filter_EventArn == null && ParameterWasBound(nameof(this.Filter_EventArn))) { WriteWarning("You are passing $null as a value for parameter Filter_EventArn 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 if (this.Filter_LastUpdatedTime != null) { context.Filter_LastUpdatedTime = new List(this.Filter_LastUpdatedTime); } if (this.Filter_StatusCode != null) { context.Filter_StatusCode = new List(this.Filter_StatusCode); } if (this.Filter_Tag != null) { context.Filter_Tag = new List>(); foreach (var hashTable in this.Filter_Tag) { var d = new Dictionary(); foreach (var hashKey in hashTable.Keys) { d.Add((String)hashKey, (String)(hashTable[hashKey])); } context.Filter_Tag.Add(d); } } context.Locale = this.Locale; 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; // 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.AWSHealth.Model.DescribeAffectedEntitiesRequest(); // populate Filter var requestFilterIsNull = true; request.Filter = new Amazon.AWSHealth.Model.EntityFilter(); List requestFilter_filter_EntityArn = null; if (cmdletContext.Filter_EntityArn != null) { requestFilter_filter_EntityArn = cmdletContext.Filter_EntityArn; } if (requestFilter_filter_EntityArn != null) { request.Filter.EntityArns = requestFilter_filter_EntityArn; requestFilterIsNull = false; } List requestFilter_filter_EntityValue = null; if (cmdletContext.Filter_EntityValue != null) { requestFilter_filter_EntityValue = cmdletContext.Filter_EntityValue; } if (requestFilter_filter_EntityValue != null) { request.Filter.EntityValues = requestFilter_filter_EntityValue; requestFilterIsNull = false; } List requestFilter_filter_EventArn = null; if (cmdletContext.Filter_EventArn != null) { requestFilter_filter_EventArn = cmdletContext.Filter_EventArn; } if (requestFilter_filter_EventArn != null) { request.Filter.EventArns = requestFilter_filter_EventArn; requestFilterIsNull = false; } List requestFilter_filter_LastUpdatedTime = null; if (cmdletContext.Filter_LastUpdatedTime != null) { requestFilter_filter_LastUpdatedTime = cmdletContext.Filter_LastUpdatedTime; } if (requestFilter_filter_LastUpdatedTime != null) { request.Filter.LastUpdatedTimes = requestFilter_filter_LastUpdatedTime; requestFilterIsNull = false; } List requestFilter_filter_StatusCode = null; if (cmdletContext.Filter_StatusCode != null) { requestFilter_filter_StatusCode = cmdletContext.Filter_StatusCode; } if (requestFilter_filter_StatusCode != null) { request.Filter.StatusCodes = requestFilter_filter_StatusCode; requestFilterIsNull = false; } List> requestFilter_filter_Tag = null; if (cmdletContext.Filter_Tag != null) { requestFilter_filter_Tag = cmdletContext.Filter_Tag; } if (requestFilter_filter_Tag != null) { request.Filter.Tags = requestFilter_filter_Tag; requestFilterIsNull = false; } // determine if request.Filter should be set to null if (requestFilterIsNull) { request.Filter = null; } if (cmdletContext.Locale != null) { request.Locale = cmdletContext.Locale; } if (cmdletContext.MaxResult != null) { request.MaxResults = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.MaxResult.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; } #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.AWSHealth.Model.DescribeAffectedEntitiesRequest(); // populate Filter var requestFilterIsNull = true; request.Filter = new Amazon.AWSHealth.Model.EntityFilter(); List requestFilter_filter_EntityArn = null; if (cmdletContext.Filter_EntityArn != null) { requestFilter_filter_EntityArn = cmdletContext.Filter_EntityArn; } if (requestFilter_filter_EntityArn != null) { request.Filter.EntityArns = requestFilter_filter_EntityArn; requestFilterIsNull = false; } List requestFilter_filter_EntityValue = null; if (cmdletContext.Filter_EntityValue != null) { requestFilter_filter_EntityValue = cmdletContext.Filter_EntityValue; } if (requestFilter_filter_EntityValue != null) { request.Filter.EntityValues = requestFilter_filter_EntityValue; requestFilterIsNull = false; } List requestFilter_filter_EventArn = null; if (cmdletContext.Filter_EventArn != null) { requestFilter_filter_EventArn = cmdletContext.Filter_EventArn; } if (requestFilter_filter_EventArn != null) { request.Filter.EventArns = requestFilter_filter_EventArn; requestFilterIsNull = false; } List requestFilter_filter_LastUpdatedTime = null; if (cmdletContext.Filter_LastUpdatedTime != null) { requestFilter_filter_LastUpdatedTime = cmdletContext.Filter_LastUpdatedTime; } if (requestFilter_filter_LastUpdatedTime != null) { request.Filter.LastUpdatedTimes = requestFilter_filter_LastUpdatedTime; requestFilterIsNull = false; } List requestFilter_filter_StatusCode = null; if (cmdletContext.Filter_StatusCode != null) { requestFilter_filter_StatusCode = cmdletContext.Filter_StatusCode; } if (requestFilter_filter_StatusCode != null) { request.Filter.StatusCodes = requestFilter_filter_StatusCode; requestFilterIsNull = false; } List> requestFilter_filter_Tag = null; if (cmdletContext.Filter_Tag != null) { requestFilter_filter_Tag = cmdletContext.Filter_Tag; } if (requestFilter_filter_Tag != null) { request.Filter.Tags = requestFilter_filter_Tag; requestFilterIsNull = false; } // determine if request.Filter should be set to null if (requestFilterIsNull) { request.Filter = null; } if (cmdletContext.Locale != null) { request.Locale = cmdletContext.Locale; } // 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 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.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(100, _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.Entities.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 >= 10)); if (useParameterSelect) { WriteObject(cmdletContext.Select(null, this)); } return null; } #endif public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.AWSHealth.Model.DescribeAffectedEntitiesResponse CallAWSServiceOperation(IAmazonAWSHealth client, Amazon.AWSHealth.Model.DescribeAffectedEntitiesRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Health", "DescribeAffectedEntities"); try { #if DESKTOP return client.DescribeAffectedEntities(request); #elif CORECLR return client.DescribeAffectedEntitiesAsync(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 List Filter_EntityArn { get; set; } public List Filter_EntityValue { get; set; } public List Filter_EventArn { get; set; } public List Filter_LastUpdatedTime { get; set; } public List Filter_StatusCode { get; set; } public List> Filter_Tag { get; set; } public System.String Locale { get; set; } public int? MaxResult { get; set; } public System.String NextToken { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Entities; } } }