AWS.Tools.GameLift.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.GameLift</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.GML.AddGMLResourceTagCmdlet"> <summary> Assigns a tag to an Amazon GameLift resource. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, and more. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging. <para> To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the resource. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i></para><para><a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/"> Amazon Web Services Tagging Strategies</a></para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.AddGMLResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that uniquely identifies the Amazon GameLift resource that you want to assign tags to. Amazon GameLift includes resource ARNs in the data object for the resource. You can retrieve the ARN by calling a <c>List</c> or <c>Describe</c> operation for the resource type. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.AddGMLResourceTagCmdlet.Tag"> <summary> <para> <para>A list of one or more tags to assign to the specified Amazon GameLift resource. Tags are developer-defined and structured as key-value pairs. The maximum tag limit may be lower than stated. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> for tagging limits.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.AddGMLResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.AddGMLResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.AddGMLResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.ConfirmGMLMatchCmdlet"> <summary> Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit. <para> When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status <c>REQUIRES_ACCEPTANCE</c>. This is a trigger for your game to get acceptance from all players in each ticket. Calls to this action are only valid for tickets that are in this status; calls for tickets not in this status result in an error. </para><para> To register acceptance, specify the ticket ID, one or more players, and an acceptance response. When all players have accepted, Amazon GameLift advances the matchmaking tickets to status <c>PLACING</c>, and attempts to create a new game session for the match. </para><para> If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. Each matchmaking ticket in the failed match is handled as follows: </para><ul><li><para> If the ticket has one or more players who rejected the match or failed to respond, the ticket status is set <c>CANCELLED</c> and processing is terminated. </para></li><li><para> If all players in the ticket accepted the match, the ticket status is returned to <c>SEARCHING</c> to find a new match. </para></li></ul><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html"> Add FlexMatch to a game client</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html"> FlexMatch events</a> (reference) </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.ConfirmGMLMatchCmdlet.AcceptanceType"> <summary> <para> <para>Player response to the proposed match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.ConfirmGMLMatchCmdlet.PlayerId"> <summary> <para> <para>A unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.ConfirmGMLMatchCmdlet.TicketId"> <summary> <para> <para>A unique identifier for a matchmaking ticket. The ticket must be in status <c>REQUIRES_ACCEPTANCE</c>; otherwise this request will fail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.ConfirmGMLMatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.AcceptMatchResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.ConfirmGMLMatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TicketId parameter. The -PassThru parameter is deprecated, use -Select '^TicketId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.ConfirmGMLMatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.FindGMLGameSessionCmdlet"> <summary> Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order. <para> This operation is not designed to continually track game session status because that practice can cause you to exceed your API limit and generate errors. Instead, configure an Amazon Simple Notification Service (Amazon SNS) topic to receive notifications from a matchmaker or a game session placement queue. </para><para> 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. </para><para> This operation can be used in the following ways: </para><ul><li><para> To search all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID. This approach returns game sessions in the fleet's home Region and all remote locations that fit the search criteria. </para></li><li><para> To search all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name. For location, you can specify a fleet's home Region or any remote location. </para></li></ul><para> Use the pagination parameters to retrieve results as a set of sequential pages. </para><para> If successful, a <c>GameSession</c> object is returned for each game session that matches the request. Search finds game sessions that are in <c>ACTIVE</c> status only. To retrieve information on game sessions in other statuses, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessions.html">DescribeGameSessions</a> . </para><para> To set search and sort criteria, create a filter expression using the following game session attributes. For game session search examples, see the Examples section of this topic. </para><ul><li><para><b>gameSessionId</b> -- A unique identifier for the game session. You can use either a <c>GameSessionId</c> or <c>GameSessionArn</c> value. </para></li><li><para><b>gameSessionName</b> -- Name assigned to a game session. Game session names do not need to be unique to a game session. </para></li><li><para><b>gameSessionProperties</b> -- A set of key-value pairs that can store custom data in a game session. For example: <c>{"Key": "difficulty", "Value": "novice"}</c>. The filter expression must specify the <a>GameProperty</a> -- a <c>Key</c> and a string <c>Value</c> to search for the game sessions. </para><para> For example, to search for the above key-value pair, specify the following search filter: <c>gameSessionProperties.difficulty = "novice"</c>. All game property values are searched as strings. </para><para> For examples of searching game sessions, see the ones below, and also see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-search">Search game sessions by game property</a>. </para></li><li><para><b>maximumSessions</b> -- Maximum number of player sessions allowed for a game session. </para></li><li><para><b>creationTimeMillis</b> -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds. </para></li><li><para><b>playerSessionCount</b> -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out. </para></li><li><para><b>hasAvailablePlayerSessions</b> -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join. </para></li></ul><note><para> Returned values for <c>playerSessionCount</c> and <c>hasAvailablePlayerSessions</c> 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. </para></note><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.FindGMLGameSessionCmdlet.AliasId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.FindGMLGameSessionCmdlet.FilterExpression"> <summary> <para> <para>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 <c>ACTIVE</c> status.</para><para>A filter expression can contain one or multiple conditions. Each condition consists of the following:</para><ul><li><para><b>Operand</b> -- Name of a game session attribute. Valid values are <c>gameSessionName</c>, <c>gameSessionId</c>, <c>gameSessionProperties</c>, <c>maximumSessions</c>, <c>creationTimeMillis</c>, <c>playerSessionCount</c>, <c>hasAvailablePlayerSessions</c>.</para></li><li><para><b>Comparator</b> -- Valid comparators are: <c>=</c>, <c><></c>, <c><</c>, <c>></c>, <c><=</c>, <c>>=</c>. </para></li><li><para><b>Value</b> -- Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators <c>=</c> and <c><></c>. For example, the following filter expression searches on <c>gameSessionName</c>: "<c>FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'"</c>. </para></li></ul><para>To chain multiple conditions in a single expression, use the logical keywords <c>AND</c>, <c>OR</c>, and <c>NOT</c> and parentheses as needed. For example: <c>x AND y AND NOT z</c>, <c>NOT (x OR y)</c>.</para><para>Session search evaluates conditions from left to right using the following precedence rules:</para><ol><li><para><c>=</c>, <c><></c>, <c><</c>, <c>></c>, <c><=</c>, <c>>=</c></para></li><li><para>Parentheses</para></li><li><para>NOT</para></li><li><para>AND</para></li><li><para>OR</para></li></ol><para>For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: <c>"maximumSessions>=10 AND hasAvailablePlayerSessions=true"</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.FindGMLGameSessionCmdlet.FleetId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.FindGMLGameSessionCmdlet.Location"> <summary> <para> <para>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 <c>us-west-2</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.FindGMLGameSessionCmdlet.SortExpression"> <summary> <para> <para>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:</para><ul><li><para><b>Operand</b> -- Name of a game session attribute. Valid values are <c>gameSessionName</c>, <c>gameSessionId</c>, <c>gameSessionProperties</c>, <c>maximumSessions</c>, <c>creationTimeMillis</c>, <c>playerSessionCount</c>, <c>hasAvailablePlayerSessions</c>.</para></li><li><para><b>Order</b> -- Valid sort orders are <c>ASC</c> (ascending) and <c>DESC</c> (descending).</para></li></ul><para>For example, this sort expression returns the oldest active sessions first: <c>"SortExpression": "creationTimeMillis ASC"</c>. Results with a null value for the sort operand are returned at the end of the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.FindGMLGameSessionCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> 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. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.FindGMLGameSessionCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.FindGMLGameSessionCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.FindGMLGameSessionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.FindGMLGameSessionCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLAliasCmdlet"> <summary> Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages. <note><para> Returned aliases are not listed in any particular order. </para></note><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLAliasCmdlet.Name"> <summary> <para> <para>A descriptive label that is associated with an alias. Alias names do not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLAliasCmdlet.RoutingStrategyType"> <summary> <para> <para>The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.</para><para>Possible routing types include the following:</para><ul><li><para><b>SIMPLE</b> -- The alias resolves to one specific fleet. Use this type when routing to active fleets.</para></li><li><para><b>TERMINAL</b> -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_RoutingStrategy.html">RoutingStrategy</a> message embedded.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLAliasCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLAliasCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Aliases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.ListAliasesResponse). Specifying the name of a property of type Amazon.GameLift.Model.ListAliasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLAliasCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLAliasDetailCmdlet"> <summary> Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use <c>ResolveAlias</c>. <para> To get alias properties, specify the alias ID. If successful, the requested alias record is returned. </para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLAliasDetailCmdlet.AliasId"> <summary> <para> <para>The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLAliasDetailCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Alias'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeAliasResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLAliasDetailCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AliasId parameter. The -PassThru parameter is deprecated, use -Select '^AliasId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLBuildCmdlet"> <summary> Retrieves build resources for all builds associated with the Amazon Web Services account in use. You can limit results to builds that are in a specific status by using the <c>Status</c> parameter. Use the pagination parameters to retrieve results in a set of sequential pages. <note><para> Build resources are not listed in any particular order. </para></note><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html"> Upload a Custom Server Build</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLBuildCmdlet.Status"> <summary> <para> <para>Build status to filter results by. To retrieve all builds, leave this parameter empty.</para><para>Possible build statuses include the following:</para><ul><li><para><b>INITIALIZED</b> -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value. </para></li><li><para><b>READY</b> -- The game build has been successfully uploaded. You can now create new fleets for this build.</para></li><li><para><b>FAILED</b> -- The game build upload failed. You cannot create new fleets for this build. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLBuildCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLBuildCmdlet.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, don't 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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLBuildCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Builds'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.ListBuildsResponse). Specifying the name of a property of type Amazon.GameLift.Model.ListBuildsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLBuildCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Status parameter. The -PassThru parameter is deprecated, use -Select '^Status' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLBuildCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLBuildDetailCmdlet"> <summary> Retrieves properties for a custom game build. To request a build resource, specify a build ID. If successful, an object containing the build properties is returned. <para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html"> Upload a Custom Server Build</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLBuildDetailCmdlet.BuildId"> <summary> <para> <para>A unique identifier for the build to retrieve properties for. You can use either the build ID or ARN value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLBuildDetailCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Build'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeBuildResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeBuildResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLBuildDetailCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BuildId parameter. The -PassThru parameter is deprecated, use -Select '^BuildId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeCmdlet"> <summary> <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b><para> Retrieves properties for a compute resource in an Amazon GameLift fleet. To get a list of all computes in a fleet, call <a>ListCompute</a>. </para><para> To request information on a specific compute, provide the fleet ID and compute name. </para><para> If successful, this operation returns details for the requested compute resource. Depending on the fleet's compute type, the result includes the following information: </para><ul><li><para> For <c>EC2</c> fleets, this operation returns information about the EC2 instance. </para></li><li><para> For <c>ANYWHERE</c> fleets, this operation returns information about the registered compute. </para></li><li><para> For <c>CONTAINER</c> fleets, this operation returns information about the container that's registered as a compute, and the instance it's running on. The compute name is the container name. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeCmdlet.ComputeName"> <summary> <para> <para>The unique identifier of the compute resource to retrieve properties for. For an Anywhere fleet compute, use the registered compute name. For an EC2 fleet instance, use the instance ID. For a container fleet, use the compute name (for example, <c>a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9</c>) or the compute ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet that the compute belongs to. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Compute'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeComputeResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeComputeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ComputeName parameter. The -PassThru parameter is deprecated, use -Select '^ComputeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeAccessCmdlet"> <summary> <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b><para> Requests authorization to remotely connect to a hosting resource in a Amazon GameLift managed fleet. This operation is not used with Amazon GameLift Anywhere fleets </para><para> To request access, specify the compute name and the fleet ID. If successful, this operation returns a set of temporary Amazon Web Services credentials, including a two-part access key and a session token. </para><para><b>EC2 fleets</b></para><para> With an EC2 fleet (where compute type is <c>EC2</c>), use these credentials with Amazon EC2 Systems Manager (SSM) to start a session with the compute. For more details, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html#sessions-start-cli"> Starting a session (CLI)</a> in the <i>Amazon EC2 Systems Manager User Guide</i>. </para><para><b>Container fleets</b></para><para> With a container fleet (where compute type is <c>CONTAINER</c>), use these credentials and the target value with SSM to connect to the fleet instance where the container is running. After you're connected to the instance, use Docker commands to interact with the container. </para><para><b>Learn more</b></para><ul><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html">Remotely connect to fleet instances</a></para></li><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html">Debug fleet issues</a></para></li><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-remote-access.html"> Remotely connect to a container fleet</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeAccessCmdlet.ComputeName"> <summary> <para> <para>A unique identifier for the compute resource that you want to connect to. For an EC2 fleet compute, use the instance ID. For a container fleet, use the compute name (for example, <c>a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9</c>) or the compute ARN. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeAccessCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet that holds the compute resource that you want to connect to. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeAccessCmdlet.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.GetComputeAccessResponse). Specifying the name of a property of type Amazon.GameLift.Model.GetComputeAccessResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeAccessCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ComputeName parameter. The -PassThru parameter is deprecated, use -Select '^ComputeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeAuthTokenCmdlet"> <summary> Requests an authentication token from Amazon GameLift for a compute resource in an Amazon GameLift Anywhere fleet or container fleet. Game servers that are running on the compute use this token to communicate with the Amazon GameLift service, such as when calling the Amazon GameLift server SDK action <c>InitSDK()</c>. Authentication tokens are valid for a limited time span, so you need to request a fresh token before the current token expires. <para> Use this operation based on the fleet compute type: </para><ul><li><para> For <c>EC2</c> fleets, auth token retrieval and refresh is handled automatically. All game servers that are running on all fleet instances have access to a valid auth token. </para></li><li><para> For <c>ANYWHERE</c> and <c>CONTAINER</c> fleets, if you're using the Amazon GameLift Agent, auth token retrieval and refresh is handled automatically for any container or Anywhere compute where the Agent is running. If you're not using the Agent, create a mechanism to retrieve and refresh auth tokens for computes that are running game server processes. </para></li></ul><para><b>Learn more</b></para><ul><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-anywhere.html">Create an Anywhere fleet</a></para></li><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing.html">Test your integration</a></para></li><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html">Server SDK reference guides</a> (for version 5.x) </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeAuthTokenCmdlet.ComputeName"> <summary> <para> <para>The name of the compute resource you are requesting the authentication token for. For an Anywhere fleet compute, use the registered compute name. For an EC2 fleet instance, use the instance ID. For a container fleet, use the compute name (for example, <c>a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9</c>) or the compute ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeAuthTokenCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet that the compute is registered to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeAuthTokenCmdlet.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.GetComputeAuthTokenResponse). Specifying the name of a property of type Amazon.GameLift.Model.GetComputeAuthTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeAuthTokenCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ComputeName parameter. The -PassThru parameter is deprecated, use -Select '^ComputeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeListCmdlet"> <summary> <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b><para> Retrieves information on the compute resources in an Amazon GameLift fleet. </para><para> To request a list of computes, specify the fleet ID. Use the pagination parameters to retrieve results in a set of sequential pages. </para><para> You can filter the result set by location. </para><para> If successful, this operation returns information on all computes in the requested fleet. Depending on the fleet's compute type, the result includes the following information: </para><ul><li><para> For <c>EC2</c> fleets, this operation returns information about the EC2 instance. Compute names are instance IDs. </para></li><li><para> For <c>ANYWHERE</c> fleets, this operation returns the compute names and details provided when the compute was registered with <c>RegisterCompute</c>. The <c>GameLiftServiceSdkEndpoint</c> or <c>GameLiftAgentEndpoint</c> is included. </para></li><li><para> For <c>CONTAINER</c> fleets, this operation returns information about containers that are registered as computes, and the instances they're running on. Compute names are container names. </para></li></ul><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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeListCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to retrieve compute resources for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeListCmdlet.Location"> <summary> <para> <para>The name of a location to retrieve compute resources for. For an Amazon GameLift Anywhere fleet, use a custom location. For a multi-location EC2 or container fleet, provide a Amazon Web Services Region or Local Zone code (for example: <c>us-west-2</c> or <c>us-west-2-lax-1</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeListCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeListCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ComputeList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.ListComputeResponse). Specifying the name of a property of type Amazon.GameLift.Model.ListComputeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLComputeListCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLContainerGroupDefinitionCmdlet"> <summary> <b>This operation is used with the Amazon GameLift containers feature, which is currently in public preview. </b><para> Retrieves the properties of a container group definition, including all container definitions in the group. </para><para> To retrieve a container group definition, provide a resource identifier. If successful, this operation returns the complete properties of the container group definition. </para><para><b>Learn more</b></para><ul><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html">Manage a container group definition</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLContainerGroupDefinitionCmdlet.Name"> <summary> <para> <para>The unique identifier for the container group definition to retrieve properties for. You can use either the <c>Name</c> or <c>ARN</c> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLContainerGroupDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContainerGroupDefinition'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeContainerGroupDefinitionResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeContainerGroupDefinitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLContainerGroupDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLContainerGroupDefinitionListCmdlet"> <summary> <b>This operation is used with the Amazon GameLift containers feature, which is currently in public preview. </b><para> Retrieves all container group definitions for the Amazon Web Services account and Amazon Web Services Region that are currently in use. You can filter the result set by the container groups' scheduling strategy. Use the pagination parameters to retrieve results in a set of sequential pages. </para><note><para> This operation returns the list of container group definitions in no particular order. </para></note><para><b>Learn more</b></para><ul><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html">Manage a container group definition</a></para></li></ul><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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLContainerGroupDefinitionListCmdlet.SchedulingStrategy"> <summary> <para> <para>The type of container group definitions to retrieve.</para><ul><li><para><c>DAEMON</c> -- Daemon container groups run background processes and are deployed once per fleet instance.</para></li><li><para><c>REPLICA</c> -- Replica container groups run your game server application and supporting software. Replica groups might be deployed multiple times per fleet instance.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLContainerGroupDefinitionListCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLContainerGroupDefinitionListCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLContainerGroupDefinitionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContainerGroupDefinitions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.ListContainerGroupDefinitionsResponse). Specifying the name of a property of type Amazon.GameLift.Model.ListContainerGroupDefinitionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLContainerGroupDefinitionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SchedulingStrategy parameter. The -PassThru parameter is deprecated, use -Select '^SchedulingStrategy' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLContainerGroupDefinitionListCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLEC2InstanceLimitCmdlet"> <summary> Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at <a href="http://aws.amazon.com/ec2/instance-types/">Amazon EC2 Instance Types</a>. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your Amazon GameLift fleets. You can request a limit increase for your account by using the <b>Service limits</b> page in the Amazon GameLift console. <para> Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results: </para><ul><li><para> Request specifies the Region <c>ap-northeast-1</c> with no location. The result is limits and usage data on all instance types that are deployed in <c>us-east-2</c>, by all of the fleets that reside in <c>ap-northeast-1</c>. </para></li><li><para> Request specifies the Region <c>us-east-1</c> with location <c>ca-central-1</c>. The result is limits and usage data on all instance types that are deployed in <c>ca-central-1</c>, by all of the fleets that reside in <c>us-east-2</c>. These limits do not affect fleets in any other Regions that deploy instances to <c>ca-central-1</c>. </para></li><li><para> Request specifies the Region <c>eu-west-1</c> with location <c>ca-central-1</c>. The result is limits and usage data on all instance types that are deployed in <c>ca-central-1</c>, by all of the fleets that reside in <c>eu-west-1</c>. </para></li></ul><para> This operation can be used in the following ways: </para><ul><li><para> To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for. </para></li><li><para> To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for. </para></li></ul><para> If successful, an <c>EC2InstanceLimits</c> object is returned with limits and usage data for each requested instance type. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift fleets</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLEC2InstanceLimitCmdlet.EC2InstanceType"> <summary> <para> <para>Name of an Amazon EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLEC2InstanceLimitCmdlet.Location"> <summary> <para> <para>The name of a remote location to request instance limits for, in the form of an Amazon Web Services Region code such as <c>us-west-2</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLEC2InstanceLimitCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EC2InstanceLimits'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeEC2InstanceLimitsResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeEC2InstanceLimitsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLEC2InstanceLimitCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EC2InstanceType parameter. The -PassThru parameter is deprecated, use -Select '^EC2InstanceType' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCmdlet"> <summary> <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b><para> Retrieves a collection of fleet resources in an Amazon Web Services Region. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only. </para><para> You can use operation in the following ways: </para><ul><li><para> To get a list of all fleets in a Region, don't provide a build or script identifier. </para></li><li><para> To get a list of all fleets where a specific game build is deployed, provide the build ID. </para></li><li><para> To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID. </para></li><li><para> To get a list of all fleets with a specific container group definition, provide the <c>ContainerGroupDefinition</c> ID. </para></li></ul><para> Use the pagination parameters to retrieve results as a set of sequential pages. </para><para> If successful, this operation returns a list of fleet IDs that match the request parameters. A NextToken value is also returned if there are more result pages to retrieve. </para><note><para> Fleet IDs are returned in no particular order. </para></note><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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCmdlet.BuildId"> <summary> <para> <para>A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCmdlet.ContainerGroupDefinitionName"> <summary> <para> <para>The container group definition name to request fleets for. Use this parameter to return only fleets that are deployed with the specified container group definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCmdlet.ScriptId"> <summary> <para> <para>A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FleetIds'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.ListFleetsResponse). Specifying the name of a property of type Amazon.GameLift.Model.ListFleetsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BuildId parameter. The -PassThru parameter is deprecated, use -Select '^BuildId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetAttributeCmdlet"> <summary> <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b><para> Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing hardware and deployment configuration for instances in the fleet. </para><para> You can use this operation in the following ways: </para><ul><li><para> To get attributes for specific fleets, provide a list of fleet IDs or fleet ARNs. </para></li><li><para> To get attributes for all fleets, do not provide a fleet identifier. </para></li></ul><para> When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. </para><para> If successful, a <c>FleetAttributes</c> object is returned for each fleet requested, unless the fleet identifier is not found. </para><note><para> Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number. </para></note><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift fleets</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetAttributeCmdlet.FleetId"> <summary> <para> <para>A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetAttributeCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetAttributeCmdlet.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. This parameter is ignored when the request specifies one or a list of fleet IDs.</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FleetAttributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeFleetAttributesResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeFleetAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetAttributeCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetAttributeCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCapacityCmdlet"> <summary> <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b><para> Retrieves the resource capacity settings for one or more fleets. For a container fleet, this operation also returns counts for replica container groups. </para><para> With multi-location fleets, this operation retrieves data for the fleet's home Region only. To retrieve capacity for remote locations, see <a>DescribeFleetLocationCapacity</a>. </para><para> This operation can be used in the following ways: </para><ul><li><para> To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs. </para></li><li><para> To get capacity data for all fleets, do not provide a fleet identifier. </para></li></ul><para> When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. </para><para> If successful, a <c>FleetCapacity</c> object is returned for each requested fleet ID. Each <c>FleetCapacity</c> object includes a <c>Location</c> property, which is set to the fleet's home Region. Capacity values are returned only for fleets that currently exist. </para><note><para> Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed. </para></note><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift fleets</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCapacityCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCapacityCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCapacityCmdlet.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. This parameter is ignored when the request specifies one or a list of fleet IDs.</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCapacityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FleetCapacity'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeFleetCapacityResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeFleetCapacityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCapacityCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetCapacityCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetEventCmdlet"> <summary> Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations. <para> You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. </para><para> If successful, a collection of event log entries matching the request are returned. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift fleets</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetEventCmdlet.EndTime"> <summary> <para> <para>The most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetEventCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to get event logs for. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetEventCmdlet.StartTime"> <summary> <para> <para>The earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetEventCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetEventCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetEventCmdlet.Select"> <summary> 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.GameLift.Model.DescribeFleetEventsResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeFleetEventsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetEventCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationAttributeCmdlet"> <summary> Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity. <para> This operation can be used in the following ways: </para><ul><li><para> To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested. </para></li><li><para> To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order. </para></li></ul><para> When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages. </para><para> If successful, a <c>LocationAttributes</c> object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call <c>DescribeFleetAttributes</c>. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift fleets</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationAttributeCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationAttributeCmdlet.Location"> <summary> <para> <para>A list of fleet locations to retrieve information for. Specify locations in the form of an Amazon Web Services Region code, such as <c>us-west-2</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationAttributeCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages. This limit is not currently enforced.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationAttributeCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationAttributeCmdlet.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.DescribeFleetLocationAttributesResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeFleetLocationAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationAttributeCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationAttributeCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationCapacityCmdlet"> <summary> Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. For a container fleet, this operation also returns counts for replica container groups. <para> Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling <c>DescribeFleetCapacity</c>). </para><para> To retrieve capacity data, identify a fleet and location. </para><para> If successful, a <c>FleetCapacity</c> object is returned for the requested fleet location. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift fleets</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationCapacityCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to request location capacity for. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationCapacityCmdlet.Location"> <summary> <para> <para>The fleet location to retrieve capacity information for. Specify a location in the form of an Amazon Web Services Region code, such as <c>us-west-2</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationCapacityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FleetCapacity'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeFleetLocationCapacityResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeFleetLocationCapacityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationCapacityCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationUtilizationCmdlet"> <summary> Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling <c>DescribeFleetUtilization</c>). <para> To retrieve utilization data, identify a fleet and location. </para><para> If successful, a <c>FleetUtilization</c> object is returned for the requested fleet location. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift fleets</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationUtilizationCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to request location utilization for. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationUtilizationCmdlet.Location"> <summary> <para> <para>The fleet location to retrieve utilization information for. Specify a location in the form of an Amazon Web Services Region code, such as <c>us-west-2</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationUtilizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FleetUtilization'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeFleetLocationUtilizationResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeFleetLocationUtilizationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetLocationUtilizationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetPortSettingCmdlet"> <summary> Retrieves a fleet's inbound connection permissions. Connection permissions specify IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game server processes that are running in the fleet must use a port that falls within this range. To connect to game server processes on a container fleet, the port settings should include one or more of the fleet's connection ports. <para> Use this operation in the following ways: </para><ul><li><para> To retrieve the port settings for a fleet, identify the fleet's unique identifier. </para></li><li><para> To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations. </para></li></ul><para> If successful, a set of <c>IpPermission</c> objects is returned for the requested fleet ID. When specifying a location, this operation returns a pending status. If the requested fleet has been deleted, the result set is empty. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift fleets</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetPortSettingCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetPortSettingCmdlet.Location"> <summary> <para> <para>A remote location to check for status of port setting updates. Use the Amazon Web Services Region code format, such as <c>us-west-2</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetPortSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InboundPermissions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeFleetPortSettingsResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeFleetPortSettingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetPortSettingCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetUtilizationCmdlet"> <summary> Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationUtilization.html">DescribeFleetLocationUtilization</a> to get utilization statistics for a fleet's remote locations. <para> This operation can be used in the following ways: </para><ul><li><para> To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs. </para></li><li><para> To get utilization data for all fleets, do not provide a fleet identifier. </para></li></ul><para> When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. </para><para> If successful, a <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_FleetUtilization.html">FleetUtilization</a> object is returned for each requested fleet ID, unless the fleet identifier is not found. Each fleet utilization object includes a <c>Location</c> property, which is set to the fleet's home Region. </para><note><para> Some API operations may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed. </para></note><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift Fleets</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift Metrics for Fleets</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetUtilizationCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to retrieve utilization data for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetUtilizationCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetUtilizationCmdlet.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. This parameter is ignored when the request specifies one or a list of fleet IDs.</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetUtilizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FleetUtilization'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeFleetUtilizationResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeFleetUtilizationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetUtilizationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLFleetUtilizationCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerCmdlet"> <summary> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b><para> Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on. </para><para> To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned. </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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerCmdlet.GameServerGroupName"> <summary> <para> <para>A unique identifier for the game server group where the game server is running.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerCmdlet.GameServerId"> <summary> <para> <para>A custom string that uniquely identifies the game server information to be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameServer'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeGameServerResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeGameServerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GameServerId parameter. The -PassThru parameter is deprecated, use -Select '^GameServerId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerGroupCmdlet"> <summary> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b><para> Retrieves information on a game server group. This operation returns only properties related to Amazon GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly. </para><para> To get attributes for a game server group, provide a group name or ARN value. If successful, a <c>GameServerGroup</c> object is returned. </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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerGroupCmdlet.GameServerGroupName"> <summary> <para> <para>A unique identifier for the game server group. Use either the name or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameServerGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeGameServerGroupResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeGameServerGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerGroupCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerGroupListCmdlet"> <summary> Lists a game server groups.<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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerGroupListCmdlet.Limit"> <summary> <para> <para>The game server groups' limit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerGroupListCmdlet.NextToken"> <summary> <para> <para>Specify the pagination token from a previous request to retrieve the next page of results.</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameServerGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.ListGameServerGroupsResponse). Specifying the name of a property of type Amazon.GameLift.Model.ListGameServerGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerGroupListCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerInstanceCmdlet"> <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 <c>GameServerInstance</c> 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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerInstanceCmdlet.GameServerGroupName"> <summary> <para> <para>A unique identifier for the game server group. Use either the name or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerInstanceCmdlet.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: <c>i-1234567890abcdef0</c>. To retrieve all instances in the game server group, leave this parameter empty. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerInstanceCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerInstanceCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerInstanceCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerInstanceCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerInstanceCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerListCmdlet"> <summary> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b><para> Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments. </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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerListCmdlet.GameServerGroupName"> <summary> <para> <para>An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerListCmdlet.SortOrder"> <summary> <para> <para>Indicates how to sort the returned data based on game server registration timestamp. Use <c>ASCENDING</c> to retrieve oldest game servers first, or use <c>DESCENDING</c> to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerListCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerListCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameServers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.ListGameServersResponse). Specifying the name of a property of type Amazon.GameLift.Model.ListGameServersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerListCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameServerListCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionCmdlet"> <summary> Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status. <para> This operation can be used in the following ways: </para><ul><li><para> To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations. </para></li><li><para> To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location. </para></li><li><para> To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request. </para></li></ul><para> Use the pagination parameters to retrieve results as a set of sequential pages. </para><para> If successful, a <c>GameSession</c> object is returned for each game session that matches the request. </para><para> 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 an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with <c>DescribeGameSessions</c> should only be used for games in development with low game session usage. </para><para><i>Available in Amazon GameLift Local.</i></para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find">Find a game session</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionCmdlet.AliasId"> <summary> <para> <para>A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionCmdlet.GameSessionId"> <summary> <para> <para>A unique identifier for the game session to retrieve. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionCmdlet.Location"> <summary> <para> <para>A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as <c>us-west-2</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionCmdlet.StatusFilter"> <summary> <para> <para>Game session status to filter results on. You can filter on the following states: <c>ACTIVE</c>, <c>TERMINATED</c>, <c>ACTIVATING</c>, and <c>TERMINATING</c>. The last two are transitory and used for only very brief periods of time. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionCmdlet.Select"> <summary> 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.DescribeGameSessionsResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeGameSessionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionDetailCmdlet"> <summary> Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status. <para> This operation can be used in the following ways: </para><ul><li><para> To retrieve details for all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns details from the fleet's home Region and all remote locations. </para></li><li><para> To retrieve details for all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location. </para></li><li><para> To retrieve details for a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request. </para></li></ul><para> Use the pagination parameters to retrieve results as a set of sequential pages. </para><para> If successful, a <c>GameSessionDetail</c> object is returned for each game session that matches the request. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find">Find a game session</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionDetailCmdlet.AliasId"> <summary> <para> <para>A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionDetailCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionDetailCmdlet.GameSessionId"> <summary> <para> <para>A unique identifier for the game session to retrieve. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionDetailCmdlet.Location"> <summary> <para> <para>A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as <c>us-west-2</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionDetailCmdlet.StatusFilter"> <summary> <para> <para>Game session status to filter results on. Possible game session statuses include <c>ACTIVE</c>, <c>TERMINATED</c>, <c>ACTIVATING</c> and <c>TERMINATING</c> (the last two are transitory). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionDetailCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionDetailCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionDetailCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameSessionDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeGameSessionDetailsResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeGameSessionDetailsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionDetailCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GameSessionId parameter. The -PassThru parameter is deprecated, use -Select '^GameSessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionDetailCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionLogUrlCmdlet"> <summary> Retrieves the location of stored game session logs for a specified game session on Amazon GameLift managed fleets. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs. <note><para> See the <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift">Amazon Web Services Service Limits</a> page for maximum log file sizes. Log files that exceed this limit are not saved. </para></note><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionLogUrlCmdlet.GameSessionId"> <summary> <para> <para>A unique identifier for the game session to get logs for. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionLogUrlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PreSignedUrl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.GetGameSessionLogUrlResponse). Specifying the name of a property of type Amazon.GameLift.Model.GetGameSessionLogUrlResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionLogUrlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GameSessionId parameter. The -PassThru parameter is deprecated, use -Select '^GameSessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionPlacementCmdlet"> <summary> Retrieves information, including current status, about a game session placement request. <para> To get game session placement details, specify the placement ID. </para><para> 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 with <c>DescribeGameSessionPlacement</c> should only be used for games in development with low game session usage. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionPlacementCmdlet.PlacementId"> <summary> <para> <para>A unique identifier for a game session placement to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionPlacementCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameSessionPlacement'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeGameSessionPlacementResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeGameSessionPlacementResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionPlacementCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PlacementId parameter. The -PassThru parameter is deprecated, use -Select '^PlacementId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionQueueCmdlet"> <summary> Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of queues, objects are returned only for queues that currently exist in the Region. <para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html"> View Your Queues</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionQueueCmdlet.Name"> <summary> <para> <para>A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionQueueCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages. You can request up to 50 results.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionQueueCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionQueueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameSessionQueues'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeGameSessionQueuesResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeGameSessionQueuesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionQueueCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLGameSessionQueueCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLInstanceCmdlet"> <summary> Retrieves information about the EC2 instances in an Amazon GameLift managed fleet, including instance ID, connection data, and status. You can use this operation with a multi-location fleet to get location-specific instance information. As an alternative, use the operations <a>ListCompute</a> and <a>DescribeCompute</a> to retrieve information for compute resources, including EC2 and Anywhere fleets. <para> You can call this operation in the following ways: </para><ul><li><para> To get information on all instances in a fleet's home Region, specify the fleet ID. </para></li><li><para> To get information on all instances in a fleet's remote location, specify the fleet ID and location name. </para></li><li><para> To get information on a specific instance in a fleet, specify the fleet ID and instance ID. </para></li></ul><para> Use the pagination parameters to retrieve results as a set of sequential pages. </para><para> If successful, this operation returns <c>Instance</c> objects for each requested instance, listed in no particular order. If you call this operation for an Anywhere fleet, you receive an InvalidRequestException. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html">Remotely connect to fleet instances</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html">Debug fleet issues</a></para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLInstanceCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLInstanceCmdlet.InstanceId"> <summary> <para> <para>A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLInstanceCmdlet.Location"> <summary> <para> <para>The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as <c>us-west-2</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLInstanceCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLInstanceCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Instances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeInstancesResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeInstancesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLInstanceCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLInstanceCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLInstanceAccessCmdlet"> <summary> Requests authorization to remotely connect to an instance in an Amazon GameLift managed fleet. Use this operation to connect to instances with game servers that use Amazon GameLift server SDK 4.x or earlier. To connect to instances with game servers that use server SDK 5.x or later, call <a>GetComputeAccess</a>. <para> To request access to an instance, specify IDs for the instance and the fleet it belongs to. You can retrieve instance IDs for a fleet by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeInstances.html">DescribeInstances</a> with the fleet ID. </para><para> If successful, this operation returns an IP address and credentials. The returned credentials match the operating system of the instance, as follows: </para><ul><li><para> For a Windows instance: returns a user name and secret (password) for use with a Windows Remote Desktop client. </para></li><li><para> For a Linux instance: returns a user name and secret (RSA private key) for use with an SSH client. You must save the secret to a <c>.pem</c> file. If you're using the CLI, see the example <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetInstanceAccess.html#API_GetInstanceAccess_Examples"> Get credentials for a Linux instance</a> for tips on automatically saving the secret to a <c>.pem</c> file. </para></li></ul><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html">Remotely connect to fleet instances</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html">Debug fleet issues</a></para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLInstanceAccessCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet that contains the instance you want to access. You can request access to instances in EC2 fleets with the following statuses: <c>ACTIVATING</c>, <c>ACTIVE</c>, or <c>ERROR</c>. Use either a fleet ID or an ARN value. </para><note><para>You can access fleets in <c>ERROR</c> status for a short period of time before Amazon GameLift deletes them.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLInstanceAccessCmdlet.InstanceId"> <summary> <para> <para>A unique identifier for the instance you want to access. You can access an instance in any status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLInstanceAccessCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InstanceAccess'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.GetInstanceAccessResponse). Specifying the name of a property of type Amazon.GameLift.Model.GetInstanceAccessResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLInstanceAccessCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLLocationListCmdlet"> <summary> Lists all custom and Amazon Web Services locations.<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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLLocationListCmdlet.Filter"> <summary> <para> <para>Filters the list for <c>AWS</c> or <c>CUSTOM</c> locations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLLocationListCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLLocationListCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLLocationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Locations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.ListLocationsResponse). Specifying the name of a property of type Amazon.GameLift.Model.ListLocationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLLocationListCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingCmdlet"> <summary> Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session. <para> To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists. </para><para> This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html"> Add FlexMatch to a game client</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Set Up FlexMatch event notification</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingCmdlet.TicketId"> <summary> <para> <para>A unique identifier for a matchmaking ticket. You can include up to 10 ID values. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TicketList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeMatchmakingResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeMatchmakingResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TicketId parameter. The -PassThru parameter is deprecated, use -Select '^TicketId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingConfigurationCmdlet"> <summary> Retrieves the details of FlexMatch matchmaking configurations. <para> This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. </para><para> If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/matchmaker-build.html"> Setting up FlexMatch matchmakers</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingConfigurationCmdlet.Name"> <summary> <para> <para>A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name or ARN value. To request all existing configurations, leave this parameter empty.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingConfigurationCmdlet.RuleSetName"> <summary> <para> <para>A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this parameter to retrieve all matchmaking configurations that use this rule set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingConfigurationCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages. This parameter is limited to 10.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingConfigurationCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Configurations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeMatchmakingConfigurationsResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeMatchmakingConfigurationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingConfigurationCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingRuleSetCmdlet"> <summary> Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name. <para><b>Learn more</b></para><ul><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html">Build a rule set</a></para></li></ul><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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingRuleSetCmdlet.Name"> <summary> <para> <para>A list of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingRuleSetCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingRuleSetCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingRuleSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RuleSets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeMatchmakingRuleSetsResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeMatchmakingRuleSetsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLMatchmakingRuleSetCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLPlayerSessionCmdlet"> <summary> Retrieves properties for one or more player sessions. <para> This action can be used in the following ways: </para><ul><li><para> To retrieve a specific player session, provide the player session ID only. </para></li><li><para> To retrieve all player sessions in a game session, provide the game session ID only. </para></li><li><para> To retrieve all player sessions for a specific player, provide a player ID only. </para></li></ul><para> To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. If you provide a specific <c>PlayerSessionId</c> or <c>PlayerId</c>, Amazon GameLift ignores the filter criteria. Use the pagination parameters to retrieve results as a set of sequential pages. </para><para> If successful, a <c>PlayerSession</c> object is returned for each session that matches the request. </para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLPlayerSessionCmdlet.GameSessionId"> <summary> <para> <para>A unique identifier for the game session to retrieve player sessions for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLPlayerSessionCmdlet.PlayerId"> <summary> <para> <para>A unique identifier for a player to retrieve player sessions for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLPlayerSessionCmdlet.PlayerSessionId"> <summary> <para> <para>A unique identifier for a player session to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLPlayerSessionCmdlet.PlayerSessionStatusFilter"> <summary> <para> <para>Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.</para><para>Possible player session statuses include the following:</para><ul><li><para><b>RESERVED</b> -- The player session request has been received, but the player has not yet connected to the server process and/or been validated. </para></li><li><para><b>ACTIVE</b> -- The player has been validated by the server process and is currently connected.</para></li><li><para><b>COMPLETED</b> -- The player connection has been dropped.</para></li><li><para><b>TIMEDOUT</b> -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLPlayerSessionCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLPlayerSessionCmdlet.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. If a player session ID is specified, this parameter is ignored.</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLPlayerSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PlayerSessions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribePlayerSessionsResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribePlayerSessionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLPlayerSessionCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLResourceTagCmdlet"> <summary> Retrieves all tags assigned to a Amazon GameLift resource. Use resource tags to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging. <para> To list tags for a resource, specify the unique ARN value for the resource. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i></para><para><a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/"> Amazon Web Services Tagging Strategies</a></para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that uniquely identifies the Amazon GameLift resource that you want to retrieve tags for. Amazon GameLift includes resource ARNs in the data object for the resource. You can retrieve the ARN by calling a <c>List</c> or <c>Describe</c> operation for the resource type. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.GameLift.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLRuntimeConfigurationCmdlet"> <summary> Retrieves a fleet's runtime configuration settings. The runtime configuration determines which server processes run, and how, on computes in the fleet. For managed EC2 fleets, the runtime configuration describes server processes that run on each fleet instance. For container fleets, the runtime configuration describes server processes that run in each replica container group. You can update a fleet's runtime configuration at any time using <a>UpdateRuntimeConfiguration</a>. <para> To get the current runtime configuration for a fleet, provide the fleet ID. </para><para> If successful, a <c>RuntimeConfiguration</c> object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift fleets</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html">Running multiple processes on a fleet</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLRuntimeConfigurationCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to get the runtime configuration for. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLRuntimeConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RuntimeConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeRuntimeConfigurationResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeRuntimeConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLRuntimeConfigurationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLScalingPolicyCmdlet"> <summary> Retrieves all scaling policies applied to a fleet. <para> To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of <c>ScalingPolicy</c> objects is returned for the fleet. </para><para> A fleet may have all of its scaling policies suspended. This operation does not affect the status of the scaling policies, which remains ACTIVE. </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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLScalingPolicyCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLScalingPolicyCmdlet.Location"> <summary> <para> <para> The fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLScalingPolicyCmdlet.StatusFilter"> <summary> <para> <para>Scaling policy status to filter results on. A scaling policy is only in force when in an <c>ACTIVE</c> status.</para><ul><li><para><b>ACTIVE</b> -- The scaling policy is currently in force.</para></li><li><para><b>UPDATEREQUESTED</b> -- A request to update the scaling policy has been received.</para></li><li><para><b>UPDATING</b> -- A change is being made to the scaling policy.</para></li><li><para><b>DELETEREQUESTED</b> -- A request to delete the scaling policy has been received.</para></li><li><para><b>DELETING</b> -- The scaling policy is being deleted.</para></li><li><para><b>DELETED</b> -- The scaling policy has been deleted.</para></li><li><para><b>ERROR</b> -- An error occurred in creating the policy. It should be removed and recreated.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLScalingPolicyCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLScalingPolicyCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLScalingPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ScalingPolicies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeScalingPoliciesResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeScalingPoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLScalingPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLScalingPolicyCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLScriptCmdlet"> <summary> Retrieves properties for a Realtime script. <para> To request a script record, specify the script ID. If successful, an object containing the script properties is returned. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a></para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLScriptCmdlet.ScriptId"> <summary> <para> <para>A unique identifier for the Realtime script to retrieve properties for. You can use either the script ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLScriptCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Script'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeScriptResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeScriptResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLScriptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ScriptId parameter. The -PassThru parameter is deprecated, use -Select '^ScriptId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLScriptListCmdlet"> <summary> Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use. <para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a></para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLScriptListCmdlet.Limit"> <summary> <para> <para>The maximum number of results to return. Use this parameter with <c>NextToken</c> to get results as a set of sequential pages.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLScriptListCmdlet.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, don't 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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLScriptListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Scripts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.ListScriptsResponse). Specifying the name of a property of type Amazon.GameLift.Model.ListScriptsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLScriptListCmdlet.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> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLVpcPeeringAuthorizationCmdlet"> <summary> Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account. <para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLVpcPeeringAuthorizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VpcPeeringAuthorizations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeVpcPeeringAuthorizationsResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeVpcPeeringAuthorizationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.GetGMLVpcPeeringConnectionCmdlet"> <summary> Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID. <para> To retrieve connection information, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect. </para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLVpcPeeringConnectionCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLVpcPeeringConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VpcPeeringConnections'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeVpcPeeringConnectionsResponse). Specifying the name of a property of type Amazon.GameLift.Model.DescribeVpcPeeringConnectionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.GetGMLVpcPeeringConnectionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.NewGMLAliasCmdlet"> <summary> Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that is useful when redirecting player traffic from one fleet to another, such as when updating your game build. <para> Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site. </para><para> To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID and an ARN. You can reassign an alias to another fleet by calling <c>UpdateAlias</c>. </para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLAliasCmdlet.Description"> <summary> <para> <para>A human-readable description of the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLAliasCmdlet.RoutingStrategy_FleetId"> <summary> <para> <para>A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLAliasCmdlet.RoutingStrategy_Message"> <summary> <para> <para>The message text to be used with a terminal routing strategy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLAliasCmdlet.Name"> <summary> <para> <para>A descriptive label that is associated with an alias. Alias names do not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLAliasCmdlet.Tag"> <summary> <para> <para>A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLAliasCmdlet.RoutingStrategy_Type"> <summary> <para> <para>The type of routing strategy for the alias.</para><para>Possible routing types include the following:</para><ul><li><para><b>SIMPLE</b> - The alias resolves to one specific fleet. Use this type when routing to active fleets.</para></li><li><para><b>TERMINAL</b> - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the message embedded.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Alias'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.CreateAliasResponse). Specifying the name of a property of type Amazon.GameLift.Model.CreateAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.NewGMLBuildCmdlet"> <summary> Creates a new Amazon GameLift build resource for your game server binary files. Combine game server binaries into a zip file for use with Amazon GameLift. <important><para> When setting up a new game build for Amazon GameLift, we recommend using the CLI command <b><a href="https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html">upload-build</a></b>. This helper command combines two tasks: (1) it uploads your build files from a file directory to an Amazon GameLift Amazon S3 location, and (2) it creates a new build resource. </para></important><para> You can use the <c>CreateBuild</c> operation in the following scenarios: </para><ul><li><para> Create a new game build with build files that are in an Amazon S3 location under an Amazon Web Services account that you control. To use this option, you give Amazon GameLift access to the Amazon S3 bucket. With permissions in place, specify a build name, operating system, and the Amazon S3 storage location of your game build. </para></li><li><para> Upload your build files to a Amazon GameLift Amazon S3 location. To use this option, specify a build name and operating system. This operation creates a new build resource and also returns an Amazon S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified Amazon S3 location. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html">Uploading Objects</a> in the <i>Amazon S3 Developer Guide</i>. After you upload build files to the Amazon GameLift Amazon S3 location, you can't update them. </para></li></ul><para> If successful, this operation creates a new build resource with a unique build ID and places it in <c>INITIALIZED</c> status. A build must be in <c>READY</c> status before you can create fleets with it. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html">Uploading Your Game</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build"> Create a Build with Files in Amazon S3</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLBuildCmdlet.StorageLocation_Bucket"> <summary> <para> <para>An Amazon S3 bucket identifier. Thename of the S3 bucket.</para><note><para>Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLBuildCmdlet.StorageLocation_Key"> <summary> <para> <para>The name of the zip file that contains the build files or script files. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLBuildCmdlet.Name"> <summary> <para> <para>A descriptive label associated with a build. Build names don't need to be unique. You can change this value later. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLBuildCmdlet.StorageLocation_ObjectVersion"> <summary> <para> <para>The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLBuildCmdlet.OperatingSystem"> <summary> <para> <para>The operating system that your game server binaries run on. This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. You must specify a valid operating system in this request. There is no default value. You can't change a build's operating system later.</para><note><para>If you have active fleets using the Windows Server 2012 operating system, you can continue to create new builds using this OS until October 10, 2023, when Microsoft ends its support. All others must use Windows Server 2016 when creating new Windows-based builds.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLBuildCmdlet.StorageLocation_RoleArn"> <summary> <para> <para>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) for an IAM role that allows Amazon GameLift to access the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLBuildCmdlet.ServerSdkVersion"> <summary> <para> <para>A server SDK version you used when integrating your game server build with Amazon GameLift. For more information see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html">Integrate games with custom game servers</a>. By default Amazon GameLift sets this value to <c>4.0.2</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLBuildCmdlet.Tag"> <summary> <para> <para>A list of labels to assign to the new build resource. Tags are developer defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html">TagResource</a>, <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html">UntagResource</a>, and <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html">ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLBuildCmdlet.Version"> <summary> <para> <para>Version information associated with a build or script. Version strings don't need to be unique. You can change this value later. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLBuildCmdlet.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.CreateBuildResponse). Specifying the name of a property of type Amazon.GameLift.Model.CreateBuildResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLBuildCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLBuildCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.NewGMLContainerGroupDefinitionCmdlet"> <summary> <b>This operation is used with the Amazon GameLift containers feature, which is currently in public preview. </b><para> Creates a <c>ContainerGroupDefinition</c> resource that describes a set of containers for hosting your game server with Amazon GameLift managed EC2 hosting. An Amazon GameLift container group is similar to a container "task" and "pod". Each container group can have one or more containers. </para><para> Use container group definitions when you create a container fleet. Container group definitions determine how Amazon GameLift deploys your containers to each instance in a container fleet. </para><para> You can create two types of container groups, based on scheduling strategy: </para><ul><li><para> A <b>replica container group</b> manages the containers that run your game server application and supporting software. Replica container groups might be replicated multiple times on each fleet instance, depending on instance resources. </para></li><li><para> A <b>daemon container group</b> manages containers that run other software, such as background services, logging, or test processes. You might use a daemon container group for processes that need to run only once per fleet instance, or processes that need to persist independently of the replica container group. </para></li></ul><para> To create a container group definition, specify a group name, a list of container definitions, and maximum total CPU and memory requirements for the container group. Specify an operating system and scheduling strategy or use the default values. When using the Amazon Web Services CLI tool, you can pass in your container definitions as a JSON file. </para><note><para> This operation requires Identity and Access Management (IAM) permissions to access container images in Amazon ECR repositories. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html"> IAM permissions for Amazon GameLift</a> for help setting the appropriate permissions. </para></note><para> If successful, this operation creates a new <c>ContainerGroupDefinition</c> resource with an ARN value assigned. You can't change the properties of a container group definition. Instead, create a new one. </para><para><b>Learn more</b></para><ul><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html">Create a container group definition</a></para></li><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet.html">Container fleet design guide</a></para></li><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-definitions.html#containers-definitions-create">Create a container definition as a JSON file</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLContainerGroupDefinitionCmdlet.ContainerDefinition"> <summary> <para> <para>Definitions for all containers in this group. Each container definition identifies the container image and specifies configuration settings for the container. See the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet.html"> Container fleet design guide</a> for container guidelines.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLContainerGroupDefinitionCmdlet.Name"> <summary> <para> <para>A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLContainerGroupDefinitionCmdlet.OperatingSystem"> <summary> <para> <para>The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLContainerGroupDefinitionCmdlet.SchedulingStrategy"> <summary> <para> <para>The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group has one copy per fleet instance. Default value is <c>REPLICA</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLContainerGroupDefinitionCmdlet.Tag"> <summary> <para> <para>A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLContainerGroupDefinitionCmdlet.TotalCpuLimit"> <summary> <para> <para>The maximum amount of CPU units to allocate to the container group. Set this parameter to an integer value in CPU units (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify CPU limits for individual containers, set this parameter based on the following guidelines. The value must be equal to or greater than the sum of the CPU limits for all containers in the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLContainerGroupDefinitionCmdlet.TotalMemoryLimit"> <summary> <para> <para>The maximum amount of memory (in MiB) to allocate to the container group. All containers in the group share this memory. If you specify memory limits for individual containers, set this parameter based on the following guidelines. The value must be (1) greater than the sum of the soft memory limits for all containers in the group, and (2) greater than any individual container's hard memory limit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLContainerGroupDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContainerGroupDefinition'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.CreateContainerGroupDefinitionResponse). Specifying the name of a property of type Amazon.GameLift.Model.CreateContainerGroupDefinitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLContainerGroupDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLContainerGroupDefinitionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet"> <summary> <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b><para> Creates a fleet of compute resources to host your game servers. Use this operation to set up the following types of fleets based on compute type: </para><para><b>Managed EC2 fleet</b></para><para> An EC2 fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your game server build is deployed to each fleet instance. Amazon GameLift manages the fleet's instances and controls the lifecycle of game server processes, which host game sessions for players. EC2 fleets can have instances in multiple locations. Each instance in the fleet is designated a <c>Compute</c>. </para><para> To create an EC2 fleet, provide these required parameters: </para><ul><li><para> Either <c>BuildId</c> or <c>ScriptId</c></para></li><li><para><c>ComputeType</c> set to <c>EC2</c> (the default value) </para></li><li><para><c>EC2InboundPermissions</c></para></li><li><para><c>EC2InstanceType</c></para></li><li><para><c>FleetType</c></para></li><li><para><c>Name</c></para></li><li><para><c>RuntimeConfiguration</c> with at least one <c>ServerProcesses</c> configuration </para></li></ul><para> If successful, this operation creates a new fleet resource and places it in <c>NEW</c> status while Amazon GameLift initiates the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-all.html#fleets-creation-workflow">fleet creation workflow</a>. To debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create a development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. </para><para> When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location. </para><para><b>Managed container fleet</b></para><para> A container fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your container architecture is deployed to each fleet instance based on the fleet configuration. Amazon GameLift manages the containers on each fleet instance and controls the lifecycle of game server processes, which host game sessions for players. Container fleets can have instances in multiple locations. Each container on an instance that runs game server processes is registered as a <c>Compute</c>. </para><para> To create a container fleet, provide these required parameters: </para><ul><li><para><c>ComputeType</c> set to <c>CONTAINER</c></para></li><li><para><c>ContainerGroupsConfiguration</c></para></li><li><para><c>EC2InboundPermissions</c></para></li><li><para><c>EC2InstanceType</c></para></li><li><para><c>FleetType</c> set to <c>ON_DEMAND</c></para></li><li><para><c>Name</c></para></li><li><para><c>RuntimeConfiguration</c> with at least one <c>ServerProcesses</c> configuration </para></li></ul><para> If successful, this operation creates a new fleet resource and places it in <c>NEW</c> status while Amazon GameLift initiates the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-all.html#fleets-creation-workflow">fleet creation workflow</a>. </para><para> When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location. </para><para><b>Anywhere fleet</b></para><para> An Anywhere fleet represents compute resources that are not owned or managed by Amazon GameLift. You might create an Anywhere fleet with your local machine for testing, or use one to host game servers with on-premises hardware or other game hosting solutions. </para><para> To create an Anywhere fleet, provide these required parameters: </para><ul><li><para><c>ComputeType</c> set to <c>ANYWHERE</c></para></li><li><para><c>Locations</c> specifying a custom location </para></li><li><para><c>Name</c></para></li></ul><para> If successful, this operation creates a new fleet resource and places it in <c>ACTIVE</c> status. You can register computes with a fleet in <c>ACTIVE</c> status. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up fleets</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-build-fleet.html">Setting up a container fleet</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation">Debug fleet creation issues</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Multi-location fleets</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.BuildId"> <summary> <para> <para>The unique identifier for a custom game server build to be deployed to a fleet with compute type <c>EC2</c>. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift and in <c>READY</c> status. This fleet property can't be changed after the fleet is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.CertificateConfiguration_CertificateType"> <summary> <para> <para>Indicates whether a TLS/SSL certificate is generated for a fleet. </para><para>Valid values include: </para><ul><li><para><b>GENERATED</b> - Generate a TLS/SSL certificate for this fleet.</para></li><li><para><b>DISABLED</b> - (default) Do not generate a TLS/SSL certificate for this fleet. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.ComputeType"> <summary> <para> <para>The type of compute resource used to host your game servers. </para><ul><li><para><c>EC2</c> – The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting.</para></li><li><para><c>CONTAINER</c> – Container images with your game server build and supporting software are deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the <c>ContainerGroupsConfiguration</c> parameter.</para></li><li><para><c>ANYWHERE</c> – Game servers or container images with your game server and supporting software are deployed to compute resources that are provided and managed by you. With this compute type, you can also set the <c>AnywhereConfiguration</c> parameter.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.ContainerGroupsConfiguration_ContainerGroupDefinitionName"> <summary> <para> <para>The list of container group definition names to deploy to a new container fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.AnywhereConfiguration_Cost"> <summary> <para> <para>The cost to run your fleet per hour. Amazon GameLift uses the provided cost of your fleet to balance usage in queues. For more information about queues, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html">Setting up queues</a> in the <i>Amazon GameLift Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.Description"> <summary> <para> <para>A description for the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.ContainerGroupsConfiguration_DesiredReplicaContainerGroupsPerInstance"> <summary> <para> <para>The number of times to replicate the replica container group on each instance in a container fleet. By default, Amazon GameLift calculates the maximum number of replica container groups that can fit on a fleet instance (based on CPU and memory resources). Leave this parameter empty if you want to use the maximum number, or specify a desired number to override the maximum. The desired number is used if it's less than the maximum number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.EC2InboundPermission"> <summary> <para> <para>The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. Set this parameter for EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call <a>UpdateFleetPortSettings</a> to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.</para><para>To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.EC2InstanceType"> <summary> <para> <para>The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See <a href="http://aws.amazon.com/ec2/instance-types/">Amazon Elastic Compute Cloud Instance Types</a> for detailed descriptions of Amazon EC2 instance types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.FleetType"> <summary> <para> <para>Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to <c>ON_DEMAND</c>. Learn more about when to use <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot"> On-Demand versus Spot Instances</a>. This fleet property can't be changed after the fleet is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.ConnectionPortRange_FromPort"> <summary> <para> <para>Starting value for the port range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.RuntimeConfiguration_GameSessionActivationTimeoutSecond"> <summary> <para> <para>The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status <c>ACTIVATING</c>. If the game session does not become active before the timeout, it is ended and the game session status is changed to <c>TERMINATED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.InstanceRoleArn"> <summary> <para> <para>A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html"> Communicate with other Amazon Web Services resources from your fleets</a>. This fleet property can't be changed after the fleet is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.InstanceRoleCredentialsProvider"> <summary> <para> <para>Prompts Amazon GameLift to generate a shared credentials file for the IAM role that's defined in <c>InstanceRoleArn</c>. The shared credentials file is stored on each fleet instance and refreshed as needed. Use shared credentials for applications that are deployed along with the game server executable, if the game server is integrated with server SDK version 5.x. For more information about using shared credentials, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html"> Communicate with other Amazon Web Services resources from your fleets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.Location"> <summary> <para> <para>A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code, such as <c>us-west-2</c> or Local Zone code. To create a fleet with instances in the home Region only, don't set this parameter. </para><para>When using this parameter, Amazon GameLift requires you to include your home location in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.LogPath"> <summary> <para> <para><b>This parameter is no longer used.</b> To specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API <c>ProcessReady()</c> and specify one or more directory paths in <c>logParameters</c>. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize">Initialize the server process</a> in the <i>Amazon GameLift Developer Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.RuntimeConfiguration_MaxConcurrentGameSessionActivation"> <summary> <para> <para>The number of game sessions in status <c>ACTIVATING</c> to allow on an instance or container. This setting limits the instance resources that can be used for new game activations at any one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.MetricGroup"> <summary> <para> <para>The name of an Amazon Web Services CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.Name"> <summary> <para> <para>A descriptive label that is associated with a fleet. Fleet names do not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.NewGameSessionProtectionPolicy"> <summary> <para> <para>The status of termination protection for active game sessions on the fleet. By default, this property is set to <c>NoProtection</c>. You can also set game session protection for an individual game session by calling <a href="gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a>.</para><ul><li><para><b>NoProtection</b> - Game sessions can be terminated during active gameplay as a result of a scale-down event. </para></li><li><para><b>FullProtection</b> - Game sessions in <c>ACTIVE</c> status cannot be terminated during a scale-down event.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.ResourceCreationLimitPolicy_NewGameSessionsPerCreator"> <summary> <para> <para>A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.</para><para>The policy is evaluated when a player tries to create a new game session. On receiving a <c>CreateGameSession</c> request, Amazon GameLift checks that the player (identified by <c>CreatorId</c>) has created fewer than game session limit in the specified time period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.PeerVpcAwsAccountId"> <summary> <para> <para>Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.PeerVpcId"> <summary> <para> <para>A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.ResourceCreationLimitPolicy_PolicyPeriodInMinute"> <summary> <para> <para>The time span used in evaluating the resource creation limit policy. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.ScriptId"> <summary> <para> <para>The unique identifier for a Realtime configuration script to be deployed to a fleet with compute type <c>EC2</c>. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to creating the fleet. This fleet property can't be changed after the fleet is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.ServerLaunchParameter"> <summary> <para> <para><b>This parameter is no longer used.</b> Specify server launch parameters using the <c>RuntimeConfiguration</c> parameter. Requests that use this parameter instead continue to be valid.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.ServerLaunchPath"> <summary> <para> <para><b>This parameter is no longer used.</b> Specify a server launch path using the <c>RuntimeConfiguration</c> parameter. Requests that use this parameter instead continue to be valid.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.RuntimeConfiguration_ServerProcess"> <summary> <para> <para>A collection of server process configurations that identify what server processes to run on fleet computes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.Tag"> <summary> <para> <para>A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.ConnectionPortRange_ToPort"> <summary> <para> <para>Ending value for the port. Port numbers are end-inclusive. This value must be equal to or greater than <c>FromPort</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FleetAttributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.CreateFleetResponse). Specifying the name of a property of type Amazon.GameLift.Model.CreateFleetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BuildId parameter. The -PassThru parameter is deprecated, use -Select '^BuildId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetLocationCmdlet"> <summary> <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b><para> Adds remote locations to an EC2 or container fleet and begins populating the new locations with instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings. </para><note><para> You can't add remote locations to a fleet that resides in an Amazon Web Services Region that doesn't support multiple locations. Fleets created prior to March 2021 can't support multiple locations. </para></note><para> To add fleet locations, specify the fleet to be updated and provide a list of one or more locations. </para><para> If successful, this operation returns the list of added locations with their status set to <c>NEW</c>. Amazon GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html">DescribeFleetEvents</a>. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up fleets</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Multi-location fleets</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetLocationCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to add locations to. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetLocationCmdlet.Location"> <summary> <para> <para>A list of locations to deploy additional instances to and manage as part of the fleet. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as <c>us-west-2</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetLocationCmdlet.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.CreateFleetLocationsResponse). Specifying the name of a property of type Amazon.GameLift.Model.CreateFleetLocationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetLocationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLFleetLocationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet"> <summary> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b><para> Creates a Amazon GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the two groups. You can view the status of your game server groups in the Amazon GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch. </para><para> Before creating a new game server group, you must have the following: </para><ul><li><para> An Amazon Elastic Compute Cloud launch template that specifies how to launch Amazon Elastic Compute Cloud instances with your game server build. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html"> Launching an Instance from a Launch Template</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para></li><li><para> An IAM role that extends limited access to your Amazon Web Services account to allow Amazon GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html">Create IAM roles for cross-service interaction</a> in the <i>Amazon GameLift FleetIQ Developer Guide</i>. </para></li></ul><para> To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a Amazon GameLift FleetIQ metric. </para><para> Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by Amazon GameLift FleetIQ as part of its balancing activities to optimize for availability and cost. </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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.BalancingStrategy"> <summary> <para> <para>Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:</para><ul><li><para><c>SPOT_ONLY</c> - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.</para></li><li><para><c>SPOT_PREFERRED</c> - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.</para></li><li><para><c>ON_DEMAND_ONLY</c> - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.AutoScalingPolicy_EstimatedInstanceWarmup"> <summary> <para> <para>Length of time, in seconds, it takes for a new instance to start new game server processes and register with Amazon GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.GameServerGroupName"> <summary> <para> <para>An identifier for the new game server group. This value is used to generate unique ARN identifiers for the Amazon EC2 Auto Scaling group and the Amazon GameLift FleetIQ game server group. The name must be unique per Region per Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.GameServerProtectionPolicy"> <summary> <para> <para>A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to <c>NO_PROTECTION</c> by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.InstanceDefinition"> <summary> <para> <para>The Amazon EC2 instance types and sizes to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by Amazon GameLift FleetIQ. For more information on instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">EC2 Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html"> Instance Weighting for Amazon EC2 Auto Scaling</a> in the Amazon EC2 Auto Scaling User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.LaunchTemplate_LaunchTemplateId"> <summary> <para> <para>A unique identifier for an existing Amazon EC2 launch template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.LaunchTemplate_LaunchTemplateName"> <summary> <para> <para>A readable identifier for an existing Amazon EC2 launch template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.MaxSize"> <summary> <para> <para>The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.MinSize"> <summary> <para> <para>The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.Tag"> <summary> <para> <para>A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management, and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.TargetTrackingConfiguration_TargetValue"> <summary> <para> <para>Desired value to use with a game server group target-based scaling policy. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.LaunchTemplate_Version"> <summary> <para> <para>The version of the Amazon EC2 launch template to use. If no version is specified, the default version will be used. With Amazon EC2, you can specify a default version for a launch template. If none is set, the default is the first version created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.VpcSubnet"> <summary> <para> <para>A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all Amazon GameLift FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameServerGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.CreateGameServerGroupResponse). Specifying the name of a property of type Amazon.GameLift.Model.CreateGameServerGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameServerGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionCmdlet"> <summary> Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the Amazon GameLift game session placement feature with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html">StartGameSessionPlacement</a> , which uses the FleetIQ algorithm and queues to optimize the placement process. <para> When creating a game session, you specify exactly where you want to place it and provide a set of game session configuration settings. The target fleet must be in <c>ACTIVE</c> status. </para><para> You can use this operation in the following ways: </para><ul><li><para> To create a game session on an instance in a fleet's home Region, provide a fleet or alias ID along with your game session configuration. </para></li><li><para> To create a game session on an instance in a fleet's remote location, provide a fleet or alias ID and a location name, along with your game session configuration. </para></li><li><para> To create a game session on an instance in an Anywhere fleet, specify the fleet's custom location. </para></li></ul><para> If successful, Amazon GameLift initiates a workflow to start a new game session and returns a <c>GameSession</c> object containing the game session configuration and status. When the game session status is <c>ACTIVE</c>, it is updated with connection information and you can create player sessions for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a> to change the game session's player session creation policy. </para><para> Amazon GameLift retains logs for active for 14 days. To access the logs, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetGameSessionLogUrl.html">GetGameSessionLogUrl</a> to download the log files. </para><para><i>Available in Amazon GameLift Local.</i></para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a game session</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionCmdlet.AliasId"> <summary> <para> <para>A unique identifier for the alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionCmdlet.CreatorId"> <summary> <para> <para>A unique identifier for a player or entity creating the game session. </para><para>If you add a resource creation limit policy to a fleet, the <c>CreateGameSession</c> operation requires a <c>CreatorId</c>. Amazon GameLift limits the number of game session creation requests with the same <c>CreatorId</c> in a specified time period.</para><para>If you your fleet doesn't have a resource creation limit policy and you provide a <c>CreatorId</c> in your <c>CreateGameSession</c> requests, Amazon GameLift limits requests to one request per <c>CreatorId</c> per second.</para><para>To not limit <c>CreateGameSession</c> requests with the same <c>CreatorId</c>, don't provide a <c>CreatorId</c> in your <c>CreateGameSession</c> request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionCmdlet.GameProperty"> <summary> <para> <para>A set of key-value pairs that can store custom data in a game session. For example: <c>{"Key": "difficulty", "Value": "novice"}</c>. For an example, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-create">Create a game session with custom properties</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionCmdlet.GameSessionData"> <summary> <para> <para>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionCmdlet.GameSessionId"> <summary> <para> <para><i>This parameter is deprecated. Use <c>IdempotencyToken</c> instead.</i></para><para>Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionCmdlet.IdempotencyToken"> <summary> <para> <para>Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original <c>GameSession</c> object, with an updated status. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. A game session ARN has the following format: <c>arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token></c>. Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionCmdlet.Location"> <summary> <para> <para>A fleet's remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet's home Region. Specify a remote location with an Amazon Web Services Region code such as <c>us-west-2</c>. When using an Anywhere fleet, this parameter is required and must be set to the Anywhere fleet's custom location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionCmdlet.MaximumPlayerSessionCount"> <summary> <para> <para>The maximum number of players that can be connected simultaneously to the game session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionCmdlet.Name"> <summary> <para> <para>A descriptive label that is associated with a game session. Session names do not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameSession'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.CreateGameSessionResponse). Specifying the name of a property of type Amazon.GameLift.Model.CreateGameSessionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionQueueCmdlet"> <summary> Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session. <para> A game session queue is configured with a set of destinations (Amazon GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed. </para><para> The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities. </para><para> To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity. </para><para> If successful, a new <c>GameSessionQueue</c> object is returned with an assigned queue ARN. New game session requests, which are submitted to queue with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html">StartGameSessionPlacement</a> or <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchmaking.html">StartMatchmaking</a>, reference a queue's name or ARN. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-design.html"> Design a game session queue</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-creating.html"> Create a game session queue</a></para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html">CreateGameSessionQueue</a> | <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html">DescribeGameSessionQueues</a> | <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html">UpdateGameSessionQueue</a> | <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html">DeleteGameSessionQueue</a> | <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionQueueCmdlet.FilterConfiguration_AllowedLocation"> <summary> <para> <para> A list of locations to allow game session placement in, in the form of Amazon Web Services Region codes such as <c>us-west-2</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionQueueCmdlet.CustomEventData"> <summary> <para> <para>Information to be added to all events that are related to this game session queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionQueueCmdlet.Destination"> <summary> <para> <para>A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionQueueCmdlet.PriorityConfiguration_LocationOrder"> <summary> <para> <para>The prioritization order to use for fleet locations, when the <c>PriorityOrder</c> property includes <c>LOCATION</c>. Locations are identified by Amazon Web Services Region codes such as <c>us-west-2</c>. Each location can only be listed once. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionQueueCmdlet.Name"> <summary> <para> <para>A descriptive label that is associated with game session queue. Queue names must be unique within each Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionQueueCmdlet.NotificationTarget"> <summary> <para> <para>An SNS topic ARN that is set up to receive game session placement notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html"> Setting up notifications for game session placement</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionQueueCmdlet.PlayerLatencyPolicy"> <summary> <para> <para>A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionQueueCmdlet.PriorityConfiguration_PriorityOrder"> <summary> <para> <para>The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.</para><ul><li><para><c>LATENCY</c> -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest. </para></li><li><para><c>COST</c> -- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.</para></li><li><para><c>DESTINATION</c> -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.</para></li><li><para><c>LOCATION</c> -- FleetIQ prioritizes based on the provided order of locations, as defined in <c>LocationOrder</c>. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionQueueCmdlet.Tag"> <summary> <para> <para>A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionQueueCmdlet.TimeoutInSecond"> <summary> <para> <para>The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a <c>TIMED_OUT</c> status. By default, this property is set to <c>600</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionQueueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameSessionQueue'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.CreateGameSessionQueueResponse). Specifying the name of a property of type Amazon.GameLift.Model.CreateGameSessionQueueResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionQueueCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLGameSessionQueueCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.NewGMLLocationCmdlet"> <summary> Creates a custom location for use in an Anywhere fleet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLLocationCmdlet.LocationName"> <summary> <para> <para>A descriptive name for the custom location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLLocationCmdlet.Tag"> <summary> <para> <para>A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Rareference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLLocationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Location'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.CreateLocationResponse). Specifying the name of a property of type Amazon.GameLift.Model.CreateLocationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLLocationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationName parameter. The -PassThru parameter is deprecated, use -Select '^LocationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLLocationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet"> <summary> Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with Amazon GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using Amazon GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes consistent with that configuration. <para> To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without Amazon GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with Amazon GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match. </para><para> In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html"> Design a FlexMatch matchmaker</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Set up FlexMatch event notification</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.AcceptanceRequired"> <summary> <para> <para>A flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to <c>TRUE</c>. With this option enabled, matchmaking tickets use the status <c>REQUIRES_ACCEPTANCE</c> to indicate when a completed potential match is waiting for player acceptance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.AcceptanceTimeoutSecond"> <summary> <para> <para>The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.AdditionalPlayerCount"> <summary> <para> <para>The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. This parameter is not used if <c>FlexMatchMode</c> is set to <c>STANDALONE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.BackfillMode"> <summary> <para> <para>The method used to backfill game sessions that are created with this matchmaking configuration. Specify <c>MANUAL</c> when your game manages backfill requests manually or does not use the match backfill feature. Specify <c>AUTOMATIC</c> to have Amazon GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html"> Backfill Existing Games with FlexMatch</a>. Automatic backfill is not available when <c>FlexMatchMode</c> is set to <c>STANDALONE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.CustomEventData"> <summary> <para> <para>Information to be added to all events related to this matchmaking configuration. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.Description"> <summary> <para> <para>A human-readable description of the matchmaking configuration. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.FlexMatchMode"> <summary> <para> <para>Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution. </para><ul><li><para><b>STANDALONE</b> - FlexMatch forms matches and returns match information, including players and team assignments, in a <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded"> MatchmakingSucceeded</a> event.</para></li><li><para><b>WITH_QUEUE</b> - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.GameProperty"> <summary> <para> <para>A set of key-value pairs that can store custom data in a game session. For example: <c>{"Key": "difficulty", "Value": "novice"}</c>. This information is added to the new <c>GameSession</c> object that is created for a successful match. This parameter is not used if <c>FlexMatchMode</c> is set to <c>STANDALONE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.GameSessionData"> <summary> <para> <para>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the new <c>GameSession</c> object that is created for a successful match. This parameter is not used if <c>FlexMatchMode</c> is set to <c>STANDALONE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.GameSessionQueueArn"> <summary> <para> <para>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <c>arn:aws:gamelift:<region>::gamesessionqueue/<queue name></c>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If <c>FlexMatchMode</c> is set to <c>STANDALONE</c>, do not set this parameter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.Name"> <summary> <para> <para>A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.NotificationTarget"> <summary> <para> <para>An SNS topic ARN that is set up to receive matchmaking notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Setting up notifications for matchmaking</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.RequestTimeoutSecond"> <summary> <para> <para>The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.RuleSetName"> <summary> <para> <para>A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.Tag"> <summary> <para> <para>A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Configuration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.CreateMatchmakingConfigurationResponse). Specifying the name of a property of type Amazon.GameLift.Model.CreateMatchmakingConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleSetName parameter. The -PassThru parameter is deprecated, use -Select '^RuleSetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingRuleSetCmdlet"> <summary> Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type. <para> To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with. </para><para> Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ValidateMatchmakingRuleSet.html">ValidateMatchmakingRuleSet</a> before creating a new rule set. </para><para><b>Learn more</b></para><ul><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html">Build a rule set</a></para></li><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html">Design a matchmaker</a></para></li><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html">Matchmaking with FlexMatch</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingRuleSetCmdlet.Name"> <summary> <para> <para>A unique identifier for the matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional <c>name</c> field in the rule set body.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingRuleSetCmdlet.RuleSetBody"> <summary> <para> <para>A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingRuleSetCmdlet.Tag"> <summary> <para> <para>A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingRuleSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RuleSet'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.CreateMatchmakingRuleSetResponse). Specifying the name of a property of type Amazon.GameLift.Model.CreateMatchmakingRuleSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingRuleSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLMatchmakingRuleSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.NewGMLPlayerSessionCmdlet"> <summary> Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in <c>ACTIVE</c> status and has a player creation policy of <c>ACCEPT_ALL</c>. To add a single player to a game session, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSession.html">CreatePlayerSession</a><para> To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID. </para><para> If successful, a slot is reserved in the game session for each player, and new <c>PlayerSession</c> objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the Amazon GameLift service. Player sessions cannot be updated. </para><para> The maximum number of players per game session is 200. It is not adjustable. </para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLPlayerSessionCmdlet.GameSessionId"> <summary> <para> <para>A unique identifier for the game session to add players to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLPlayerSessionCmdlet.PlayerDataMap"> <summary> <para> <para>Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the <c>PlayerIds</c> parameter are ignored. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLPlayerSessionCmdlet.PlayerId"> <summary> <para> <para>List of unique identifiers for the players to be added.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLPlayerSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PlayerSessions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.CreatePlayerSessionsResponse). Specifying the name of a property of type Amazon.GameLift.Model.CreatePlayerSessionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLPlayerSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GameSessionId parameter. The -PassThru parameter is deprecated, use -Select '^GameSessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLPlayerSessionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.NewGMLScriptCmdlet"> <summary> Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session. <para> To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations: </para><ul><li><para> A locally available directory. Use the <i>ZipFile</i> parameter for this option. </para></li><li><para> An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the <i>StorageLocation</i> parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket. </para></li></ul><para> If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html">Set Up a Role for Amazon GameLift Access</a></para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLScriptCmdlet.StorageLocation_Bucket"> <summary> <para> <para>An Amazon S3 bucket identifier. Thename of the S3 bucket.</para><note><para>Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLScriptCmdlet.StorageLocation_Key"> <summary> <para> <para>The name of the zip file that contains the build files or script files. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLScriptCmdlet.Name"> <summary> <para> <para>A descriptive label that is associated with a script. Script names don't need to be unique. You can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html">UpdateScript</a> to change this value later. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLScriptCmdlet.StorageLocation_ObjectVersion"> <summary> <para> <para>The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLScriptCmdlet.StorageLocation_RoleArn"> <summary> <para> <para>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) for an IAM role that allows Amazon GameLift to access the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLScriptCmdlet.Tag"> <summary> <para> <para>A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html">TagResource</a>, <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html">UntagResource</a>, and <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html">ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLScriptCmdlet.Version"> <summary> <para> <para>Version information associated with a build or script. Version strings don't need to be unique. You can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html">UpdateScript</a> to change this value later. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLScriptCmdlet.ZipFile"> <summary> <para> <para>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</para><para>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: <c>--zip-file fileb://myRealtimeScript.zip</c>.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLScriptCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Script'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.CreateScriptResponse). Specifying the name of a property of type Amazon.GameLift.Model.CreateScriptResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLScriptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLScriptCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.NewGMLVpcPeeringAuthorizationCmdlet"> <summary> Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. After you've received authorization, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringConnection.html">CreateVpcPeeringConnection</a> to establish the peering connection. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>. <para> You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions. </para><para> To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC. </para><para> To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift. </para><para> The authorization remains valid for 24 hours unless it is canceled. You must create or delete the peering connection while the authorization is valid. </para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLVpcPeeringAuthorizationCmdlet.GameLiftAwsAccountId"> <summary> <para> <para>A unique identifier for the Amazon Web Services account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLVpcPeeringAuthorizationCmdlet.PeerVpcId"> <summary> <para> <para>A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLVpcPeeringAuthorizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VpcPeeringAuthorization'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.CreateVpcPeeringAuthorizationResponse). Specifying the name of a property of type Amazon.GameLift.Model.CreateVpcPeeringAuthorizationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLVpcPeeringAuthorizationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PeerVpcId parameter. The -PassThru parameter is deprecated, use -Select '^PeerVpcId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLVpcPeeringAuthorizationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.NewGMLVpcPeeringConnectionCmdlet"> <summary> Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>. <para> Before calling this operation to establish the peering connection, you first need to use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html">CreateVpcPeeringAuthorization</a> and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc. </para><para> To establish the connection, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a connection request is created. You can use continuous polling to track the request's status using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeVpcPeeringConnections.html">DescribeVpcPeeringConnections</a> , or by monitoring fleet events for success or failure using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html">DescribeFleetEvents</a> . </para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLVpcPeeringConnectionCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet. You can use either the fleet ID or ARN value. This tells Amazon GameLift which GameLift VPC to peer with. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLVpcPeeringConnectionCmdlet.PeerVpcAwsAccountId"> <summary> <para> <para>A unique identifier for the Amazon Web Services account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the Amazon Web Services Management Console under account settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLVpcPeeringConnectionCmdlet.PeerVpcId"> <summary> <para> <para>A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLVpcPeeringConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.CreateVpcPeeringConnectionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLVpcPeeringConnectionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.NewGMLVpcPeeringConnectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RegisterGMLComputeCmdlet"> <summary> <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b><para> Registers a compute resource in an Amazon GameLift fleet. Register computes with an Amazon GameLift Anywhere fleet or a container fleet. </para><para> For an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to register fleet computes. </para><para> To register a compute, give the compute a name (must be unique within the fleet) and specify the compute resource's DNS name or IP address. Provide a fleet ID and a fleet location to associate with the compute being registered. You can optionally include the path to a TLS certificate on the compute resource. </para><para> If successful, this operation returns compute details, including an Amazon GameLift SDK endpoint or Agent endpoint. Game server processes running on the compute can use this endpoint to communicate with the Amazon GameLift service. Each server process includes the SDK endpoint in its call to the Amazon GameLift server SDK action <c>InitSDK()</c>. </para><para> To view compute details, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeCompute.html">DescribeCompute</a> with the compute name. </para><para><b>Learn more</b></para><ul><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-anywhere.html">Create an Anywhere fleet</a></para></li><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing.html">Test your integration</a></para></li><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html">Server SDK reference guides</a> (for version 5.x) </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLComputeCmdlet.CertificatePath"> <summary> <para> <para>The path to a TLS certificate on your compute resource. Amazon GameLift doesn't validate the path and certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLComputeCmdlet.ComputeName"> <summary> <para> <para>A descriptive label for the compute resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLComputeCmdlet.DnsName"> <summary> <para> <para>The DNS name of the compute resource. Amazon GameLift requires either a DNS name or IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLComputeCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to register the compute to. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLComputeCmdlet.IpAddress"> <summary> <para> <para>The IP address of the compute resource. Amazon GameLift requires either a DNS name or IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLComputeCmdlet.Location"> <summary> <para> <para>The name of a custom location to associate with the compute resource being registered. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLComputeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Compute'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.RegisterComputeResponse). Specifying the name of a property of type Amazon.GameLift.Model.RegisterComputeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLComputeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ComputeName parameter. The -PassThru parameter is deprecated, use -Select '^ComputeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLComputeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RegisterGMLGameServerCmdlet"> <summary> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b><para> Creates a new game server resource and notifies Amazon GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables Amazon GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session. </para><para> To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data. </para><para> Once a game server is successfully registered, it is put in status <c>AVAILABLE</c>. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity. </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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLGameServerCmdlet.ConnectionInfo"> <summary> <para> <para>Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLGameServerCmdlet.GameServerData"> <summary> <para> <para>A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLGameServerCmdlet.GameServerGroupName"> <summary> <para> <para>A unique identifier for the game server group where the game server is running.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLGameServerCmdlet.GameServerId"> <summary> <para> <para>A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLGameServerCmdlet.InstanceId"> <summary> <para> <para>The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: <c>i-1234567890abcdef0</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLGameServerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameServer'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.RegisterGameServerResponse). Specifying the name of a property of type Amazon.GameLift.Model.RegisterGameServerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLGameServerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GameServerId parameter. The -PassThru parameter is deprecated, use -Select '^GameServerId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RegisterGMLGameServerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RemoveGMLAliasCmdlet"> <summary> Deletes an alias. This operation removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted. <para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLAliasCmdlet.AliasId"> <summary> <para> <para>A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DeleteAliasResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AliasId parameter. The -PassThru parameter is deprecated, use -Select '^AliasId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RemoveGMLBuildCmdlet"> <summary> Deletes a build. This operation permanently deletes the build resource and any uploaded build files. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build. <para> To delete a build, specify the build ID. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html"> Upload a Custom Server Build</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLBuildCmdlet.BuildId"> <summary> <para> <para>A unique identifier for the build to delete. You can use either the build ID or ARN value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLBuildCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DeleteBuildResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLBuildCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BuildId parameter. The -PassThru parameter is deprecated, use -Select '^BuildId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLBuildCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RemoveGMLContainerGroupDefinitionCmdlet"> <summary> <b>This operation is used with the Amazon GameLift containers feature, which is currently in public preview. </b><para> Deletes a container group definition resource. You can delete a container group definition if there are no fleets using the definition. </para><para> To delete a container group definition, identify the resource to delete. </para><para><b>Learn more</b></para><ul><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html">Manage a container group definition</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLContainerGroupDefinitionCmdlet.Name"> <summary> <para> <para>The unique identifier for the container group definition to delete. You can use either the <c>Name</c> or <c>ARN</c> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLContainerGroupDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DeleteContainerGroupDefinitionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLContainerGroupDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLContainerGroupDefinitionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RemoveGMLFleetCmdlet"> <summary> Deletes all resources and information related to a fleet and shuts down any currently running fleet instances, including those in remote locations. <note><para> If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html">CreateVpcPeeringAuthorization</a>. You don't need to explicitly delete the VPC peering connection. </para></note><para> To delete a fleet, specify the fleet ID to be terminated. During the deletion process, the fleet status is changed to <c>DELETING</c>. When completed, the status switches to <c>TERMINATED</c> and the fleet event <c>FLEET_DELETED</c> is emitted. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift Fleets</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLFleetCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLFleetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DeleteFleetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLFleetCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLFleetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RemoveGMLFleetLocationCmdlet"> <summary> Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are shut down. <para> To delete fleet locations, identify the fleet ID and provide a list of the locations to be deleted. </para><para> If successful, GameLift sets the location status to <c>DELETING</c>, and begins to shut down existing server processes and terminate instances in each location being deleted. When completed, the location status changes to <c>TERMINATED</c>. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift fleets</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLFleetLocationCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to delete locations for. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLFleetLocationCmdlet.Location"> <summary> <para> <para>The list of fleet locations to delete. Specify locations in the form of an Amazon Web Services Region code, such as <c>us-west-2</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLFleetLocationCmdlet.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.DeleteFleetLocationsResponse). Specifying the name of a property of type Amazon.GameLift.Model.DeleteFleetLocationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLFleetLocationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLFleetLocationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RemoveGMLGameServerGroupCmdlet"> <summary> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b><para> Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources: </para><ul><li><para> The game server group </para></li><li><para> The corresponding Auto Scaling group </para></li><li><para> All game servers that are currently running in the group </para></li></ul><para> To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in <c>ACTIVE</c> or <c>ERROR</c> status. </para><para> If the delete request is successful, a series of operations are kicked off. The game server group status is changed to <c>DELETE_SCHEDULED</c>, which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, Amazon GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed in <c>ERROR</c> status. </para><para> Amazon GameLift FleetIQ emits delete events to Amazon CloudWatch. </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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLGameServerGroupCmdlet.DeleteOption"> <summary> <para> <para>The type of delete to perform. Options include the following:</para><ul><li><para><c>SAFE_DELETE</c> – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in <c>UTILIZED</c> status.</para></li><li><para><c>FORCE_DELETE</c> – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group. </para></li><li><para><c>RETAIN</c> – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLGameServerGroupCmdlet.GameServerGroupName"> <summary> <para> <para>A unique identifier for the game server group. Use either the name or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLGameServerGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameServerGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DeleteGameServerGroupResponse). Specifying the name of a property of type Amazon.GameLift.Model.DeleteGameServerGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLGameServerGroupCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLGameServerGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RemoveGMLGameSessionQueueCmdlet"> <summary> Deletes a game session queue. Once a queue is successfully deleted, unfulfilled <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html">StartGameSessionPlacement</a> requests that reference the queue will fail. To delete a queue, specify the queue name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLGameSessionQueueCmdlet.Name"> <summary> <para> <para>A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLGameSessionQueueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DeleteGameSessionQueueResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLGameSessionQueueCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLGameSessionQueueCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RemoveGMLLocationCmdlet"> <summary> Deletes a custom location. <para> Before deleting a custom location, review any fleets currently using the custom location and deregister the location if it is in use. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeregisterCompute.html">DeregisterCompute</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLLocationCmdlet.LocationName"> <summary> <para> <para>The location name of the custom location to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLLocationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DeleteLocationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLLocationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LocationName parameter. The -PassThru parameter is deprecated, use -Select '^LocationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLLocationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RemoveGMLMatchmakingConfigurationCmdlet"> <summary> Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLMatchmakingConfigurationCmdlet.Name"> <summary> <para> <para>A unique identifier for the matchmaking configuration. You can use either the configuration name or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLMatchmakingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DeleteMatchmakingConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLMatchmakingConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLMatchmakingConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RemoveGMLMatchmakingRuleSetCmdlet"> <summary> Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration. <para><b>Learn more</b></para><ul><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html">Build a rule set</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLMatchmakingRuleSetCmdlet.Name"> <summary> <para> <para>A unique identifier for the matchmaking rule set to be deleted. (Note: The rule set name is different from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLMatchmakingRuleSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DeleteMatchmakingRuleSetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLMatchmakingRuleSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLMatchmakingRuleSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RemoveGMLResourceTagCmdlet"> <summary> Removes a tag assigned to a Amazon GameLift resource. You can use resource tags to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging. <para> To remove a tag from a resource, specify the unique ARN value for the resource and provide a string list containing one or more tags to remove. This operation succeeds even if the list includes tags that aren't assigned to the resource. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i></para><para><a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/"> Amazon Web Services Tagging Strategies</a></para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that uniquely identifies the Amazon GameLift resource that you want to remove tags from. Amazon GameLift includes resource ARNs in the data object for the resource. You can retrieve the ARN by calling a <c>List</c> or <c>Describe</c> operation for the resource type. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of one or more tag keys to remove from the specified Amazon GameLift resource. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RemoveGMLScalingPolicyCmdlet"> <summary> Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and Amazon GameLift removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with. <para> To temporarily suspend scaling policies, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html">StopFleetActions</a>. This operation suspends all policies for the fleet. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLScalingPolicyCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLScalingPolicyCmdlet.Name"> <summary> <para> <para>A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLScalingPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DeleteScalingPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLScalingPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLScalingPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RemoveGMLScriptCmdlet"> <summary> Deletes a Realtime script. This operation permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted). <para> To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a></para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLScriptCmdlet.ScriptId"> <summary> <para> <para>A unique identifier for the Realtime script to delete. You can use either the script ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLScriptCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DeleteScriptResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLScriptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ScriptId parameter. The -PassThru parameter is deprecated, use -Select '^ScriptId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLScriptCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RemoveGMLVpcPeeringAuthorizationCmdlet"> <summary> Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteVpcPeeringConnection.html">DeleteVpcPeeringConnection</a>. <para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLVpcPeeringAuthorizationCmdlet.GameLiftAwsAccountId"> <summary> <para> <para>A unique identifier for the Amazon Web Services account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLVpcPeeringAuthorizationCmdlet.PeerVpcId"> <summary> <para> <para>A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLVpcPeeringAuthorizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DeleteVpcPeeringAuthorizationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLVpcPeeringAuthorizationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PeerVpcId parameter. The -PassThru parameter is deprecated, use -Select '^PeerVpcId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLVpcPeeringAuthorizationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RemoveGMLVpcPeeringConnectionCmdlet"> <summary> Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete.. <para> Once a valid authorization exists, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed. </para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLVpcPeeringConnectionCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet. This fleet specified must match the fleet referenced in the VPC peering connection record. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLVpcPeeringConnectionCmdlet.VpcPeeringConnectionId"> <summary> <para> <para>A unique identifier for a VPC peering connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLVpcPeeringConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DeleteVpcPeeringConnectionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLVpcPeeringConnectionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RemoveGMLVpcPeeringConnectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RequestGMLGameServerCmdlet"> <summary> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b><para> Locates an available game server and temporarily reserves it to host gameplay and players. This operation is called from a game client or client service (such as a matchmaker) to request hosting resources for a new game session. In response, Amazon GameLift FleetIQ locates an available game server, places it in <c>CLAIMED</c> status for 60 seconds, and returns connection information that players can use to connect to the game server. </para><para> To claim a game server, identify a game server group. You can also specify a game server ID, although this approach bypasses Amazon GameLift FleetIQ placement optimization. Optionally, include game data to pass to the game server at the start of a game session, such as a game map or player information. Add filter options to further restrict how a game server is chosen, such as only allowing game servers on <c>ACTIVE</c> instances to be claimed. </para><para> When a game server is successfully claimed, connection information is returned. A claimed game server's utilization status remains <c>AVAILABLE</c> while the claim status is set to <c>CLAIMED</c> for up to 60 seconds. This time period gives the game server time to update its status to <c>UTILIZED</c> after players join. If the game server's status is not updated within 60 seconds, the game server reverts to unclaimed status and is available to be claimed by another request. The claim time period is a fixed value and is not configurable. </para><para> If you try to claim a specific game server, this request will fail in the following cases: </para><ul><li><para> If the game server utilization status is <c>UTILIZED</c>. </para></li><li><para> If the game server claim status is <c>CLAIMED</c>. </para></li><li><para> If the game server is running on an instance in <c>DRAINING</c> status and the provided filter option does not allow placing on <c>DRAINING</c> instances. </para></li></ul><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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RequestGMLGameServerCmdlet.GameServerData"> <summary> <para> <para>A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RequestGMLGameServerCmdlet.GameServerGroupName"> <summary> <para> <para>A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift FleetIQ to look for an available game server to claim. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RequestGMLGameServerCmdlet.GameServerId"> <summary> <para> <para>A custom string that uniquely identifies the game server to claim. If this parameter is left empty, Amazon GameLift FleetIQ searches for an available game server in the specified game server group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RequestGMLGameServerCmdlet.FilterOption_InstanceStatus"> <summary> <para> <para>List of instance statuses that game servers may be claimed on. If provided, the list must contain the <c>ACTIVE</c> status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RequestGMLGameServerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameServer'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.ClaimGameServerResponse). Specifying the name of a property of type Amazon.GameLift.Model.ClaimGameServerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RequestGMLGameServerCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RequestGMLGameServerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.RequestGMLUploadCredentialCmdlet"> <summary> Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html">CreateBuild</a>. <para> To request new credentials, specify the build ID as returned with an initial <c>CreateBuild</c> request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build"> Create a Build with Files in S3</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RequestGMLUploadCredentialCmdlet.BuildId"> <summary> <para> <para>A unique identifier for the build to get credentials for. You can use either the build ID or ARN value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RequestGMLUploadCredentialCmdlet.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.RequestUploadCredentialsResponse). Specifying the name of a property of type Amazon.GameLift.Model.RequestUploadCredentialsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RequestGMLUploadCredentialCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BuildId parameter. The -PassThru parameter is deprecated, use -Select '^BuildId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.RequestGMLUploadCredentialCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.ResolveGMLAliasCmdlet"> <summary> Attempts to retrieve a fleet ID that is associated with an alias. Specify a unique alias identifier. <para> If the alias has a <c>SIMPLE</c> routing strategy, Amazon GameLift returns a fleet ID. If the alias has a <c>TERMINAL</c> routing strategy, the result is a <c>TerminalRoutingStrategyException</c>. </para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.ResolveGMLAliasCmdlet.AliasId"> <summary> <para> <para>The unique identifier of the alias that you want to retrieve a fleet ID for. You can use either the alias ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.ResolveGMLAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FleetId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.ResolveAliasResponse). Specifying the name of a property of type Amazon.GameLift.Model.ResolveAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.ResolveGMLAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AliasId parameter. The -PassThru parameter is deprecated, use -Select '^AliasId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.ResolveGMLAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.ResumeGMLGameServerGroupCmdlet"> <summary> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b><para> Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by the <a href="gamelift/latest/apireference/API_SuspendGameServerGroup.html">SuspendGameServerGroup</a> operation, or it might be suspended involuntarily due to a configuration problem. In the second case, you can manually resume activity on the group once the configuration problem has been resolved. Refer to the game server group status and status reason for more information on why group activity is suspended. </para><para> To resume activity, specify a game server group ARN and the type of activity to be resumed. If successful, a <c>GameServerGroup</c> object is returned showing that the resumed activity is no longer listed in <c>SuspendedActions</c>. </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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.ResumeGMLGameServerGroupCmdlet.GameServerGroupName"> <summary> <para> <para>A unique identifier for the game server group. Use either the name or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.ResumeGMLGameServerGroupCmdlet.ResumeAction"> <summary> <para> <para>The activity to resume for this game server group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.ResumeGMLGameServerGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameServerGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.ResumeGameServerGroupResponse). Specifying the name of a property of type Amazon.GameLift.Model.ResumeGameServerGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.ResumeGMLGameServerGroupCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.ResumeGMLGameServerGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.StartGMLFleetActionCmdlet"> <summary> Resumes certain types of activity on fleet instances that were suspended with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html">StopFleetActions</a>. For multi-location fleets, fleet actions are managed separately for each location. Currently, this operation is used to restart a fleet's auto-scaling activity. <para> This operation can be used in the following ways: </para><ul><li><para> To restart actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to resume. </para></li><li><para> To restart actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to resume. </para></li></ul><para> If successful, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet location were never stopped, this operation will have no effect. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift fleets</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLFleetActionCmdlet.Action"> <summary> <para> <para>List of actions to restart on the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLFleetActionCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to restart actions on. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLFleetActionCmdlet.Location"> <summary> <para> <para>The fleet location to restart fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as <c>us-west-2</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLFleetActionCmdlet.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.StartFleetActionsResponse). Specifying the name of a property of type Amazon.GameLift.Model.StartFleetActionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLFleetActionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLFleetActionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.StartGMLGameSessionPlacementCmdlet"> <summary> Places a request for a new game session in a queue. When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out. <para> A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request. </para><para> When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order. </para><para> Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant Regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a Region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each Region's average lag for all players and reorders to get the best game play across all players. </para><para> To place a new game session request, specify the following: </para><ul><li><para> The queue name and a set of game session properties and settings </para></li><li><para> A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request </para></li><li><para> (Optional) A set of player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player) </para></li><li><para> Latency data for all players (if you want to optimize game play for the players) </para></li></ul><para> If successful, a new game session placement is created. </para><para> To track the status of a placement request, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html">DescribeGameSessionPlacement</a> and check the request's status. If the status is <c>FULFILLED</c>, a new game session has been created and a game session ARN and Region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLGameSessionPlacementCmdlet.DesiredPlayerSession"> <summary> <para> <para>Set of information on each player to create a player session for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLGameSessionPlacementCmdlet.GameProperty"> <summary> <para> <para>A set of key-value pairs that can store custom data in a game session. For example: <c>{"Key": "difficulty", "Value": "novice"}</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLGameSessionPlacementCmdlet.GameSessionData"> <summary> <para> <para>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the <c>GameSession</c> object with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLGameSessionPlacementCmdlet.GameSessionName"> <summary> <para> <para>A descriptive label that is associated with a game session. Session names do not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLGameSessionPlacementCmdlet.GameSessionQueueName"> <summary> <para> <para>Name of the queue to use to place the new game session. You can use either the queue name or ARN value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLGameSessionPlacementCmdlet.MaximumPlayerSessionCount"> <summary> <para> <para>The maximum number of players that can be connected simultaneously to the game session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLGameSessionPlacementCmdlet.PlacementId"> <summary> <para> <para>A unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all Regions and cannot be reused.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLGameSessionPlacementCmdlet.PlayerLatency"> <summary> <para> <para>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLGameSessionPlacementCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameSessionPlacement'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.StartGameSessionPlacementResponse). Specifying the name of a property of type Amazon.GameLift.Model.StartGameSessionPlacementResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLGameSessionPlacementCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GameSessionName parameter. The -PassThru parameter is deprecated, use -Select '^GameSessionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLGameSessionPlacementCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.StartGMLMatchBackfillCmdlet"> <summary> Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements. <para> When using FlexMatch with Amazon GameLift managed hosting, you can request a backfill match from a client service by calling this operation with a <c>GameSessions</c> ID. You also have the option of making backfill requests directly from your game server. In response to a request, FlexMatch creates player sessions for the new players, updates the <c>GameSession</c> resource, and sends updated matchmaking data to the game server. You can request a backfill match at any point after a game session is started. Each game session can have only one active backfill request at a time; a subsequent request automatically replaces the earlier request. </para><para> When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled. </para><para> To request a backfill match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking data for all current players in the game session being backfilled. Optionally, specify the <c>GameSession</c> ARN. If successful, a match backfill ticket is created and returned with status set to QUEUED. Track the status of backfill tickets using the same method for tracking tickets for new matches. </para><para> Only game sessions created by FlexMatch are supported for match backfill. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html"> Backfill existing games with FlexMatch</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html"> Matchmaking events</a> (reference) </para><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html"> How Amazon GameLift FlexMatch works</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLMatchBackfillCmdlet.ConfigurationName"> <summary> <para> <para>Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the <c>GameSession</c> object, <c>MatchmakerData</c> property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLMatchBackfillCmdlet.GameSessionArn"> <summary> <para> <para>A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLMatchBackfillCmdlet.Player"> <summary> <para> <para>Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.</para><para>You can include up to 199 <c>Players</c> in a <c>StartMatchBackfill</c> request.</para><ul><li><para>PlayerID, PlayerAttributes, Team -- This information is maintained in the <c>GameSession</c> object, <c>MatchmakerData</c> property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data"> Match Data</a>. </para><para>The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.</para></li><li><para>LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLMatchBackfillCmdlet.TicketId"> <summary> <para> <para>A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLMatchBackfillCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MatchmakingTicket'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.StartMatchBackfillResponse). Specifying the name of a property of type Amazon.GameLift.Model.StartMatchBackfillResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLMatchBackfillCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GameSessionArn parameter. The -PassThru parameter is deprecated, use -Select '^GameSessionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLMatchBackfillCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.StartGMLMatchmakingCmdlet"> <summary> Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use Amazon GameLift managed hosting, this operation also triggers Amazon GameLift to find hosting resources and start a new game session for the new match. Each matchmaking request includes information on one or more players and specifies the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to build a match that includes all players in the request, placing them in the same team and finding additional players as needed to fill the match. <para> To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include any player attributes that are required by the matchmaking configuration's rule set. If successful, a matchmaking ticket is returned with status set to <c>QUEUED</c>. </para><para> Track matchmaking events to respond as needed and acquire game session connection information for successfully completed matches. Ticket status updates are tracked using event notification through Amazon Simple Notification Service, which is defined in the matchmaking configuration. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html"> Add FlexMatch to a game client</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Set Up FlexMatch event notification</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html"> How Amazon GameLift FlexMatch works</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLMatchmakingCmdlet.ConfigurationName"> <summary> <para> <para>Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same Region as this request. You can use either the configuration name or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLMatchmakingCmdlet.Player"> <summary> <para> <para>Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, <c>Player</c> objects contain the name of the team the player is assigned to.</para><para>You can include up to 10 <c>Players</c> in a <c>StartMatchmaking</c> request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLMatchmakingCmdlet.TicketId"> <summary> <para> <para>A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLMatchmakingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MatchmakingTicket'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.StartMatchmakingResponse). Specifying the name of a property of type Amazon.GameLift.Model.StartMatchmakingResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLMatchmakingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConfigurationName parameter. The -PassThru parameter is deprecated, use -Select '^ConfigurationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StartGMLMatchmakingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.StopGMLFleetActionCmdlet"> <summary> Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location. <para> Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations. </para><para> This operation can be used in the following ways: </para><ul><li><para> To stop actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to suspend. </para></li><li><para> To stop actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to suspend. </para></li></ul><para> If successful, Amazon GameLift no longer initiates scaling events except in response to manual changes using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html">UpdateFleetCapacity</a>. To restart fleet actions again, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartFleetActions.html">StartFleetActions</a>. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift Fleets</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StopGMLFleetActionCmdlet.Action"> <summary> <para> <para>List of actions to suspend on the fleet. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StopGMLFleetActionCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StopGMLFleetActionCmdlet.Location"> <summary> <para> <para>The fleet location to stop fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as <c>us-west-2</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StopGMLFleetActionCmdlet.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.StopFleetActionsResponse). Specifying the name of a property of type Amazon.GameLift.Model.StopFleetActionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StopGMLFleetActionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StopGMLFleetActionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.StopGMLGameSessionPlacementCmdlet"> <summary> Cancels a game session placement that is in <c>PENDING</c> status. To stop a placement, provide the placement ID values. If successful, the placement is moved to <c>CANCELLED</c> status. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StopGMLGameSessionPlacementCmdlet.PlacementId"> <summary> <para> <para>A unique identifier for a game session placement to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StopGMLGameSessionPlacementCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameSessionPlacement'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.StopGameSessionPlacementResponse). Specifying the name of a property of type Amazon.GameLift.Model.StopGameSessionPlacementResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StopGMLGameSessionPlacementCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PlacementId parameter. The -PassThru parameter is deprecated, use -Select '^PlacementId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StopGMLGameSessionPlacementCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.StopGMLMatchmakingCmdlet"> <summary> Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to <c>CANCELLED</c>. <para> This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the <c>MatchmakerData</c> of an updated game session object, which is provided to the game server. </para><note><para> If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body). </para></note><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html"> Add FlexMatch to a game client</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StopGMLMatchmakingCmdlet.TicketId"> <summary> <para> <para>A unique identifier for a matchmaking ticket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StopGMLMatchmakingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.StopMatchmakingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StopGMLMatchmakingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TicketId parameter. The -PassThru parameter is deprecated, use -Select '^TicketId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.StopGMLMatchmakingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.SuspendGMLGameServerGroupCmdlet"> <summary> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b><para> Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling <a href="gamelift/latest/apireference/API_ResumeGameServerGroup.html">ResumeGameServerGroup</a>. You can suspend the following activity: </para><ul><li><para><b>Instance type replacement</b> - This activity evaluates the current game hosting viability of all Spot instance types that are defined for the game server group. It updates the Auto Scaling group to remove nonviable Spot Instance types, which have a higher chance of game server interruptions. It then balances capacity across the remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling group continues with its current balance, regardless of viability. Instance protection, utilization metrics, and capacity scaling activities continue to be active. </para></li></ul><para> To suspend activity, specify a game server group ARN and the type of activity to be suspended. If successful, a <c>GameServerGroup</c> object is returned showing that the activity is listed in <c>SuspendedActions</c>. </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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.SuspendGMLGameServerGroupCmdlet.GameServerGroupName"> <summary> <para> <para>A unique identifier for the game server group. Use either the name or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.SuspendGMLGameServerGroupCmdlet.SuspendAction"> <summary> <para> <para>The activity to suspend for this game server group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.SuspendGMLGameServerGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameServerGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.SuspendGameServerGroupResponse). Specifying the name of a property of type Amazon.GameLift.Model.SuspendGameServerGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.SuspendGMLGameServerGroupCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.SuspendGMLGameServerGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.TestGMLMatchmakingRuleSetValidityCmdlet"> <summary> Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string. <para><b>Learn more</b></para><ul><li><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html">Build a rule set</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.TestGMLMatchmakingRuleSetValidityCmdlet.RuleSetBody"> <summary> <para> <para>A collection of matchmaking rules to validate, formatted as a JSON string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.TestGMLMatchmakingRuleSetValidityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Valid'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.ValidateMatchmakingRuleSetResponse). Specifying the name of a property of type Amazon.GameLift.Model.ValidateMatchmakingRuleSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.TestGMLMatchmakingRuleSetValidityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleSetBody parameter. The -PassThru parameter is deprecated, use -Select '^RuleSetBody' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.UnregisterGMLComputeCmdlet"> <summary> <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b><para> Removes a compute resource from an Amazon GameLift Anywhere fleet or container fleet. Deregistered computes can no longer host game sessions through Amazon GameLift. </para><para> For an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to deregister fleet computes. </para><para> To deregister a compute, call this operation from the compute that's being deregistered and specify the compute name and the fleet ID. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UnregisterGMLComputeCmdlet.ComputeName"> <summary> <para> <para>The unique identifier of the compute resource to deregister. For an Anywhere fleet compute, use the registered compute name. For a container fleet, use the compute name (for example, <c>a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9</c>) or the compute ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UnregisterGMLComputeCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet the compute resource is currently registered to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UnregisterGMLComputeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DeregisterComputeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UnregisterGMLComputeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ComputeName parameter. The -PassThru parameter is deprecated, use -Select '^ComputeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UnregisterGMLComputeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.UnregisterGMLGameServerCmdlet"> <summary> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b><para> Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers. </para><para> To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason. </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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UnregisterGMLGameServerCmdlet.GameServerGroupName"> <summary> <para> <para>A unique identifier for the game server group where the game server is running.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UnregisterGMLGameServerCmdlet.GameServerId"> <summary> <para> <para>A custom string that uniquely identifies the game server to deregister.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UnregisterGMLGameServerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DeregisterGameServerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UnregisterGMLGameServerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GameServerId parameter. The -PassThru parameter is deprecated, use -Select '^GameServerId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UnregisterGMLGameServerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.UpdateGMLAliasCmdlet"> <summary> Updates properties for an alias. Specify the unique identifier of the alias to be updated and the new property values. When reassigning an alias to a new fleet, provide an updated routing strategy. If successful, the updated alias record is returned. <para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLAliasCmdlet.AliasId"> <summary> <para> <para>A unique identifier for the alias that you want to update. You can use either the alias ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLAliasCmdlet.Description"> <summary> <para> <para>A human-readable description of the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLAliasCmdlet.RoutingStrategy_FleetId"> <summary> <para> <para>A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLAliasCmdlet.RoutingStrategy_Message"> <summary> <para> <para>The message text to be used with a terminal routing strategy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLAliasCmdlet.Name"> <summary> <para> <para>A descriptive label that is associated with an alias. Alias names do not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLAliasCmdlet.RoutingStrategy_Type"> <summary> <para> <para>The type of routing strategy for the alias.</para><para>Possible routing types include the following:</para><ul><li><para><b>SIMPLE</b> - The alias resolves to one specific fleet. Use this type when routing to active fleets.</para></li><li><para><b>TERMINAL</b> - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the message embedded.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Alias'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateAliasResponse). Specifying the name of a property of type Amazon.GameLift.Model.UpdateAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AliasId parameter. The -PassThru parameter is deprecated, use -Select '^AliasId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.UpdateGMLBuildCmdlet"> <summary> Updates metadata in a build resource, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned. <para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html"> Upload a Custom Server Build</a></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLBuildCmdlet.BuildId"> <summary> <para> <para>A unique identifier for the build to update. You can use either the build ID or ARN value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLBuildCmdlet.Name"> <summary> <para> <para>A descriptive label associated with a build. Build names don't need to be unique. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLBuildCmdlet.Version"> <summary> <para> <para>Version information associated with a build or script. Version strings don't need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLBuildCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Build'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateBuildResponse). Specifying the name of a property of type Amazon.GameLift.Model.UpdateBuildResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLBuildCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BuildId parameter. The -PassThru parameter is deprecated, use -Select '^BuildId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLBuildCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetAttributeCmdlet"> <summary> Updates a fleet's mutable attributes, such as game session protection and resource creation limits. <para> To update fleet attributes, specify the fleet ID and the property values that you want to change. If successful, Amazon GameLift returns the identifiers for the updated fleet. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift fleets</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetAttributeCmdlet.AnywhereConfiguration_Cost"> <summary> <para> <para>The cost to run your fleet per hour. Amazon GameLift uses the provided cost of your fleet to balance usage in queues. For more information about queues, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html">Setting up queues</a> in the <i>Amazon GameLift Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetAttributeCmdlet.Description"> <summary> <para> <para>A human-readable description of a fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetAttributeCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetAttributeCmdlet.MetricGroup"> <summary> <para> <para>The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetAttributeCmdlet.Name"> <summary> <para> <para>A descriptive label that is associated with a fleet. Fleet names do not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetAttributeCmdlet.NewGameSessionProtectionPolicy"> <summary> <para> <para>The game session protection policy to apply to all new game sessions created in this fleet. Game sessions that already exist are not affected. You can set protection for individual game sessions using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a> .</para><ul><li><para><b>NoProtection</b> -- The game session can be terminated during a scale-down event.</para></li><li><para><b>FullProtection</b> -- If the game session is in an <c>ACTIVE</c> status, it cannot be terminated during a scale-down event.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetAttributeCmdlet.ResourceCreationLimitPolicy_NewGameSessionsPerCreator"> <summary> <para> <para>A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.</para><para>The policy is evaluated when a player tries to create a new game session. On receiving a <c>CreateGameSession</c> request, Amazon GameLift checks that the player (identified by <c>CreatorId</c>) has created fewer than game session limit in the specified time period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetAttributeCmdlet.ResourceCreationLimitPolicy_PolicyPeriodInMinute"> <summary> <para> <para>The time span used in evaluating the resource creation limit policy. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FleetId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateFleetAttributesResponse). Specifying the name of a property of type Amazon.GameLift.Model.UpdateFleetAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetAttributeCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetCapacityCmdlet"> <summary> <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b><para> Updates capacity settings for a managed EC2 fleet or container fleet. For these fleets, you adjust capacity by changing the number of instances in the fleet. Fleet capacity determines the number of game sessions and players that the fleet can host based on its configuration. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. </para><para> Use this operation to set these fleet capacity properties: </para><ul><li><para> Minimum/maximum size: Set hard limits on the number of Amazon EC2 instances allowed. If Amazon GameLift receives a request--either through manual update or automatic scaling--it won't change the capacity to a value outside of this range. </para></li><li><para> Desired capacity: As an alternative to automatic scaling, manually set the number of Amazon EC2 instances to be maintained. Before changing a fleet's desired capacity, check the maximum capacity of the fleet's Amazon EC2 instance type by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeEC2InstanceLimits.html">DescribeEC2InstanceLimits</a>. </para></li></ul><para> To update capacity for a fleet's home Region, or if the fleet has no remote locations, omit the <c>Location</c> parameter. The fleet must be in <c>ACTIVE</c> status. </para><para> To update capacity for a fleet's remote location, set the <c>Location</c> parameter to the location to update. The location must be in <c>ACTIVE</c> status. </para><para> If successful, Amazon GameLift updates the capacity settings and returns the identifiers for the updated fleet and/or location. If a requested change to desired capacity exceeds the instance type's limit, the <c>LimitExceeded</c> exception occurs. </para><para> Updates often prompt an immediate change in fleet capacity, such as when current capacity is different than the new desired capacity or outside the new limits. In this scenario, Amazon GameLift automatically initiates steps to add or remove instances in the fleet location. You can track a fleet's current capacity by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html">DescribeFleetCapacity</a> or <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html">DescribeFleetLocationCapacity</a>. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-manage-capacity.html">Scaling fleet capacity</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetCapacityCmdlet.DesiredInstance"> <summary> <para> <para>The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits. Changes in desired instance value can take up to 1 minute to be reflected when viewing the fleet's capacity settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetCapacityCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetCapacityCmdlet.Location"> <summary> <para> <para>The name of a remote location to update fleet capacity settings for, in the form of an Amazon Web Services Region code such as <c>us-west-2</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetCapacityCmdlet.MaxSize"> <summary> <para> <para>The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetCapacityCmdlet.MinSize"> <summary> <para> <para>The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetCapacityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FleetId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateFleetCapacityResponse). Specifying the name of a property of type Amazon.GameLift.Model.UpdateFleetCapacityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetCapacityCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetCapacityCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetPortSettingCmdlet"> <summary> Updates permissions that allow inbound traffic to connect to game sessions in the fleet. <para> To update settings, specify the fleet ID to be updated and specify the changes to be made. List the permissions you want to add in <c>InboundPermissionAuthorizations</c>, and permissions you want to remove in <c>InboundPermissionRevocations</c>. Permissions to be removed must match existing fleet permissions. </para><para> For a container fleet, inbound permissions must specify port numbers that are defined in the fleet's connection port settings. </para><para> If successful, the fleet ID for the updated fleet is returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling <c>DescribeFleetPortSettings</c> with a location name. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift fleets</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetPortSettingCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to update port settings for. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetPortSettingCmdlet.InboundPermissionAuthorization"> <summary> <para> <para>A collection of port settings to be added to the fleet resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetPortSettingCmdlet.InboundPermissionRevocation"> <summary> <para> <para>A collection of port settings to be removed from the fleet resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetPortSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FleetId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateFleetPortSettingsResponse). Specifying the name of a property of type Amazon.GameLift.Model.UpdateFleetPortSettingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetPortSettingCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLFleetPortSettingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerCmdlet"> <summary> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b><para> Updates information about a registered game server to help Amazon GameLift FleetIQ track game server availability. This operation is called by a game server process that is running on an instance in a game server group. </para><para> Use this operation to update the following types of game server information. You can make all three types of updates in the same request: </para><ul><li><para> To update the game server's utilization status from <c>AVAILABLE</c> (when the game server is available to be claimed) to <c>UTILIZED</c> (when the game server is currently hosting games). Identify the game server and game server group and specify the new utilization status. You can't change the status from to <c>UTILIZED</c> to <c>AVAILABLE</c> . </para></li><li><para> To report health status, identify the game server and game server group and set health check to <c>HEALTHY</c>. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy. As a result, it will be eventually deregistered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds. </para></li><li><para> To change game server metadata, provide updated game server data. </para></li></ul><para> Once a game server is successfully updated, the relevant statuses and timestamps are updated. </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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerCmdlet.GameServerData"> <summary> <para> <para>A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerCmdlet.GameServerGroupName"> <summary> <para> <para>A unique identifier for the game server group where the game server is running.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerCmdlet.GameServerId"> <summary> <para> <para>A custom string that uniquely identifies the game server to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerCmdlet.HealthCheck"> <summary> <para> <para>Indicates health status of the game server. A request that includes this parameter updates the game server's <i>LastHealthCheckTime</i> timestamp. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerCmdlet.UtilizationStatus"> <summary> <para> <para>Indicates if the game server is available or is currently hosting gameplay. You can update a game server status from <c>AVAILABLE</c> to <c>UTILIZED</c>, but you can't change a the status from <c>UTILIZED</c> to <c>AVAILABLE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameServer'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateGameServerResponse). Specifying the name of a property of type Amazon.GameLift.Model.UpdateGameServerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GameServerId parameter. The -PassThru parameter is deprecated, use -Select '^GameServerId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerGroupCmdlet"> <summary> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b><para> Updates Amazon GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts. </para><para> To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that Amazon GameLift FleetIQ can continue to perform instance balancing activity. If successful, a <c>GameServerGroup</c> object is returned. </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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerGroupCmdlet.BalancingStrategy"> <summary> <para> <para>Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:</para><ul><li><para><c>SPOT_ONLY</c> - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.</para></li><li><para><c>SPOT_PREFERRED</c> - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.</para></li><li><para><c>ON_DEMAND_ONLY</c> - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerGroupCmdlet.GameServerGroupName"> <summary> <para> <para>A unique identifier for the game server group. Use either the name or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerGroupCmdlet.GameServerProtectionPolicy"> <summary> <para> <para>A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to <c>NO_PROTECTION</c> by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerGroupCmdlet.InstanceDefinition"> <summary> <para> <para>An updated list of Amazon EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by Amazon GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">EC2 Instance Types</a> in the <i>Amazon EC2 User Guide</i>. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html"> Instance Weighting for Amazon EC2 Auto Scaling</a> in the Amazon EC2 Auto Scaling User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerGroupCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameServerGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateGameServerGroupResponse). Specifying the name of a property of type Amazon.GameLift.Model.UpdateGameServerGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerGroupCmdlet.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> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameServerGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionCmdlet"> <summary> Updates the mutable properties of a game session. <para> To update a game session, specify the game session ID and the values you want to change. </para><para> If successful, the updated <c>GameSession</c> object is returned. </para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionCmdlet.GameProperty"> <summary> <para> <para>A set of key-value pairs that can store custom data in a game session. For example: <c>{"Key": "difficulty", "Value": "novice"}</c>. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-update">Update the value of a game property</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionCmdlet.GameSessionId"> <summary> <para> <para>A unique identifier for the game session to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionCmdlet.MaximumPlayerSessionCount"> <summary> <para> <para>The maximum number of players that can be connected simultaneously to the game session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionCmdlet.Name"> <summary> <para> <para>A descriptive label that is associated with a game session. Session names do not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionCmdlet.PlayerSessionCreationPolicy"> <summary> <para> <para>A policy that determines whether the game session is accepting new players.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionCmdlet.ProtectionPolicy"> <summary> <para> <para>Game session protection policy to apply to this game session only.</para><ul><li><para><b>NoProtection</b> -- The game session can be terminated during a scale-down event.</para></li><li><para><b>FullProtection</b> -- If the game session is in an <c>ACTIVE</c> status, it cannot be terminated during a scale-down event.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameSession'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateGameSessionResponse). Specifying the name of a property of type Amazon.GameLift.Model.UpdateGameSessionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GameSessionId parameter. The -PassThru parameter is deprecated, use -Select '^GameSessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionQueueCmdlet"> <summary> Updates the configuration of a game session queue, which determines how the queue processes new game session requests. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations. <para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html"> Using Multi-Region Queues</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionQueueCmdlet.FilterConfiguration_AllowedLocation"> <summary> <para> <para> A list of locations to allow game session placement in, in the form of Amazon Web Services Region codes such as <c>us-west-2</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionQueueCmdlet.CustomEventData"> <summary> <para> <para>Information to be added to all events that are related to this game session queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionQueueCmdlet.Destination"> <summary> <para> <para>A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionQueueCmdlet.IsDestinationsSet"> <summary> <para> This property is set to true if the property <seealso cref="P:Amazon.GameLift.Model.UpdateGameSessionQueueRequest.Destinations" /> is set; false otherwise. This property can be used to determine if the related property was returned by a service response or if the related property should be sent to the service during a service call. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionQueueCmdlet.IsPlayerLatencyPoliciesSet"> <summary> <para> This property is set to true if the property <seealso cref="P:Amazon.GameLift.Model.UpdateGameSessionQueueRequest.PlayerLatencyPolicies" /> is set; false otherwise. This property can be used to determine if the related property was returned by a service response or if the related property should be sent to the service during a service call. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionQueueCmdlet.PriorityConfiguration_LocationOrder"> <summary> <para> <para>The prioritization order to use for fleet locations, when the <c>PriorityOrder</c> property includes <c>LOCATION</c>. Locations are identified by Amazon Web Services Region codes such as <c>us-west-2</c>. Each location can only be listed once. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionQueueCmdlet.Name"> <summary> <para> <para>A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionQueueCmdlet.NotificationTarget"> <summary> <para> <para>An SNS topic ARN that is set up to receive game session placement notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html"> Setting up notifications for game session placement</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionQueueCmdlet.PlayerLatencyPolicy"> <summary> <para> <para>A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionQueueCmdlet.PriorityConfiguration_PriorityOrder"> <summary> <para> <para>The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.</para><ul><li><para><c>LATENCY</c> -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest. </para></li><li><para><c>COST</c> -- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.</para></li><li><para><c>DESTINATION</c> -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.</para></li><li><para><c>LOCATION</c> -- FleetIQ prioritizes based on the provided order of locations, as defined in <c>LocationOrder</c>. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionQueueCmdlet.TimeoutInSecond"> <summary> <para> <para>The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a <c>TIMED_OUT</c> status. By default, this property is set to <c>600</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionQueueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GameSessionQueue'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateGameSessionQueueResponse). Specifying the name of a property of type Amazon.GameLift.Model.UpdateGameSessionQueueResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionQueueCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLGameSessionQueueCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet"> <summary> Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions that are created after the update. To update settings, specify the configuration name to be updated and provide the new settings. <para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html"> Design a FlexMatch matchmaker</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.AcceptanceRequired"> <summary> <para> <para>A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status <c>REQUIRES_ACCEPTANCE</c> to indicate when a completed potential match is waiting for player acceptance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.AcceptanceTimeoutSecond"> <summary> <para> <para>The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.AdditionalPlayerCount"> <summary> <para> <para>The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. This parameter is not used if <c>FlexMatchMode</c> is set to <c>STANDALONE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.BackfillMode"> <summary> <para> <para>The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html">Backfill Existing Games with FlexMatch</a>. Automatic backfill is not available when <c>FlexMatchMode</c> is set to <c>STANDALONE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.CustomEventData"> <summary> <para> <para>Information to add to all events related to the matchmaking configuration. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.Description"> <summary> <para> <para>A description for the matchmaking configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.FlexMatchMode"> <summary> <para> <para>Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution. </para><ul><li><para><b>STANDALONE</b> - FlexMatch forms matches and returns match information, including players and team assignments, in a <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded"> MatchmakingSucceeded</a> event.</para></li><li><para><b>WITH_QUEUE</b> - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.GameProperty"> <summary> <para> <para>A set of key-value pairs that can store custom data in a game session. For example: <c>{"Key": "difficulty", "Value": "novice"}</c>. This information is added to the new <c>GameSession</c> object that is created for a successful match. This parameter is not used if <c>FlexMatchMode</c> is set to <c>STANDALONE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.GameSessionData"> <summary> <para> <para>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the game session that is created for a successful match. This parameter is not used if <c>FlexMatchMode</c> is set to <c>STANDALONE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.GameSessionQueueArn"> <summary> <para> <para>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <c>arn:aws:gamelift:<region>::gamesessionqueue/<queue name></c>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If <c>FlexMatchMode</c> is set to <c>STANDALONE</c>, do not set this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.Name"> <summary> <para> <para>A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.NotificationTarget"> <summary> <para> <para>An SNS topic ARN that is set up to receive matchmaking notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Setting up notifications for matchmaking</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.RequestTimeoutSecond"> <summary> <para> <para>The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.RuleSetName"> <summary> <para> <para>A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Configuration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateMatchmakingConfigurationResponse). Specifying the name of a property of type Amazon.GameLift.Model.UpdateMatchmakingConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLMatchmakingConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.UpdateGMLRuntimeConfigurationCmdlet"> <summary> Updates the runtime configuration for the specified fleet. The runtime configuration tells Amazon GameLift how to launch server processes on computes in the fleet. For managed EC2 fleets, it determines what server processes to run on each fleet instance. For container fleets, it describes what server processes to run in each replica container group. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in <c>ACTIVE</c> status. <para> To update runtime configuration, specify the fleet ID and provide a <c>RuntimeConfiguration</c> with an updated set of server process configurations. </para><para> If successful, the fleet's runtime configuration settings are updated. Fleet computes that run game server processes regularly check for and receive updated runtime configurations. The computes immediately take action to comply with the new configuration by launching new server processes or by not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift fleets</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLRuntimeConfigurationCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to update runtime configuration for. You can use either the fleet ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLRuntimeConfigurationCmdlet.RuntimeConfiguration_GameSessionActivationTimeoutSecond"> <summary> <para> <para>The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status <c>ACTIVATING</c>. If the game session does not become active before the timeout, it is ended and the game session status is changed to <c>TERMINATED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLRuntimeConfigurationCmdlet.RuntimeConfiguration_MaxConcurrentGameSessionActivation"> <summary> <para> <para>The number of game sessions in status <c>ACTIVATING</c> to allow on an instance or container. This setting limits the instance resources that can be used for new game activations at any one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLRuntimeConfigurationCmdlet.RuntimeConfiguration_ServerProcess"> <summary> <para> <para>A collection of server process configurations that identify what server processes to run on fleet computes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLRuntimeConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RuntimeConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateRuntimeConfigurationResponse). Specifying the name of a property of type Amazon.GameLift.Model.UpdateRuntimeConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLRuntimeConfigurationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLRuntimeConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.UpdateGMLScriptCmdlet"> <summary> Updates Realtime script metadata and content. <para> To update script metadata, specify the script ID and provide updated name and/or version values. </para><para> To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the <i>Version</i> parameter to track updates to the script. </para><para> If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions. </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a></para><para><b>Related actions</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLScriptCmdlet.StorageLocation_Bucket"> <summary> <para> <para>An Amazon S3 bucket identifier. Thename of the S3 bucket.</para><note><para>Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLScriptCmdlet.StorageLocation_Key"> <summary> <para> <para>The name of the zip file that contains the build files or script files. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLScriptCmdlet.Name"> <summary> <para> <para>A descriptive label that is associated with a script. Script names don't need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLScriptCmdlet.StorageLocation_ObjectVersion"> <summary> <para> <para>The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLScriptCmdlet.StorageLocation_RoleArn"> <summary> <para> <para>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) for an IAM role that allows Amazon GameLift to access the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLScriptCmdlet.ScriptId"> <summary> <para> <para>A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLScriptCmdlet.Version"> <summary> <para> <para>Version information associated with a build or script. Version strings don't need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLScriptCmdlet.ZipFile"> <summary> <para> <para>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</para><para>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: <c>--zip-file fileb://myRealtimeScript.zip</c>.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLScriptCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Script'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateScriptResponse). Specifying the name of a property of type Amazon.GameLift.Model.UpdateScriptResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLScriptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ScriptId parameter. The -PassThru parameter is deprecated, use -Select '^ScriptId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.UpdateGMLScriptCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GML.WriteGMLScalingPolicyCmdlet"> <summary> Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling. <para> Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences. </para><para> Learn more about how to work with auto-scaling in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-autoscaling.html">Set Up Fleet Automatic Scaling</a>. </para><para><b>Target-based policy</b></para><para> A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target. </para><para> For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer. </para><para> To create or update a target-based policy, specify a fleet ID and name, and set the policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) and reference a <c>TargetConfiguration</c> object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted. </para><para><b>Rule-based policy</b></para><para> A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action. </para><para> For example, a policy may make the following statement: "If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%." </para><para> A policy's rule statement has the following structure: </para><para> If <c>[MetricName]</c> is <c>[ComparisonOperator]</c><c>[Threshold]</c> for <c>[EvaluationPeriods]</c> minutes, then <c>[ScalingAdjustmentType]</c> to/by <c>[ScalingAdjustment]</c>. </para><para> To implement the example, the rule statement would look like this: </para><para> If <c>[PercentIdleInstances]</c> is <c>[GreaterThanThreshold]</c><c>[20]</c> for <c>[15]</c> minutes, then <c>[PercentChangeInCapacity]</c> to/by <c>[10]</c>. </para><para> To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to "RuleBased". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.WriteGMLScalingPolicyCmdlet.ComparisonOperator"> <summary> <para> <para>Comparison operator to use when measuring the metric against the threshold value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.WriteGMLScalingPolicyCmdlet.EvaluationPeriod"> <summary> <para> <para>Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.WriteGMLScalingPolicyCmdlet.FleetId"> <summary> <para> <para>A unique identifier for the fleet to apply this policy to. You can use either the fleet ID or ARN value. The fleet cannot be in any of the following statuses: ERROR or DELETING.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.WriteGMLScalingPolicyCmdlet.MetricName"> <summary> <para> <para>Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html">Monitor Amazon GameLift with Amazon CloudWatch</a>. </para><ul><li><para><b>ActivatingGameSessions</b> -- Game sessions in the process of being created.</para></li><li><para><b>ActiveGameSessions</b> -- Game sessions that are currently running.</para></li><li><para><b>ActiveInstances</b> -- Fleet instances that are currently running at least one game session.</para></li><li><para><b>AvailableGameSessions</b> -- Additional game sessions that fleet could host simultaneously, given current capacity.</para></li><li><para><b>AvailablePlayerSessions</b> -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.</para></li><li><para><b>CurrentPlayerSessions</b> -- Player slots in active game sessions that are being used by a player or are reserved for a player. </para></li><li><para><b>IdleInstances</b> -- Active instances that are currently hosting zero game sessions. </para></li><li><para><b>PercentAvailableGameSessions</b> -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.</para></li><li><para><b>PercentIdleInstances</b> -- Percentage of the total number of active instances that are hosting zero game sessions.</para></li><li><para><b>QueueDepth</b> -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.</para></li><li><para><b>WaitTime</b> -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.WriteGMLScalingPolicyCmdlet.Name"> <summary> <para> <para>A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.WriteGMLScalingPolicyCmdlet.PolicyType"> <summary> <para> <para>The type of scaling policy to create. For a target-based policy, set the parameter <i>MetricName</i> to 'PercentAvailableGameSessions' and specify a <i>TargetConfiguration</i>. For a rule-based policy set the following parameters: <i>MetricName</i>, <i>ComparisonOperator</i>, <i>Threshold</i>, <i>EvaluationPeriods</i>, <i>ScalingAdjustmentType</i>, and <i>ScalingAdjustment</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.WriteGMLScalingPolicyCmdlet.ScalingAdjustment"> <summary> <para> <para>Amount of adjustment to make, based on the scaling adjustment type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.WriteGMLScalingPolicyCmdlet.ScalingAdjustmentType"> <summary> <para> <para>The type of adjustment to make to a fleet's instance count:</para><ul><li><para><b>ChangeInCapacity</b> -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.</para></li><li><para><b>ExactCapacity</b> -- set the instance count to the scaling adjustment value.</para></li><li><para><b>PercentChangeInCapacity</b> -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down; for example, a value of "-10" scales the fleet down by 10%.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.WriteGMLScalingPolicyCmdlet.TargetConfiguration_TargetValue"> <summary> <para> <para>Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.WriteGMLScalingPolicyCmdlet.Threshold"> <summary> <para> <para>Metric value used to trigger a scaling event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.WriteGMLScalingPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Name'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.PutScalingPolicyResponse). Specifying the name of a property of type Amazon.GameLift.Model.PutScalingPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.WriteGMLScalingPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GML.WriteGMLScalingPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |