/******************************************************************************* * 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.GameLift; using Amazon.GameLift.Model; namespace Amazon.PowerShell.Cmdlets.GML { /// <summary> /// <b>This operation is used with the Amazon GameLift FleetIQ solution and game server /// groups.</b><para> /// Retrieves status information about the Amazon EC2 instances associated with a Amazon /// GameLift FleetIQ game server group. Use this operation to detect when instances are /// active or not available to host new game servers. /// </para><para> /// To request status for all instances in the game server group, provide a game server /// group ID only. To request status for specific instances, provide the game server group /// ID and one or more instance IDs. Use the pagination parameters to retrieve results /// in sequential segments. If successful, a collection of <code>GameServerInstance</code> /// objects is returned. /// </para><para> /// This operation is not designed to be called with every game server claim request; /// this practice can cause you to exceed your API limit, which results in errors. Instead, /// as a best practice, cache the results and refresh your cache no more than once every /// 10 seconds. /// </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">Amazon /// GameLift FleetIQ Guide</a></para><br/><br/>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. /// </summary> [Cmdlet("Get", "GMLGameServerInstance")] [OutputType("Amazon.GameLift.Model.DescribeGameServerInstancesResponse")] [AWSCmdlet("Calls the Amazon GameLift Service DescribeGameServerInstances API operation.", Operation = new[] {"DescribeGameServerInstances"}, SelectReturnType = typeof(Amazon.GameLift.Model.DescribeGameServerInstancesResponse))] [AWSCmdletOutput("Amazon.GameLift.Model.DescribeGameServerInstancesResponse", "This cmdlet returns an Amazon.GameLift.Model.DescribeGameServerInstancesResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetGMLGameServerInstanceCmdlet : AmazonGameLiftClientCmdlet, IExecutor { #region Parameter GameServerGroupName /// <summary> /// <para> /// <para>A unique identifier for the game server group. Use either the name or ARN value.</para> /// </para> /// </summary> #if !MODULAR [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] #else [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String GameServerGroupName { get; set; } #endregion #region Parameter InstanceId /// <summary> /// <para> /// <para>The Amazon EC2 instance IDs that you want to retrieve status on. Amazon EC2 instance /// IDs use a 17-character format, for example: <code>i-1234567890abcdef0</code>. To retrieve /// all instances in the game server group, leave this parameter empty. </para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("InstanceIds")] public System.String[] InstanceId { get; set; } #endregion #region Parameter Limit /// <summary> /// <para> /// <para>The maximum number of results to return. Use this parameter with <code>NextToken</code> /// to get results as a set of sequential pages.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? Limit { get; set; } #endregion #region Parameter NextToken /// <summary> /// <para> /// <para>A token that indicates the start of the next sequential page of results. Use the token /// that is returned with a previous call to this operation. To start at the beginning /// of the result set, do not specify a value.</para> /// </para> /// <para> /// <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. /// <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NextToken { get; set; } #endregion #region Parameter Select /// <summary> /// Use the -Select parameter to control the cmdlet output. The default value is '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeGameServerInstancesResponse). /// Specifying the name of a property of type Amazon.GameLift.Model.DescribeGameServerInstancesResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "*"; #endregion #region Parameter PassThru /// <summary> /// Changes the cmdlet behavior to return the value passed to the GameServerGroupName parameter. /// The -PassThru parameter is deprecated, use -Select '^GameServerGroupName' instead. This parameter will be removed in a future version. /// </summary> [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^GameServerGroupName' 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 /// <summary> /// 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. /// </summary> [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<Amazon.GameLift.Model.DescribeGameServerInstancesResponse, GetGMLGameServerInstanceCmdlet>(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.GameServerGroupName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.GameServerGroupName = this.GameServerGroupName; #if MODULAR if (this.GameServerGroupName == null && ParameterWasBound(nameof(this.GameServerGroupName))) { WriteWarning("You are passing $null as a value for parameter GameServerGroupName 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.InstanceId != null) { context.InstanceId = new List<System.String>(this.InstanceId); } context.Limit = this.Limit; 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 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.GameLift.Model.DescribeGameServerInstancesRequest(); if (cmdletContext.GameServerGroupName != null) { request.GameServerGroupName = cmdletContext.GameServerGroupName; } if (cmdletContext.InstanceId != null) { request.InstanceIds = cmdletContext.InstanceId; } if (cmdletContext.Limit != null) { request.Limit = cmdletContext.Limit.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.GameLift.Model.DescribeGameServerInstancesResponse CallAWSServiceOperation(IAmazonGameLift client, Amazon.GameLift.Model.DescribeGameServerInstancesRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon GameLift Service", "DescribeGameServerInstances"); try { #if DESKTOP return client.DescribeGameServerInstances(request); #elif CORECLR return client.DescribeGameServerInstancesAsync(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 GameServerGroupName { get; set; } public List<System.String> InstanceId { get; set; } public System.Int32? Limit { get; set; } public System.String NextToken { get; set; } public System.Func<Amazon.GameLift.Model.DescribeGameServerInstancesResponse, GetGMLGameServerInstanceCmdlet, object> Select { get; set; } = (response, cmdlet) => response; } } }