/******************************************************************************* * 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 { /// /// Retrieves all active game sessions that match a set of search criteria and sorts them /// into a specified order. /// /// /// /// This operation is not designed to be continually called to track game session status. /// This practice can cause you to exceed your API limit, which results in errors. Instead, /// you must configure configure an Amazon Simple Notification Service (SNS) topic to /// receive notifications from FlexMatch or queues. Continuously polling game session /// status with DescribeGameSessions should only be used for games in development /// with low game session usage. /// /// When searching for game sessions, you specify exactly where you want to search and /// provide a search filter expression, a sort expression, or both. A search request can /// search only one fleet, but it can search all of a fleet's locations. /// /// This operation can be used in the following ways: /// /// Use the pagination parameters to retrieve results as a set of sequential pages. /// /// If successful, a GameSession object is returned for each game session /// that matches the request. Search finds game sessions that are in ACTIVE /// status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions /// . /// /// You can search or sort by the following game session attributes: /// /// Returned values for playerSessionCount and hasAvailablePlayerSessions /// change quickly as players join sessions and others drop out. Results should be considered /// a snapshot in time. Be sure to refresh search results often, and handle sessions that /// fill up before a player can join. /// All /// APIs by task

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", "GMLGameSession")] [OutputType("Amazon.GameLift.Model.GameSession")] [AWSCmdlet("Calls the Amazon GameLift Service SearchGameSessions API operation.", Operation = new[] {"SearchGameSessions"}, SelectReturnType = typeof(Amazon.GameLift.Model.SearchGameSessionsResponse))] [AWSCmdletOutput("Amazon.GameLift.Model.GameSession or Amazon.GameLift.Model.SearchGameSessionsResponse", "This cmdlet returns a collection of Amazon.GameLift.Model.GameSession objects.", "The service call response (type Amazon.GameLift.Model.SearchGameSessionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class FindGMLGameSessionCmdlet : AmazonGameLiftClientCmdlet, IExecutor { #region Parameter AliasId /// /// /// A unique identifier for the alias associated with the fleet to search for active game /// sessions. You can use either the alias ID or ARN value. Each request must reference /// either a fleet ID or alias ID, but not both. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AliasId { get; set; } #endregion #region Parameter FilterExpression /// /// /// String containing the search criteria for the session search. If no filter expression /// is included, the request returns results for all game sessions in the fleet that are /// in ACTIVE status.A filter expression can contain one or multiple conditions. Each condition consists /// of the following:To chain multiple conditions in a single expression, use the logical keywords AND, /// OR, and NOT and parentheses as needed. For example: x /// AND y AND NOT z, NOT (x OR y).Session search evaluates conditions from left to right using the following precedence /// rules:
  1. =, <>, <, >, <=, /// >=
  2. Parentheses
  3. NOT
  4. AND
  5. OR
For example, this filter expression retrieves game sessions hosting at least ten players /// that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true". /// /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String FilterExpression { get; set; } #endregion #region Parameter FleetId /// /// /// A unique identifier for the fleet to search for active game sessions. You can use /// either the fleet ID or ARN value. Each request must reference either a fleet ID or /// alias ID, but not both. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String FleetId { get; set; } #endregion #region Parameter Location /// /// /// A fleet location to search for game sessions. You can specify a fleet's home Region /// or a remote location. Use the Amazon Web Services Region code format, such as us-west-2. /// /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Location { get; set; } #endregion #region Parameter SortExpression /// /// /// Instructions on how to sort the search results. If no sort expression is included, /// the request returns results in random order. A sort expression consists of the following /// elements:For example, this sort expression returns the oldest active sessions first: "SortExpression": /// "creationTimeMillis ASC". Results with a null value for the sort operand are /// returned at the end of the list. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SortExpression { get; set; } #endregion #region Parameter Limit /// /// /// The maximum number of results to return. Use this parameter with NextToken /// to get results as a set of sequential pages. The maximum number of results returned /// is 20, even if this value is not set or is set higher than 20. /// /// ///
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")] public int? Limit { get; set; } #endregion #region Parameter NextToken /// /// /// 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. /// /// ///
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 'GameSessions'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.SearchGameSessionsResponse). /// Specifying the name of a property of type Amazon.GameLift.Model.SearchGameSessionsResponse 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; } = "GameSessions"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the FleetId parameter. /// The -PassThru parameter is deprecated, use -Select '^FleetId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^FleetId' 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.FleetId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AliasId = this.AliasId; context.FilterExpression = this.FilterExpression; context.FleetId = this.FleetId; context.Limit = this.Limit; #if !MODULAR if (ParameterWasBound(nameof(this.Limit)) && this.Limit.HasValue) { WriteWarning("AWSPowerShell and AWSPowerShell.NetCore use the Limit 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 Limit" + " to the service to specify how many items should be returned by each service call."); } #endif context.Location = this.Location; context.NextToken = this.NextToken; context.SortExpression = this.SortExpression; // 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.GameLift.Model.SearchGameSessionsRequest(); if (cmdletContext.AliasId != null) { request.AliasId = cmdletContext.AliasId; } if (cmdletContext.FilterExpression != null) { request.FilterExpression = cmdletContext.FilterExpression; } if (cmdletContext.FleetId != null) { request.FleetId = cmdletContext.FleetId; } if (cmdletContext.Limit != null) { request.Limit = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.Limit.Value); } if (cmdletContext.Location != null) { request.Location = cmdletContext.Location; } if (cmdletContext.SortExpression != null) { request.SortExpression = cmdletContext.SortExpression; } // 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.GameLift.Model.SearchGameSessionsRequest(); if (cmdletContext.AliasId != null) { request.AliasId = cmdletContext.AliasId; } if (cmdletContext.FilterExpression != null) { request.FilterExpression = cmdletContext.FilterExpression; } if (cmdletContext.FleetId != null) { request.FleetId = cmdletContext.FleetId; } if (cmdletContext.Location != null) { request.Location = cmdletContext.Location; } if (cmdletContext.SortExpression != null) { request.SortExpression = cmdletContext.SortExpression; } // 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.Limit.HasValue) { _emitLimit = cmdletContext.Limit; } var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.NextToken = _nextToken; if (_emitLimit.HasValue) { request.Limit = AutoIterationHelpers.ConvertEmitLimitToInt32(_emitLimit.Value); } 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.GameSessions.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.GameLift.Model.SearchGameSessionsResponse CallAWSServiceOperation(IAmazonGameLift client, Amazon.GameLift.Model.SearchGameSessionsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon GameLift Service", "SearchGameSessions"); try { #if DESKTOP return client.SearchGameSessions(request); #elif CORECLR return client.SearchGameSessionsAsync(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 AliasId { get; set; } public System.String FilterExpression { get; set; } public System.String FleetId { get; set; } public int? Limit { get; set; } public System.String Location { get; set; } public System.String NextToken { get; set; } public System.String SortExpression { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.GameSessions; } } }